Class: WMTS

ol.source.WMTS

Layer source for tile data from WMTS servers.

new ol.source.WMTS(options) experimental

Name Type Description
options

WMTS options.

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

Attributions.

crossOrigin string | null | undefined experimental

The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.

logo string | olx.LogoOptions | undefined experimental

Logo.

tileGrid ol.tilegrid.WMTS experimental

Tile grid.

projection ol.proj.ProjectionLike experimental

Projection.

requestEncoding ol.source.WMTSRequestEncoding | string | undefined experimental

Request encoding. Default is KVP.

layer string experimental

Layer.

style string experimental

Style.

tileClass function | undefined experimental

Class used to instantiate image tiles. Default is ol.ImageTile.

tilePixelRatio number | undefined experimental

The pixel ratio used by the tile service. For example, if the tile service advertizes 256px by 256px tiles but actually sends 512px by 512px images (for retina/hidpi devices) then tilePixelRatio should be set to 2. Default is 1.

version string | undefined experimental

WMTS version. Default is 1.0.0.

format string | undefined experimental

Image format. Default is image/jpeg.

matrixSet string experimental

Matrix set.

dimensions Object | undefined experimental

Dimensions.

url string | undefined experimental

URL.

maxZoom number | undefined experimental

Maximum zoom.

tileLoadFunction ol.TileLoadFunctionType | undefined experimental

Optional function to load a tile given a URL.

urls Array.<string> | undefined experimental

Urls.

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

Extends

Methods

changed() inherited experimental

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

Fires:
  • change experimental
Returns:
Attributions.

getDimensions(){Object} experimental

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

Returns:
Dimensions.
Returns:
Logo.
Returns:
Projection.

getRevision(){number} inherited experimental

Returns:
Revision.
Returns:
State.
Returns:
Tile grid.
Returns:
TileLoadFunction
Returns:
TileUrlFunction

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

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

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.

setTileLoadFunction(tileLoadFunction) inherited experimental

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) inherited experimental

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

un(type, listener, opt_this) inherited

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.

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

updateDimensions(dimensions) experimental

Update the dimensions.

Name Type Description
dimensions Object

Dimensions.