layer~WMTSLayer(name, url, options)

WMTS图层

Summary

Methods:
destroy

销毁图层。

getLayerType

获取图层类型

getLayerZIndex

返回图层的zIndex值。

getMap

获取当前图层所在的地图。

getName

获取图层名称。

getOpacity

获取图层透明度。

getTileSize

获取单张瓦片的尺寸。

getVisibility

获取图层的可见性。

offMap

解除图层与地图的关联,即从图层去掉与地图对象有关的信息,同时在地图对象去掉与该图层有关的信息。关联解除后,图层依然存在,但与地图不再有关系。
如果图层本身并未加载到地图上,那么该方法没有任何效果。

redraw

重新绘制图层

setLayerZIndex

设置图层在图层容器中的顺序。

setName

设置图层名称。

setOpacity

设置图层透明度。0表示完全透明,1表示完全不透明。

setVisibility

设置图层的可见性。仅设置该图层是否可见,而图层本身依然存在。

Constructor

new WMTSLayer(name, url, options)

Parameters:
Name Type Description
name String

图层名称

url String

WMTS服务地址

options Object

可选项

Name Type Description
layer String

提供完整路径可选,图层标识符

tileMatrixSet String

提供完整路径可选,瓦片矩阵数据集

version Number

可选,版本号,缺省1.1.0。

style String

可选,图层样式,缺省"default"。

format String

可选,瓦片地图的输出格式,缺省"image/png"。

matrixIds Array.<String>

可选,矩阵标识符列表,默认是和层级相等的数组

requestEncoding String

可选,请求编码.可选REST或者KVP(缺省)。

Methods

destroy()

销毁图层。

getLayerType() → {String}

获取图层类型

Returns:
String -

图层类型

getLayerZIndex() → {Number}

返回图层的zIndex值。

Returns:
Number -

图层的zIndex

getMap() → {module:Map}

获取当前图层所在的地图。

Returns:
module:Map -

图层所属的地图对象

getName() → {String}

获取图层名称。

Returns:
String -

图层名称

getOpacity() → {Number}

获取图层透明度。

Returns:
Number -

透明度

getTileSize() → {module:basetype~Size}

获取单张瓦片的尺寸。

Returns:
module:basetype~Size -

单张瓦片的尺寸

getVisibility() → {Boolean}

获取图层的可见性。

Returns:
Boolean -

true表示可见,false表示不可见。

offMap()

解除图层与地图的关联,即从图层去掉与地图对象有关的信息,同时在地图对象去掉与该图层有关的信息。关联解除后,图层依然存在,但与地图不再有关系。
如果图层本身并未加载到地图上,那么该方法没有任何效果。

redraw(type)

重新绘制图层

Parameters:
Name Type Default Description
type Number 1

取值为0或1,0表示map调用redraw,1表示layer调用redraw,默认为1。

setLayerZIndex(zIndex)

设置图层在图层容器中的顺序。

Parameters:
Name Type Description
zIndex Number

图层的zIndex,值越大,图层越靠近上方。但是该值改变不了图层容器的上下顺序。

setName(name)

设置图层名称。

Parameters:
Name Type Description
name String

图层名称

Throws:
Error -

当name不是String类型时抛出异常。

setOpacity(opacity)

设置图层透明度。0表示完全透明,1表示完全不透明。

Parameters:
Name Type Default Description
opacity Number 1

图层透明度,介于0-1之间。

Throws:
TypeError -

当图层的透明度值不是一个0-1之间的数字时,抛出异常。

setVisibility(visible)

设置图层的可见性。仅设置该图层是否可见,而图层本身依然存在。

Parameters:
Name Type Default Description
visible Boolean true

是否可见,默认为true,可见。

Throws:
TypeError -

当参数不是布尔类型时,抛出异常。