OpenLayers 3 API Documentation

Class: ImageMapGuide

ol.source.ImageMapGuide

Source for images from Mapguide servers

new ol.source.ImageMapGuide(options)

src/ol/source/imagemapguidesource.js, line 21
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.
params Object | undefined

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

Extends

Methods

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

getAttributions(){Array.<ol.Attribution>} inherited

src/ol/source/source.js, line 96
Returns:
Attributions.
src/ol/source/source.js, line 105
Returns:
Logo.

getParams(){Object}

src/ol/source/imagemapguidesource.js, line 110

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(){ol.proj.Projection} inherited experimental

src/ol/source/source.js, line 114
Returns:
Projection.

getRevision(){number} inherited experimental

src/ol/observable.js, line 52
Returns:
Revision.

getState(){ol.source.State} inherited experimental

src/ol/source/source.js, line 129
Returns:
State.

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

src/ol/observable.js, line 65

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

src/ol/observable.js, line 78

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

src/ol/observable.js, line 91

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.

unByKey(key) inherited

src/ol/observable.js, line 101

Removes an event listener using the key returned by on() or once().

Name Type Description
key goog.events.Key

Key.

updateParams(params)

src/ol/source/imagemapguidesource.js, line 180

Update the user-provided params.

Name Type Description
params Object

Params.