new ol.source.WMTS(options)
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
WMTS options.
|
Fires:
-
change
- Triggered when the state of the source changes. -
propertychange
(ol.ObjectEvent) - Triggered when a property is changed. -
tileloadend
(ol.source.TileEvent) - Triggered when a tile finishes loading. -
tileloaderror
(ol.source.TileEvent) - Triggered if tile loading results in an error. -
tileloadstart
(ol.source.TileEvent) - Triggered when a tile starts loading.
Extends
Methods
-
ol.source.WMTS.optionsFromCapabilities(wmtsCap, config){olx.source.WMTSOptions} experimental
src/ol/source/wmtssource.js, line 341 -
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.
-
changed() inherited experimental
src/ol/observable.js, line 52 -
Increases the revision counter and dispatches a 'change' event.
Fires:
-
change
experimental
-
-
get(key){*} inherited
src/ol/object.js, line 150 -
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getAttributions(){Array.<ol.Attribution>} inherited
src/ol/source/source.js, line 104 -
Get the attributions of the source.
Returns:
Attributions.
-
getDimensions(){Object} experimental
src/ol/source/wmtssource.js, line 211 -
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 221 -
Return the image format of the WMTS source.
Returns:
Format.
-
getKeys(){Array.<string>} inherited
src/ol/object.js, line 164 -
Get a list of object property names.
Returns:
List of property names.
-
getLayer(){string} experimental
src/ol/source/wmtssource.js, line 239 -
Return the layer of the WMTS source.
Returns:
Layer.
-
getLogo(){string|olx.LogoOptions|undefined} inherited
src/ol/source/source.js, line 114 -
Get the logo of the source.
Returns:
Logo.
-
getMatrixSet(){string} experimental
src/ol/source/wmtssource.js, line 249 -
Return the matrix set of the WMTS source.
Returns:
MatrixSet.
-
getProjection(){ol.proj.Projection} inherited experimental
src/ol/source/source.js, line 124 -
Get the projection of the source.
Returns:
Projection.
-
getProperties(){Object.<string, *>} inherited
src/ol/object.js, line 174 -
Get an object of all property names and values.
Returns:
Object.
-
getRequestEncoding(){ol.source.WMTSRequestEncoding} experimental
src/ol/source/wmtssource.js, line 259 -
Return the request encoding, either "KVP" or "REST".
Returns:
Request encoding.
-
getRevision(){number} inherited experimental
src/ol/observable.js, line 62 -
Returns:
Revision.
-
getState(){ol.source.State} inherited experimental
src/ol/source/source.js, line 140 -
Get the state of the source, see
ol.source.State
for possible states.Returns:
State.
-
getStyle(){string} experimental
src/ol/source/wmtssource.js, line 269 -
Return the style of the WMTS source.
Returns:
Style.
-
getTileGrid(){ol.tilegrid.TileGrid} inherited
src/ol/source/tilesource.js, line 187 -
Return the tile grid of the tile source.
Returns:
Tile grid.
-
getTileLoadFunction(){ol.TileLoadFunctionType} inherited experimental
src/ol/source/tileimagesource.js, line 120 -
Return the tile load function of the source.
Returns:
TileLoadFunction
-
getTileUrlFunction(){ol.TileUrlFunctionType} inherited experimental
src/ol/source/tileimagesource.js, line 130 -
Return the tile URL function of the source.
Returns:
TileUrlFunction
-
getUrls(){Array.<string>} experimental
src/ol/source/wmtssource.js, line 279 -
Return the URLs used for this WMTS source.
Returns:
URLs.
-
getVersion(){string} experimental
src/ol/source/wmtssource.js, line 289 -
Return the version of the WMTS source.
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
inlistener
.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
inlistener
.Returns:
Unique key for the listener.
-
set(key, value) inherited
src/ol/object.js, line 203 -
Sets a value.
Name Type Description key
string Key name.
value
* Value.
-
setProperties(values) inherited
src/ol/object.js, line 216 -
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Name Type Description values
Object.<string, *> Values.
-
setTileLoadFunction(tileLoadFunction) inherited experimental
src/ol/source/tileimagesource.js, line 164 -
Set the tile load function of the source.
Name Type Description tileLoadFunction
ol.TileLoadFunctionType Tile load function.
-
setTileUrlFunction(tileUrlFunction) inherited experimental
src/ol/source/tileimagesource.js, line 176 -
Set the tile URL function of the source.
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 thelistener
. -
unByKey(key) inherited
src/ol/observable.js, line 114 -
Removes an event listener using the key returned by
on()
oronce()
. Note that using theol.Observable.unByKey
static function is to be preferred.Name Type Description key
goog.events.Key The key returned by
on()
oronce()
. -
unset(key) inherited
src/ol/object.js, line 229 -
Unsets a property.
Name Type Description key
string Key name.
-
updateDimensions(dimensions) experimental
src/ol/source/wmtssource.js, line 312 -
Update the dimensions.
Name Type Description dimensions
Object Dimensions.