Class: ImageMapGuide

ol/source/ImageMapGuide~ImageMapGuide


import ImageMapGuide from 'ol/source/ImageMapGuide';

Source for images from Mapguide servers

new ImageMapGuide(options)

Name Type Description
options

ImageMapGuide options.

Name Type 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 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

If true, will use GETDYNAMICMAPOVERLAYIMAGE.

projection module:ol/proj~ProjectionLike

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>

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.

imageSmoothing boolean (defaults to true)

Enable image smoothing.

params Object

Additional parameters.

Fires:

Extends

Methods

Increases the revision counter and dispatches a 'change' event.

dispatchEvent(event){boolean|undefined} inherited

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.

Name Type Description
event module:ol/events/Event~BaseEvent | string

Event object.

Returns:
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Return the image load function of the source.

Returns:
The image load function.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

getParams(){Object}

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

Returns:
Params.

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

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

Returns:
State.

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, opt_silent) inherited

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

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~Attribution, or undefined.

setImageLoadFunction(imageLoadFunction)

Set the image load function of the MapGuide source.

Name Type Description
imageLoadFunction module:ol/Image~LoadFunction

Image load function.

setProperties(values, opt_silent) inherited

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 Description
values Object.<string, *>

Values.

silent boolean

Update without triggering an event.

un(type, listener) inherited

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

unset(key, opt_silent) inherited

Unsets a property.

Name Type Description
key string

Key name.

silent boolean

Unset without triggering an event.

updateParams(params)

Update the user-provided params.

Name Type Description
params Object

Params.