Class: WMTS

ol.source. WMTS

experimental new ol.source.WMTS(options)

Name Type Description
options

WMTS options.

Name Type Description
attributions Array.<ol.Attribution> | undefined

Attributions.

crossOrigin string | null | undefined

crossOrigin setting for image requests.

extent ol.Extent | undefined

Extent.

logo string | undefined

Logo.

tileGrid ol.tilegrid.WMTS

Tile grid.

projection ol.proj.ProjectionLike

Projection.

requestEncoding ol.source.WMTSRequestEncoding | undefined

Request encoding.

layer string

Layer.

style string

Style.

version string | undefined

WMTS version. Default to 1.0.0.

format string | undefined

Format.

matrixSet string

Matrix set.

dimensions Object | undefined

Dimensions.

url string | undefined

URL.

maxZoom number | undefined

Maximum zoom.

tileLoadFunction ol.TileLoadFunctionType | undefined

Optional function to load a tile given a URL.

urls Array.<string> | undefined

Urls.

Fires:
  • change

Extends

Methods

experimental staticol.source.WMTS.optionsFromCapabilities(wmtsCap, layer){olx.source.WMTSOptions}

Name Type Description
wmtsCap Object

An object representing the capabilities document.

layer string

The layer identifier.

Returns:
source options object.

experimental inherited dispatchChangeEvent()

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

Fires:
  • change

experimental getDimensions(){Object}

Get the dimensions, i.e. those passed to the constructor through the "dimensions" option, and possibly updated using the updateDimensions method.

Returns:
grid.

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

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}

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)

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)

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

Name Type Description
key goog.events.Key

Key.

experimental updateDimensions(dimensions)

Update the dimensions.

Name Type Description
dimensions Object

Dimensions.