OpenLayers v5.3.0 API - Class: ImageMapGuide

Class: ImageMapGuide

ol/source/ImageMapGuide~ImageMapGuide

import ImageMapGuide from 'ol/source/ImageMapGuide';

Source for images from Mapguide servers

source/ImageMapGuide.js, line 42

Name Type Description

options

ImageMapGuide options.

Name	Type	Default	Description
`url`	string		The mapagent url.
`crossOrigin`	null \| string		The `crossOrigin` attribute for loaded images. Note that you must provide a `crossOrigin` value if you are using the WebGL renderer or 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	96	The display resolution.
`metersPerUnit`	number	1	The meters-per-unit value.
`hidpi`	boolean	true	Use the `ol/Map#pixelRatio` value when requesting the image from the remote server.
`useOverlay`	boolean		If `true`, will use `GETDYNAMICMAPOVERLAYIMAGE`.
`projection`	module:ol/proj~ProjectionLike		Projection.
`ratio`	number	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>		Resolutions. If specified, requests will be made for these resolutions only.
`imageLoadFunction`	module:ol/Image~LoadFunction		Optional function to load an image given a URL.
`params`	Object		Additional parameters.

change (module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased.
imageloadend - Triggered when an image finishes loading.
imageloaderror - Triggered if image loading results in an error.
imageloadstart - Triggered when an image starts loading.
propertychange (module:ol/Object.ObjectEvent) - Triggered when a property is changed.

getImageLoadFunction(){module:ol/Image~LoadFunction} source/ImageMapGuide.js, line 182

Return the image load function of the source.

The image load function.

getParams(){Object} source/ImageMapGuide.js, line 132

Get the user-provided params, i.e. those passed to the constructor through the "params" option, and possibly updated using the updateParams method.

Params.

getProjection(){module:ol/proj/Projection~Projection} inherited source/Source.js, line 119

Get the projection of the source.

Projection.

getState(){module:ol/source/State} inherited source/Source.js, line 136

Get the state of the source, see module:ol/source/State~State for possible states.

State.

refresh() inherited source/Source.js, line 151

Refreshes the source and finally dispatches a 'change' event.

setAttributions(attributions) inherited source/Source.js, line 162

Set the attributions of the source.

Name	Type	Description
`attributions`	module:ol/source/Source~AttributionLike \| undefined	Attributions. Can be passed as `string`, `Array<string>`, `module:ol/source/Source&tilde;Attribution`, or `undefined`.

setImageLoadFunction(imageLoadFunction) source/ImageMapGuide.js, line 230

Set the image load function of the MapGuide source.

Name	Type	Description
`imageLoadFunction`	module:ol/Image~LoadFunction	Image load function.

updateParams(params) source/ImageMapGuide.js, line 191

Update the user-provided params.

Name	Type	Description
`params`	Object	Params.