This documentation is for OpenLayers v
10.6.1. The
latestis v
.
ol/source/ImageMapGuide~ImageMapGuideimport ImageMapGuide from 'ol/source/ImageMapGuide.js';
Source for images from Mapguide servers
url
string | undefined
The mapagent url.
crossOrigin
null | string | undefined
The crossOrigin
attribute for loaded images. Note that you must provide a crossOrigin
value if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.
displayDpi
number (defaults to 96)
The display resolution.
metersPerUnit
number (defaults to 1)
The meters-per-unit value.
hidpi
boolean (defaults to true)
Use the ol/Map#pixelRatio
value when requesting the image from the remote server.
useOverlay
boolean | undefined
If true
, will use GETDYNAMICMAPOVERLAYIMAGE
.
projection
ProjectionLike | undefined
Projection. Default is the view projection.
ratio
number (defaults to 1)
Ratio. 1
means image requests are the size of the map viewport, 2
means twice the width and height of the map viewport, and so on. Must be 1
or higher.
resolutions
Array.<number> | undefined
Resolutions. If specified, requests will be made for these resolutions only.
imageLoadFunction
LoadFunction | undefined
Optional function to load an image given a URL.
interpolate
boolean (defaults to true)
Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
params
Object | undefined
Additional parameters.
change
(BaseEvent) - Generic change event. Triggered when the revision counter is increased.error
(BaseEvent) - Generic error event. Triggered when an error occurs.imageloadend
(ImageSourceEvent) - Triggered when an image finishes loading.imageloaderror
(ImageSourceEvent) - Triggered if image loading results in an error.imageloadstart
(ImageSourceEvent) - Triggered when an image starts loading.propertychange
(ObjectEvent) - Triggered when a property is changed.Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type
property.
event
BaseEvent | string
Event object.
false
if anyone called preventDefault on the event object or if any of the listeners returned false.
Gets a value.
Name Type Descriptionkey
string
Key name.
Get the attribution function for the source.
Return the image load function of the source.
Get a list of object property names.
Get the user-provided params, i.e. those passed to the constructor through the "params" option, and possibly updated using the updateParams method.
Get the projection of the source.
Get an object of all property names and values.
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Get the state of the source, see State
for possible states.
Listen for a certain type of event.
Name Type Descriptiontype
string | Array.<string>
The event type or array of event types.
listener
function
The listener function.
Listen once for a certain type of event.
Name Type Descriptiontype
string | Array.<string>
The event type or array of event types.
listener
function
The listener function.
Refreshes the source. The source will be cleared, and data from the server will be reloaded.
Sets a value.
Name Type Descriptionkey
string
Key name.
value
*
Value.
silent
boolean | undefined
Update without triggering an event.
Set the attributions of the source.
Name Type Descriptionattributions
AttributionLike | undefined
Attributions. Can be passed as string
, Array<string>
, Attribution
, or undefined
.
Set the image load function of the MapGuide source.
Name Type DescriptionimageLoadFunction
LoadFunction
Image load function.
Set the user-provided params.
Name Type Descriptionparams
Object
Params.
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Descriptionvalues
Object.<string, *>
Values.
silent
boolean | undefined
Update without triggering an event.
Unlisten for a certain type of event.
Name Type Descriptiontype
string | Array.<string>
The event type or array of event types.
listener
function
The listener function.
Unsets a property.
Name Type Descriptionkey
string
Key name.
silent
boolean | undefined
Unset without triggering an event.
Update the user-provided params.
Name Type Descriptionparams
Object
Params.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4