Class: ImageMapGuide

ol.source.ImageMapGuide

Source for images from Mapguide servers

new ol.source.ImageMapGuide(options)

Name Type Description
options

Options.

Name Type Description
url string | undefined

The mapagent url.

displayDpi number | undefined

The display resolution. Default is 96.

metersPerUnit number | undefined

The meters-per-unit value. Default is 1.

hidpi boolean | undefined experimental

Use the ol.Map#pixelRatio value when requesting the image from the remote server. Default is true.

useOverlay boolean | undefined

If true, will use GETDYNAMICMAPOVERLAYIMAGE.

projection ol.proj.ProjectionLike experimental

Projection.

ratio number | undefined

Ratio. 1 means image requests are the size of the map viewport, 2 means twice the size of the map viewport, and so on. Default is 1.

resolutions Array.<number> | undefined

Resolutions. If specified, requests will be made for these resolutions only.

imageLoadFunction ol.TileLoadFunctionType | undefined experimental

Optional function to load an image given a URL.

params Object | undefined

Additional parameters.

Fires:
  • change - Triggered when the state of the source changes.

Extends

Methods

changed() inherited experimental

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

Fires:
  • change experimental
Returns:
Attributions.
Returns:
Logo.

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.
Returns:
Projection.

getRevision(){number} inherited experimental

Returns:
Revision.
Returns:
State.

on(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

un(type, listener, opt_this) 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.

this Object

The object which was used as this by the listener.

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

Update the user-provided params.

Name Type Description
params Object

Params.