new ClusterLayer(map, options)
构造一个聚散图层对象
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
map |
Map |
聚散图层所在的Map对象 |
||||||||||||||||||||||||||||||||||||||||||||||||||||
options |
LayerOptions |
图层可选属性
|
Extends
Classes
Methods
-
inherited addFeature(feature)
layer/VectorLayer.js, line 36 -
给图层上添加要素
Name Type Description feature
Feature 单个要素
-
inherited addFeatures(featureArr)
layer/VectorLayer.js, line 55 -
给图层上添加多个要素
Name Type Description featureArr
Array 要素数组
-
inherited addToMap(map){layer}
layer/VectorLayer.js, line 179 -
将图层添加到指定的map上
Name Type Description map
Map 指定的map对象。
Returns:
Type Description layer 当前的图层对象 -
inherited clear()
layer/VectorLayer.js, line 77 -
清除图层上的要素
-
inherited forEachFeature(callback){Feature|undefined}
layer/VectorLayer.js, line 106 -
遍历这个图层上所有要素,回调返回每一个要素。当回调返回truthy值以停止迭代。 此函数仅迭代具有已定义几何体的要素。
Name Type Description callback
function 使用图层上的每个要素调用。返回truthy值以停止迭代。
Returns:
Type Description Feature | undefined 上次回调调用的返回值。 -
inherited forEachFeatureInExtent(extent, callback){Feature|undefined}
layer/VectorLayer.js, line 117 -
遍历这个图层上指定边界内所有要素,回调返回每一个要素。当回调返回truthy值以停止迭代。
Name Type Description extent
Array.<extent> 指定边界内,
[minx, miny, maxx, maxy]
callback
function 使用边界内的每个要素调用。返回truthy值以停止迭代。
Returns:
Type Description Feature | undefined 上次回调调用的返回值。 -
inherited get(key){*}
layer/VectorLayer.js, line 321 -
获取图层中设置的键值对内容
Name Type Description key
String key name
Returns:
Type Description * key 对应的value -
inherited getAllFeatures(){Features}
layer/VectorLayer.js, line 86 -
获取图层上的所有资源要素
Returns:
Type Description Features features -
inherited getClosestFeatureToCoordinate(coordinate, opt_filter){Feature}
layer/VectorLayer.js, line 129 -
获取该图层上最接近给定坐标的要素
Name Type Description coordinate
Array 坐标
opt_filter
function 功能过滤器功能。过滤器函数将接收一个参数
feature
,且该参数应返回布尔值。默认情况下,不进行过滤。Returns:
Type Description Feature 最接近的要素 -
getDistance(){Number}
layer/ClusterLayer.js, line 123 -
获取聚散的最小像素距离
Returns:
Type Description Number 最小像素距离 -
inherited getExtent(){Array}
layer/VectorLayer.js, line 289 -
获取图层渲染的边界范围
Returns:
Type Description Array 图层渲染的边界范围 -
inherited getFeatureById(){Feature}
layer/VectorLayer.js, line 95 -
通过要素id获取图层上的要素
Returns:
Type Description Feature feature -
inherited getFeatures(pixel){Promise.<Array.<Feature>>}
layer/VectorLayer.js, line 169 -
获取视图中给定的像素与图层中相交的要素。 准确性不及
Map#getFeaturesAtPixel()
方法使用的算法。Name Type Description pixel
Array.<pixel> viewport
上给定pixelReturns:
Type Description Promise.<Array.<Feature>> Promise that resolves with an array of features. -
inherited getFeaturesAtCoordinate(coordinate){Features}
layer/VectorLayer.js, line 148 -
获取该图层上指定坐标相交的所有要素
Name Type Description coordinate
Array 坐标
Returns:
Type Description Features 图层上指定坐标相交的所有要素 -
inherited getFeaturesExtent(){Array.<extent>}
layer/VectorLayer.js, line 138 -
获取该图层上所有要素的边界
Returns:
Type Description Array.<extent> 所有要素的边界 -
inherited getFeaturesInExtent(extent){Features}
layer/VectorLayer.js, line 158 -
获取该图层上指定边界内的所有要素
Name Type Description extent
Array.<extent> 指定边界内,
[minx, miny, maxx, maxy]
Returns:
Type Description Features 图层上指定边界内的所有要素 -
inherited getMaxZoom(){number}
layer/VectorLayer.js, line 271 -
获取图层可见的最大视图缩放级别
Returns:
Type Description number 图层可见的最大视图缩放级别 -
inherited getMinZoom(){number}
layer/VectorLayer.js, line 253 -
获取图层的最小视图缩放级别
Returns:
Type Description number minZoom 图层的最小视图缩放级别 -
inherited getOpacity(){number}
layer/VectorLayer.js, line 217 -
获取图层的透明度
Returns:
Type Description number opacity 图层的透明度 -
getOptions(){Object}
layer/ClusterLayer.js, line 149 -
获取图层资源属性
Returns:
Type Description Object 图层资源属性 -
inherited getVisible(){Boolean}
layer/VectorLayer.js, line 199 -
获取图层的可见度
Returns:
Type Description Boolean visibale图层是否可见。 -
inherited getZIndex(){number}
layer/VectorLayer.js, line 235 -
获取图层的zIndex
Returns:
Type Description number 图层的zIndex -
inherited on(type, listener)
layer/VectorLayer.js, line 341 -
监听图层属性的改变
Name Type Description type
String 监听的类型,比如:
change:extent
、change:maxZoom
、change:visible
等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#onlistener
function 回调函数
-
inherited once(type, listener)
layer/VectorLayer.js, line 363 -
监听一次图层属性的改变
Name Type Description type
String 监听的类型,比如:
change:extent
、change:maxZoom
、change:visible
等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#onlistener
function 回调函数
-
inherited removeFeature(feature)
layer/VectorLayer.js, line 46 -
从图层上移出要素
Name Type Description feature
Feature 单个要素
-
inherited removeFeatures(featureArr)
layer/VectorLayer.js, line 65 -
从图层上移出多个要素
Name Type Description featureArr
Array 要素数组
-
inherited set(key, value)
layer/VectorLayer.js, line 311 -
给图层的
value
属性中添加键值对,用于给图层绑定一些要用到的数据Name Type Description key
String key name
value
* value
-
setDistance(distance)
layer/ClusterLayer.js, line 113 -
设置聚散的最小像素距离
Name Type Description distance
Number 最小像素距离
-
inherited setExtent(extent)
layer/VectorLayer.js, line 280 -
设置图层渲染的边界范围。该图层不会在此范围之外渲染。
Name Type Description extent
Array 图层渲染的边界范围,
[minx, miny, maxx, maxy]
-
inherited setMap(map)
layer/VectorLayer.js, line 301 -
设置要在地图上其他图层之上渲染的图层。地图将不会在其图层集合中管理此图层, 并且其中的回调
Map#forEachLayerAtPixel()
将null作为图层接收。 这对于临时层很有用。要从地图上删除非托管图层,请使用#setMap(null)
。 要将图层添加到地图并由地图管理,请使用Map#addLayer()
.Name Type Description map
Array 要渲染图层的地图对象
-
inherited setMaxZoom(maxZoom)
layer/VectorLayer.js, line 262 -
设置图层可见的最大视图缩放级别
Name Type Description maxZoom
number 图层可见的最大视图缩放级别
-
inherited setMinZoom(minZoom)
layer/VectorLayer.js, line 244 -
设置图层的最小视图缩放级别(不包括),在该级别之上,该层将可见。
Name Type Description minZoom
number 图层的最小视图缩放级别
-
inherited setOpacity(opacity)
layer/VectorLayer.js, line 208 -
设置图层的透明度
Name Type Description opacity
number 图层的透明度
-
inherited setVisible(visibale)
layer/VectorLayer.js, line 189 -
设置图层的可见度
Name Type Description visibale
Boolean 图层是否可见。
-
inherited setZIndex(zIndex)
layer/VectorLayer.js, line 226 -
设置图层的zIndex
Name Type Description zIndex
number 图层的zIndex
-
inherited un(type, listener)
layer/VectorLayer.js, line 352 -
取消监听图层属性的改变
Name Type Description type
String 监听的类型,比如:
change:extent
、change:maxZoom
、change:visible
等, 更多详细类型查看链接:https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html#onlistener
function 回调函数
-
inherited unset(key)
layer/VectorLayer.js, line 330 -
移出图层指定属性
Name Type Description key
String key name