Class: CustomTileLayer

CustomTileLayer

该图层继承于ol/layer/Tile,并且重载了它常用的一些方法,方便后面其他类使用它的时候，生成文档方便。

new CustomTileLayer()

layer/CustomTileLayer.js, line 28

Classes

CustomTileLayer
CustomTileLayer

Methods

addToMap(map){layer}

layer/CustomTileLayer.js, line 55

将图层添加到指定的map上

Name Type Description
map Map

指定的map对象。
Returns:
Type Description
layer 当前的图层对象

get(key){*}

layer/CustomTileLayer.js, line 196

获取图层中设置的键值对内容

Name Type Description
key String

key name
Returns:
Type Description
* key 对应的value

getExtent(){Array}

layer/CustomTileLayer.js, line 164

获取图层渲染的边界范围

Returns:
Type Description
Array 图层渲染的边界范围

getMaxZoom(){number}

layer/CustomTileLayer.js, line 146

获取图层可见的最大视图缩放级别

Returns:
Type Description
number 图层可见的最大视图缩放级别

getMinZoom(){number}

layer/CustomTileLayer.js, line 128

获取图层的最小视图缩放级别

Returns:
Type Description
number minZoom 图层的最小视图缩放级别

getOpacity(){number}

layer/CustomTileLayer.js, line 92

获取图层的透明度

Returns:
Type Description
number opacity 图层的透明度

getOptions(){Object}

layer/CustomTileLayer.js, line 45

获取图层资源属性

Returns:
Type Description
Object 图层资源属性

getVisible(){Boolean}

layer/CustomTileLayer.js, line 74

获取图层的可见度

Returns:
Type Description
Boolean visibale图层是否可见。

getZIndex(){number}

layer/CustomTileLayer.js, line 110

获取图层的zIndex

Returns:
Type Description
number 图层的zIndex

on(type, listener)

layer/CustomTileLayer.js, line 216

监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extent、change:maxZoom、change:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html#on
listener function

回调函数

once(type, listener)

layer/CustomTileLayer.js, line 238

监听一次图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extent、change:maxZoom、change:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html#on
listener function

回调函数

set(key, value)

layer/CustomTileLayer.js, line 186

给图层的value属性中添加键值对,用于给图层绑定一些要用到的数据

Name Type Description
key String

key name
value *

value

setExtent(extent)

layer/CustomTileLayer.js, line 155

设置图层渲染的边界范围。该图层不会在此范围之外渲染。

Name Type Description
extent Array

图层渲染的边界范围,[minx, miny, maxx, maxy]

setMap(map)

layer/CustomTileLayer.js, line 176

设置要在地图上其他图层之上渲染的图层。地图将不会在其图层集合中管理此图层， 并且其中的回调 Map#forEachLayerAtPixel()将null作为图层接收。 这对于临时层很有用。要从地图上删除非托管图层，请使用#setMap(null)。 要将图层添加到地图并由地图管理，请使用Map#addLayer().

Name Type Description
map Array

要渲染图层的地图对象

setMaxZoom(maxZoom)

layer/CustomTileLayer.js, line 137

设置图层可见的最大视图缩放级别

Name Type Description
maxZoom number

图层可见的最大视图缩放级别

setMinZoom(minZoom)

layer/CustomTileLayer.js, line 119

设置图层的最小视图缩放级别（不包括），在该级别之上，该层将可见。

Name Type Description
minZoom number

图层的最小视图缩放级别

setOpacity(opacity)

layer/CustomTileLayer.js, line 83

设置图层的透明度

Name Type Description
opacity number

图层的透明度

setVisible(visibale)

layer/CustomTileLayer.js, line 65

设置图层的可见度

Name Type Description
visibale Boolean

图层是否可见。

setZIndex(zIndex)

layer/CustomTileLayer.js, line 101

设置图层的zIndex

Name Type Description
zIndex number

图层的zIndex

un(type, listener)

layer/CustomTileLayer.js, line 227

取消监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extent、change:maxZoom、change:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html#on
listener function

回调函数

unset(key)

layer/CustomTileLayer.js, line 205

移出图层指定属性

Name Type Description
key String

key name

CustomTileLayer CustomTileLayer

该图层继承于ol/layer/Tile,并且重载了它常用的一些方法,方便后面其他类使用它的时候，生成文档方便。

new CustomTileLayer(options)

layer/CustomTileLayer.js, line 28
Name Type Description
options LayerOptions optional

图层属性选项.

Name Type Default Description
className string 'ol-layer' optional

设置layer元素的CSS类名称。
opacity number 1 optional

不透明度（0，1）。
visible boolean true optional

图层是否可见。
extent Array optional

图层渲染的边界范围。该图层不会在此范围之外渲染。
zIndex number optional

图层渲染的Z索引。在渲染时，将首先按Z索引然后按位置对图层进行排序。 当zIndex为undefined时，zIndex将被设置为0加入到图层集合中； 而在使用图层的setMap()方法时，zIndex为Infinity。
minZoom number optional

最小视图缩放级别（不包括），在该级别之上，该层将可见。
maxZoom number optional

该图层可见的最大视图缩放级别（包括该级别）。
map Map optional

将图层设置为地图上的叠加层。地图将不会在其图层集合中管理此图层， 也就是当调用Map#getLayers()方法时，图层集合里不会出现该图层。并且该图层将呈现在顶部。 这对于临时层很有用。在地图上添加图层并由地图管理图层的标准方法是使用Map#addLayer()方法。

Classes

CustomTileLayer
CustomTileLayer

Methods

addToMap(map){layer}

layer/CustomTileLayer.js, line 55

将图层添加到指定的map上

Name Type Description
map Map

指定的map对象。
Returns:
Type Description
layer 当前的图层对象

get(key){*}

layer/CustomTileLayer.js, line 196

获取图层中设置的键值对内容

Name Type Description
key String

key name
Returns:
Type Description
* key 对应的value

getExtent(){Array}

layer/CustomTileLayer.js, line 164

获取图层渲染的边界范围

Returns:
Type Description
Array 图层渲染的边界范围

getMaxZoom(){number}

layer/CustomTileLayer.js, line 146

获取图层可见的最大视图缩放级别

Returns:
Type Description
number 图层可见的最大视图缩放级别

getMinZoom(){number}

layer/CustomTileLayer.js, line 128

获取图层的最小视图缩放级别

Returns:
Type Description
number minZoom 图层的最小视图缩放级别

getOpacity(){number}

layer/CustomTileLayer.js, line 92

获取图层的透明度

Returns:
Type Description
number opacity 图层的透明度

getOptions(){Object}

layer/CustomTileLayer.js, line 45

获取图层资源属性

Returns:
Type Description
Object 图层资源属性

getVisible(){Boolean}

layer/CustomTileLayer.js, line 74

获取图层的可见度

Returns:
Type Description
Boolean visibale图层是否可见。

getZIndex(){number}

layer/CustomTileLayer.js, line 110

获取图层的zIndex

Returns:
Type Description
number 图层的zIndex

on(type, listener)

layer/CustomTileLayer.js, line 216

监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extent、change:maxZoom、change:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html#on
listener function

回调函数

once(type, listener)

layer/CustomTileLayer.js, line 238

监听一次图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extent、change:maxZoom、change:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html#on
listener function

回调函数

set(key, value)

layer/CustomTileLayer.js, line 186

给图层的value属性中添加键值对,用于给图层绑定一些要用到的数据

Name Type Description
key String

key name
value *

value

setExtent(extent)

layer/CustomTileLayer.js, line 155

设置图层渲染的边界范围。该图层不会在此范围之外渲染。

Name Type Description
extent Array

图层渲染的边界范围,[minx, miny, maxx, maxy]

setMap(map)

layer/CustomTileLayer.js, line 176

设置要在地图上其他图层之上渲染的图层。地图将不会在其图层集合中管理此图层， 并且其中的回调 Map#forEachLayerAtPixel()将null作为图层接收。 这对于临时层很有用。要从地图上删除非托管图层，请使用#setMap(null)。 要将图层添加到地图并由地图管理，请使用Map#addLayer().

Name Type Description
map Array

要渲染图层的地图对象

setMaxZoom(maxZoom)

layer/CustomTileLayer.js, line 137

设置图层可见的最大视图缩放级别

Name Type Description
maxZoom number

图层可见的最大视图缩放级别

setMinZoom(minZoom)

layer/CustomTileLayer.js, line 119

设置图层的最小视图缩放级别（不包括），在该级别之上，该层将可见。

Name Type Description
minZoom number

图层的最小视图缩放级别

setOpacity(opacity)

layer/CustomTileLayer.js, line 83

设置图层的透明度

Name Type Description
opacity number

图层的透明度

setVisible(visibale)

layer/CustomTileLayer.js, line 65

设置图层的可见度

Name Type Description
visibale Boolean

图层是否可见。

setZIndex(zIndex)

layer/CustomTileLayer.js, line 101

设置图层的zIndex

Name Type Description
zIndex number

图层的zIndex

un(type, listener)

layer/CustomTileLayer.js, line 227

取消监听图层属性的改变

Name Type Description
type String

监听的类型,比如:change:extent、change:maxZoom、change:visible等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html#on
listener function

回调函数

unset(key)

layer/CustomTileLayer.js, line 205

移出图层指定属性

Name Type Description
key String

key name