OpenLayers 3 API Documentation

Class: MapGuide

ol.source. MapGuide

experimental new ol.source.MapGuide(options)

src/ol/source/mapguidesource.js, line 18
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.
extent ol.Extent | undefined

Extent.
hidpi boolean | undefined

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

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

Extends

Methods

experimental inherited dispatchChangeEvent()

src/ol/observable.js, line 39

Dispatches a change event. Register a listener for this event to get notified of changes.

Fires:
  • change

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

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

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

src/ol/observable.js, line 61

Listen for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.
Returns:
key for the listener.

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

src/ol/observable.js, line 74

Listen once for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.
Returns:
key for the listener.

experimental inherited un(type, listener, opt_this)

src/ol/observable.js, line 86

Unlisten for a certain type of event.

Name Type Argument Description
type string | Array.<string>

The event type or array of event types.
listener function

The listener function.
this Object <optional>
 optional

The object to use as this in listener.

experimental inherited unByKey(key)

src/ol/observable.js, line 96

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

Name Type Description
key goog.events.Key

Key.