Class: ImageMapGuide

ol.source.ImageMapGuide

Source for images from Mapguide servers

new ol.source.ImageMapGuide(options)

src/ol/source/imagemapguidesource.js, line 25
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:

Extends

Methods

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:
  • change experimental

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

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

src/ol/source/source.js, line 104

Get the attributions of the source.

Returns:
Attributions.

getImageLoadFunction(){ol.ImageLoadFunctionType} experimental

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

Return the image load function of the source.

Returns:
The image load function.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:
List of property names.
src/ol/source/source.js, line 114

Get the logo of the source.

Returns:
Logo.

getParams(){Object}

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

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 124

Get the projection of the source.

Returns:
Projection.

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

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

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

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

src/ol/source/source.js, line 140

Get the state of the source, see ol.source.State for possible states.

Returns:
State.

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

src/ol/observable.js, line 75

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 88

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.

set(key, value) inherited

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

setImageLoadFunction(imageLoadFunction) experimental

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

Set the image load function of the MapGuide source.

Name Type Description
imageLoadFunction ol.ImageLoadFunctionType

Image load function.

setProperties(values) inherited

src/ol/object.js, line 216

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.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

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 114

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().

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name Type Description
key string

Key name.

updateParams(params)

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

Update the user-provided params.

Name Type Description
params Object

Params.