SuperGIS Server JavaScript API Reference > sg/layers > WMTSLayer

new sg.layers.WMTSLayer(url, options)

Description

A WMTS Layer

Position

WMTSLayer.js

Parameters

Parameter

Type

Description

url

String

Url of a WMTS Service

options

Object

WMTS Layer settings

set object

Name

Type

Description

resourceInfo

Object

WMTS 服務的資訊，如果resourceInfo 沒有指定，那麼便會使用proxy來解讀WMTS服務能力。

Name	Type	Description
version	String	WMTS service version
layerInfos	Array.<Object>	An array of WMTSLayerInfo

layerInfo

Object

一個WMTSLayerInfo 的物件，當ResourceInfo 選項沒有被指定時，地圖將會以WMTS中的第一個符合properties描述的圖層做展示。

Properties

Properties	Type	Description
extent	sg.geometry.Extent	layer extent
loadError	Error	contains value when the layer is failed to load
map	MapBase	target MapBase
maxScale	Number	Maximum visible scale
minScale	Number	Minimum visible scale
name	String	layer name
node	DOMNODE	layer html node
opacity	Number	layer transparency
spatialReference	sg.SpatialReference	layer coordinate system
tileInfo	sg.layers.TileInfo	tile layer info
title	String	layer title
visible	Boolean	layer visibility True: Visible False: Invisible

Methods

Type

Description

getMap()

Returns:

MapBase

return target MapBase

Returns:

Type	Description
MapBase	The target mapbase

getName()

Returns:

String

return layer name

Returns:

Type	Description
String	The layer name

getNode()

Returns:

DOMNODE

return layer html node

Returns:

Type	Description
DOMNODE	The layer html node

getTileUrl(s, x, y)

s:Number

x:Number

y:Number

Returns:String

return the tile image based on the specified tile level (s) and tile index (x and y). Users can overwrite this method to access their customized tile service.

Name	Type	Description
s	Number	The level of tiles
x	Number	The index in x-direction of tiles
y	Number	The index in y-direction of tiles

Returns:

Type	Description
String	The url of the cache

getTitle()

Returns:

String

return layer title

Returns:

Type	Description
String	The layer title

getVisible()

Returns:

Boolean

return layer visibility

Returns:

Type	Description
Boolean	True: Visible False: Invisible

hide()

hide layer

Initialize()

called when layer being added to the MapBase

putName(newVal)

String

set layer name

Name	Type	Description
newVal	String	The layer name

putTitle(newVal)

String

set layer title

Name	Type	Description
newVal	String	The layer title

putVisible(newVal)

Boolean

set layer visibility

Name	Type	Description
newVal	Boolean	True: Visible False: Invisible

RebuildElement()

redraw layers

removeAllImages

Remove all MapImages from the layer

RemoveSelf()

remove self

setMaxScale(maxScale)

Number

set the maximum visible scale of the layer

Name	Type	Description
maxScale	Number	The maximum scale for visible

setMinScale(minScale)

Number

set the minimum visible scale of the layer

Name	Type	Description
minScale	Number	The minimum scale for visible

setOpacity(opacity)

Number

Set up the layer transparency

Name	Type	Description
opacity	Number	0: 100% transparent 1: No transparency

show()

show layer

UpdateElement()

update layers

Events

Event	Description
load	triggered when layers are loaded

Example

var CreateWMTS = function () {

var layerInfo = new sg.layers.WMTSLayerInfo({

identifier: "AMSR2_Snow_Water_Equivalent",

tileMatrixSet: "EPSG4326_2km",

format: "png"

});

var options = {

serviceMode: "KVP",

layerInfo: layerInfo

};

var wmts = "http://map1.vis.earthdata.nasa.gov/wmts-geo/1.0.0/WMTSCapabilities.xml";

wmtsLayer = new sg.layers.WMTSLayer(wmts, options);

wmtsLayer.loadEffect = true;

if (wmtsLayer.loadError) {

alert("Load WMTS layer failed");

return;

}

See live demo