abstract layer~GridLayer(name, url, options)

网格式图层的基类。所谓网格式图层,就是把地理范围划分成众多规则的单元格网,每一格网中囊括一部分地理数据。当请求方发起访问时,地理数据以分块的方式响应并渲染。
一般情况下,在所有比例级别下,每个单元格网的大小是相同的,但不同比例级别下的网格地理数据的丰富程度不同。
注意:该类及类以下的所有接口暂不开放,谨慎使用

Summary

Methods:
destroy

销毁图层。

getLayerType

获取图层类型

getLayerZIndex

返回图层的zIndex值。

getMap

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

getName

获取图层名称。

getOpacity

获取图层透明度。

getTileSize

获取单张瓦片的尺寸。

getVisibility

获取图层的可见性。

offMap

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

redraw

重新绘制图层

setLayerZIndex

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

setName

设置图层名称。

setOpacity

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

setTileUrl

图层服务地址layerURL与瓦片信息中的X,Y,Z拼接(该方法暂未实现)
子类根据服务规则拼接URL。

setVisibility

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

Constructor

new abstract GridLayer(name, url, options)

Parameters:
Name Type Description
name String

图层名称

url String

图层地址

options Object

自定义的额外属性键值对

Name Type Description
serverResolutions Array

服务端切片的分辨率数组

matrixOrigin module:basetype~Coordinate

切片矩阵的原点坐标,也叫切片原点。

gridSize module:basetype~Size

网格大小,即切片的大小。

vaoPoolCapacity Number

缓冲池大小,铺满整个地图所需切片的倍数,默认是30,比如1080p的屏幕全屏铺满整个地图需要32(19201080/256/256)张256256的切片,缓存池默认值就是3230=960张切片,该值越大,js内存占用越大,api限制了最大值为1000张256256切片大小当量的内存为缓冲上限

dataFormat String

切片格式,栅格切片支持“png”|“jpg"|"bmp"。

reverseY Boolean

Y轴是否反转,值为true时,切片方向为由下往上切;false时,切片方向为由上往下切。默认值为false。

token String

请求切片时带上的token参数

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之间的数字时,抛出异常。

setTileUrl(tile)

图层服务地址layerURL与瓦片信息中的X,Y,Z拼接(该方法暂未实现)
子类根据服务规则拼接URL。

Parameters:
Name Type Description
tile *

setVisibility(visible)

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

Parameters:
Name Type Default Description
visible Boolean true

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

Throws:
TypeError -

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