Mapspace API Reference

Class: WMTS

Mapspace.ortho.source. WMTS

Layer source for Mapspace Ortho WMTS services. This source do not inherits from ol.source.WMTS because this source adds important functionality to that. First it connects to GetCapabilities service during constructor to retrieve info from the server and store it for initializing options. Also, this allows to change layer and matrixSet on demand. This type of functionality is not possible inheriting from ol.source.WMTS.

new WMTS(options)

Parameters:
Name Type Description
options Mapspace.ortho.source.WMTSOptions
Source:
mapspace-ortho/source/wmts.js
Fires:

Extends

  • ol.source.TileImage

Methods

changeOptions(forceChange [, layerType], rotation, resolution, time)

Change internal options for the WMTS layer and matrixSet passed.

Parameters:
Name Type Argument Description
forceChange boolean

If force a change even if params will stay the same.
layerType Mapspace.MAPSPACEBaseLayerType <optional>

LayerType.
rotation number <nullable>

The rotation in decimal degrees.
resolution number <nullable>

The resolution in map units per pixel.
time string <nullable>

The time filter of the viewer.
Source:
mapspace-ortho/source/wmts.js

getAutoSwitchLayer()

Gets autoSwitchLayer value, that indicates if layer param is updated when map rotation changes or not.

Source:
mapspace-ortho/source/wmts.js
Returns:
Type
boolean

getBaseUrl()

Return the base URL used to request tiles.

Source:
mapspace-ortho/source/wmts.js
Returns:

Base URL.

Type
string

getCapabilities()

Source:
mapspace-ortho/source/wmts.js
Returns:

Return an object representing the WMTS capabilities.

Type
Object

getDimensions()

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

Source:
mapspace-ortho/source/wmts.js
Returns:

Dimensions.

Type
Object

getFormat()

Return the image format of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

Format.

Type
string

getLayer()

Return the layer of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

Layer.

Type
Mapspace.MAPSPACEBaseLayer

getLayerForRotation(rotation)

Gets the layer to request for a given rotation.

Parameters:
Name Type Description
rotation number

The rotation in decimal degrees.
Source:
mapspace-ortho/source/wmts.js
Returns:
Type
string

getMatrixSet()

Return the matrix set of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

MatrixSet.

Type
string

getOrthoZoom(resolution)

Returns zoom level in corresponding 'Mapspace:ORTHO' layer to given resolution. If GetCapabilities infomation is still not available undefined is returned.

Parameters:
Name Type Description
resolution number | undefined

Center currently visible in current source projection.
Source:
mapspace-ortho/source/wmts.js
Returns:

zoom Zoom level.

Type
number

getOverlay()

Return the overlay of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

Overlay.

Type
string

getRequestedLayer()

Return the real requested layer of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

Layer.

Type
Mapspace.MAPSPACEBaseLayer

getRequestEncoding()

Return the request encoding, either "KVP" or "REST".

Source:
mapspace-ortho/source/wmts.js
Returns:

Request encoding.

Type
ol.source.WMTSRequestEncoding

getServerExtent()

The server extent is a Polygon geometry in lonlat WGS84 that defines the limit of the server layer. Tiles should not be requested outside this extent. If not defined then all the tiles can be requested.

Source:
mapspace-ortho/source/wmts.js
Returns:

Return a polygon with the extent.

Type
ol.geom.Polygon | undefined

getServerLayer()

The server layer is each collection of related data that is stored in Mapspace servers. This attribute is parametrized in the URL requests as a BASELAYER param and can contain multiple values separated by commas for requesting to several server layers with priority to the first items in the list.

Source:
mapspace-ortho/source/wmts.js
Returns:

Return a string with the server layer.

Type
string

getServerTime()

The server time is a filter to merge with the time filter of the viewer.

Source:
mapspace-ortho/source/wmts.js
Returns:

Return a string with the time filter. Returns an empty string if it is not defined.

Type
string

getStyle()

Return the style of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

Style.

Type
string

getTime()

Return the time of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

Time.

Type
string

getUserLayerName()

Gets the name of the user layer currently loaded in this source.

Source:
mapspace-ortho/source/wmts.js
Returns:
Type
string

getVersion()

Return the version of the WMTS source.

Source:
mapspace-ortho/source/wmts.js
Returns:

Version.

Type
string

<protected> handleWMTSError()

Source:
mapspace-ortho/source/wmts.js

<protected> handleWMTSResponse(response)

Parameters:
Name Type Description
response Object

An object representing the WMTS capabilities.
Source:
mapspace-ortho/source/wmts.js

preCacheLevels()

Request all tiles to be pre-cached. We use a preCachedLevels property instead of preload property of the layer because preload tiles only last in cache until a refresh of the source and WMTS refreshes anytime an option changes.

Source:
mapspace-ortho/source/wmts.js

setServerLayer(serverLayer)

The server layer is each collection of related data that is stored in Mapspace servers. This attribute is parametrized in the URL requests as a BASELAYER param and can contain multiple values separated by commas for requesting to several server layers with priority to the first items in the list.

This function do not updates the source. Use refresh method after this.

Parameters:
Name Type Description
serverLayer string

A string with the server layer.
Source:
mapspace-ortho/source/wmts.js

setUserLayerName(name)

Sets the name of the user layer currently loaded in this source.

Parameters:
Name Type Description
name string

The user layer name.
Source:
mapspace-ortho/source/wmts.js

updateAttributions(center, resolution)

Updates attributions with the given parameters.

Parameters:
Name Type Description
center ol.Coordinate

Center currently visible in current source projection.
resolution number

Resolution of level currently visible.
Source:
mapspace-ortho/source/wmts.js

updateDimensions(dimensions)

Update the dimensions.

Parameters:
Name Type Description
dimensions Object

Dimensions.
Source:
mapspace-ortho/source/wmts.js