Class: WMTS

Extends

• ol.source.TileImage

Methods

ol.source.WMTS.optionsFromCapabilities(wmtsCap, config){olx.source.WMTSOptions} experimental

src/ol/source/wmtssource.js, line 337

Name	Type	Description
wmtsCap	Object	An object representing the capabilities document.
config	Object	Configuration properties for the layer. Defaults for the layer will apply if not provided. Required config properties: layer - {String} The layer identifier. Optional config properties: matrixSet - {String} The matrix set identifier, required if there is more than one matrix set in the layer capabilities. projection - {String} The desired CRS when no matrixSet is specified. eg: "EPSG:3857". If the desired projection is not available, an error is thrown. requestEncoding - {String} url encoding format for the layer. Default is the first tile url format found in the GetCapabilities response. style - {String} The name of the style format - {String} Image format for the layer. Default is the first format returned in the GetCapabilities response.

Returns:

WMTS source options object.

bindTo(key, target, opt_targetKey){ol.ObjectAccessor} inherited experimental

src/ol/object.js, line 326

The bindTo method allows you to set up a two-way binding between a source and target object. The method returns an object with a transform method that you can use to provide from and to functions to transform values on the way from the source to the target and on the way back.

For example, if you had two map views (sourceView and targetView) and you wanted the target view to have double the resolution of the source view, you could transform the resolution on the way to and from the target with the following:

sourceView.bindTo('resolution', targetView)
  .transform(
    function(sourceResolution) {
      // from sourceView.resolution to targetView.resolution
      return 2 * sourceResolution;
    },
    function(targetResolution) {
      // from targetView.resolution to sourceView.resolution
      return targetResolution / 2;
    }
  );

Name	Type	Description
key	string	Key name.
target	ol.Object	Target.
targetKey	string	Target key.

changed() inherited experimental

src/ol/observable.js, line 52

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

Fires:

• change experimental

get(key){*} inherited experimental

src/ol/object.js, line 354

Gets a value.

Name	Type	Description
key	string	Key name.

Returns:

Value.

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

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

Returns:

Attributions.

getDimensions(){Object} experimental

src/ol/source/wmtssource.js, line 232

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

Returns:

Dimensions.

getFormat(){string} experimental

src/ol/source/wmtssource.js, line 241

Returns:

Format.

getKeys(){Array.<string>} inherited experimental

src/ol/object.js, line 373

Get a list of object property names.

Returns:

List of property names.

getLayer(){string} experimental

src/ol/source/wmtssource.js, line 258

Returns:

Layer.

getLogo(){string|olx.LogoOptions|undefined} inherited

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

Returns:

Logo.

getMatrixSet(){string} experimental

src/ol/source/wmtssource.js, line 267

Returns:

MatrixSet.

getProjection(){ol.proj.Projection} inherited experimental

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

Returns:

Projection.

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

src/ol/object.js, line 405

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 129

Returns:

State.

getStyle(){string} experimental

src/ol/source/wmtssource.js, line 276

Returns:

Style.

getTileGrid(){ol.tilegrid.TileGrid} inherited

src/ol/source/tilesource.js, line 175

Returns:

Tile grid.

getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental

src/ol/source/tileimagesource.js, line 114

Returns:

TileLoadFunction

getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental

src/ol/source/tileimagesource.js, line 123

Returns:

TileUrlFunction

getVersion(){string} experimental

src/ol/source/wmtssource.js, line 285

Returns:

Version.

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 experimental

src/ol/object.js, line 437

Sets a value.

Name	Type	Description
key	string	Key name.
value	*	Value.

setProperties(values) inherited experimental

src/ol/object.js, line 456

Sets a collection of key-value pairs.

Name	Type	Description
values	Object.<string, *>	Values.

setTileLoadFunction(tileLoadFunction) inherited experimental

src/ol/source/tileimagesource.js, line 156

Name	Type	Description
tileLoadFunction	ol.TileLoadFunctionType	Tile load function.

setTileUrlFunction(tileUrlFunction) inherited experimental

src/ol/source/tileimagesource.js, line 167

Name	Type	Description
tileUrlFunction	ol.TileUrlFunctionType	Tile URL function.

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.

unbind(key) inherited experimental

src/ol/object.js, line 470

Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

Name	Type	Description
key	string	Key name.

unbindAll() inherited experimental

src/ol/object.js, line 487

Removes all bindings.

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

updateDimensions(dimensions) experimental

src/ol/source/wmtssource.js, line 308

Update the dimensions.

Name	Type	Description
dimensions	Object	Dimensions.