OpenLayers 3

ol.source. ol.source.WMTS

new WMTS

Stability: experimental
Parameters:
Name Type Description
options olx.source.WMTSOptions

WMTS options.

Properties
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.
Source:
  • wmtssource.js, line 34

Extends

Methods

<static> optionsFromCapabilities

Stability: experimental
Parameters:
Name Type Description
wmtsCap Object

An object representing the capabilities document.
layer string

The layer identifier.
Source:
  • wmtssource.js, line 244
Returns:

WMTS source options object.

Type
olx.source.WMTSOptions

dispatchChangeEvent

Stability: experimental

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

Inherited From:
Source:
  • observable.js, line 39
Fires:
  • event:change

getDimensions

Stability: experimental

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

Source:
  • wmtssource.js, line 200
Returns:

Dimensions.

Type
Object

getState

Stability: experimental
Inherited From:
Source:
  • source.js, line 134
Returns:

State.

Type
ol.source.State

getTileGrid

Stability: experimental
Inherited From:
Source:
  • tilesource.js, line 187
Returns:

Tile grid.

Type
ol.tilegrid.TileGrid

on

Stability: experimental

Listen for a certain type of event.

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

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 61
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

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

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 74
Returns:

Unique key for the listener.

Type
goog.events.Key

un

Stability: experimental

Unlisten for a certain type of event.

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

The event type or array of event types.
listener function

The listener function.
this Object <optional>

The object to use as this in listener.
Inherited From:
Source:
  • observable.js, line 86

unByKey

Stability: experimental

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

Parameters:
Name Type Description
key goog.events.Key

Key.
Inherited From:
Source:
  • observable.js, line 96

updateDimensions

Stability: experimental

Update the dimensions.

Parameters:
Name Type Description
dimensions Object

Dimensions.
Source:
  • wmtssource.js, line 231