Class: ImageMapGuide

ol/source/ImageMapGuide~ImageMapGuide 


import ImageMapGuide from 'ol/source/ImageMapGuide';

Source for images from Mapguide servers

new ImageMapGuide(options)

source/ImageMapGuide.js, line 46
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

changed() inherited

Observable.js, line 70

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

dispatchEvent(event){boolean|undefined} inherited

events/Target.js, line 85

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.

get(key){*} inherited

Object.js, line 135

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getAttributions(){module:ol/source/Source~Attribution} inherited

source/Source.js, line 100

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

source/Source.js, line 108
Returns:
Attributions are collapsible.

getImageLoadFunction(){module:ol/Image~LoadFunction}

source/ImageMapGuide.js, line 205

Return the image load function of the source.

Returns:
The image load function.

getKeys(){Array.<string>} inherited

Object.js, line 148

Get a list of object property names.

Returns:
List of property names.

getParams(){Object}

source/ImageMapGuide.js, line 137

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.

getProjection(){module:ol/proj/Projection~Projection} inherited

source/Source.js, line 117

Get the projection of the source.

Returns:
Projection.

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

Object.js, line 157

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

Observable.js, line 81

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

Returns:
Revision.

getState(){module:ol/source/State} inherited

source/Source.js, line 134

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

Returns:
State.

on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 155

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.

once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited

Observable.js, line 167

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.

refresh() inherited

source/Source.js, line 156

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

set(key, value, opt_silent) inherited

Object.js, line 203

Sets a value.

Name Type Description
key string

Key name.
value *

Value.
silent boolean

Update without triggering an event.

setAttributions(attributions) inherited

source/Source.js, line 167

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)

source/ImageMapGuide.js, line 254

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

Object.js, line 223

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

Observable.js, line 176

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

Object.js, line 247

Unsets a property.

Name Type Description
key string

Key name.
silent boolean

Unset without triggering an event.

updateParams(params)

source/ImageMapGuide.js, line 214

Update the user-provided params.

Name Type Description
params Object

Params.