Constructor

# new WMTSLayer(opts)

Initialization object

Parameters:

Name	Type	Attributes	Default	Description
`opts`	`object`			WMS layer options
`url`	`string`			WMTS service url
`layer`	`string`			Layer to display on map
`matrixSet`	`string`			Matrix set.
`matrixIds`	`object`			Matrix IDs. The length of this array needs to match the length of the resolutions array
`name`	`string`	<optional>		Layer name
`order`	`number`	<optional>		The order for layer rendering. At rendering time, the layers will be ordered, first by order and then by position. When undefined, a order of 0 is assumed for layers that are added to the map's layers collection.
`visible`	`boolean`	<optional>	true	Visibility
`opacity`	`number`	<optional>	1	Opacity (0, 1).
`format`	`string`	<optional>	image/jpeg	Image format. Only used when requestEncoding is 'KVP'.
`requestEncoding`	`string`	<optional>	KVP	Possible values KVP or REST
`style`	`string`	<optional>	"default"	Style name as advertised in the WMTS capabilities.
`attributions`	`string`	<optional>		Attributions.

Tutorials:

WMTS Tile

Example

Create empty layer

const options = {
                 url :"https://www.sample-url.com/tiles/{x}/{y}/{z}",
                 layer :"test",
                 matrixSet :"test",
                 matrixIds :"test",
                 };
const layer = new Vexcel.Layers.WMTSLayer(options);

Extends

BaseTileLayer

Classes

WMTSLayer

Methods

# getAttributions() → {string}

Gets the attributions of the layer.

Returns:

Attributions of the layer.

Type: string

# getMaxZoom() → {number}

Gets the maximum zoom level of the layer.

Overrides:

BaseTileLayer#getMaxZoom

Returns:

The maximum zoom level of the layer.

Type: number

# getMinZoom() → {number}

Gets the minimum zoom level of the layer.

Overrides:

BaseTileLayer#getMinZoom

Returns:

The minimum zoom level of the layer.

Type: number

# getOpacity() → {number}

Gets the opacity of the layer (between 0 and 1).

Overrides:

BaseTileLayer#getOpacity

Returns:

The opacity of the layer.

Type: number

# getVisible() → {boolean}

Gets the visibility of the layer (true or false).

Overrides:

BaseTileLayer#getVisible

Returns:

The visibility of the layer.

Type: boolean

# setAttributions(attributions)

Sets the attributions of the layer.

Parameters:

Name	Type	Description
`attributions`	`string`	Attributions. Can be passed as string.

# setMaxZoom(maxZoom)

Sets the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters:

Name	Type	Description
`maxZoom`	`number`	The maximum zoom of the layer.

Overrides:

BaseTileLayer#setMaxZoom

# setMinZoom(minZoom)

Sets the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.

Parameters:

Name	Type	Description
`minZoom`	`number`	The minimum zoom of the layer.

Overrides:

BaseTileLayer#setMinZoom

# setOpacity(opacity)

Sets the opacity of the layer, allowed values range from 0 to 1.

Parameters:

Name	Type	Description
`opacity`	`number`	The opacity of the layer.

Overrides:

BaseTileLayer#setOpacity

# setVisible(visible)

Sets the visibility of the layer (true or false).

Parameters:

Name	Type	Description
`visible`	`boolean`	The visibility of the layer.

Overrides:

BaseTileLayer#setVisible