layer~ClusterLayer(name, options)

聚合图层,负责矢量点要素的聚合。支持百万要素的快速聚合,数量太多时首次聚合耗时略长。

Summary

Methods:
addFeature

添加要聚合的原始数据。注:当前版本中仅支持添加点要素,对点状要素进行聚合运算。

addFeatures

添加多个要聚合的原始数据。注:当前版本中仅支持添加点要素,对点状要素进行聚合运算。

getAllFeatures

获取当前视野的所有聚合之后的要素。ps:当前范围的聚合要素就是该图层的所有聚合要素,不在视野范围的要素不参与聚合计算

getChildrenByClusterFid

通过聚合之后要素的id获取该聚合点的子节点

getClusterFeaturesByFid

通过聚合之后要素的id获取该聚合点所聚合的所有原始要素。

getLayerType

获取图层的类型

getOriginFeature

获取所有添加到聚合图层上的原始要素

removeAllFeatures

删除所有地理要素。

removeFeature

删除单个地理要素。

removeFeatures

删除一组指定的地理要素。

Constructor

new ClusterLayer(name, options)

Parameters:
Name Type Description
name String

图层名称

options Object

可选项,给出的属性都将被绑定到该图层对象上。

Name Type Description
gridSize Number

聚合半径,单位为像素,默认值为256,聚合半径越小,聚合点越密集。

clusterStyle module:style~Style

聚合点的样式

styleCallBack function

生成自定义样式的回调,根据聚合点的数量决定样式,接受的参数为聚合点的数量,优先级高于clusterStyle。 例如:function(num){if(num<10){return style1}else{return style2}}

disableClusteringAtZoom Number

表示大于或者等于该级别不再聚合,全部以要素自身的样式显示,默认17。

minClusterNum Number

发生聚合的最少点数,即一个聚合半径内的要素数量达到minClusterNum才会聚合,默认值为2

isAnimated Boolean

是否开启聚合动画,默认为false。

animationFrames Number

动画完成的帧数,取值为正整数,默认取值为20,取值越大动画越慢。

Example
let options = {
 enableHashCode: true,  //聚合的要素可以被拾取
 clusterStyle: clusterStyle, //聚合的样式
 disableClusteringAtZoom: 18 //地图达到18级之后就不再聚合
};
let custerLayer = new ClusterLayer("聚合图层",options);

Members

clampToGround

设置贴地状态

Overrides:

depthTest

获取图层的深度测试属性
return {Boolean} 深度测试属性

Overrides:

Methods

addFeature(feature)

添加要聚合的原始数据。注:当前版本中仅支持添加点要素,对点状要素进行聚合运算。

Parameters:
Name Type Description
feature module:feature~Vector

要聚合的要素

addFeatures(features)

添加多个要聚合的原始数据。注:当前版本中仅支持添加点要素,对点状要素进行聚合运算。

Parameters:
Name Type Description
features Array.<module:feature~Vector>

要聚合的要素数组

getAllFeatures() → {Array.<module:feature~Vector>}

获取当前视野的所有聚合之后的要素。ps:当前范围的聚合要素就是该图层的所有聚合要素,不在视野范围的要素不参与聚合计算

Returns:
Array.<module:feature~Vector> -

聚合之后的点,包括单点

getChildrenByClusterFid(fid) → {Array.<module:feature~Vector>}

通过聚合之后要素的id获取该聚合点的子节点

Parameters:
Name Type Description
fid String
Returns:
Array.<module:feature~Vector> -

子节点

getClusterFeaturesByFid(fid) → {Array.<module:feature~Vector>}

通过聚合之后要素的id获取该聚合点所聚合的所有原始要素。

Parameters:
Name Type Description
fid String

聚合点要素的id

Returns:
Array.<module:feature~Vector> -

通过聚合之后要素的id获取被聚合的所有要素。

getLayerType() → {String}

获取图层的类型

Returns:
String -

图层类型

getOriginFeature() → {Array.<module:feature~Vector>}

获取所有添加到聚合图层上的原始要素

Returns:
Array.<module:feature~Vector> -

所有原始点

removeAllFeatures()

删除所有地理要素。

removeFeature(feature)

删除单个地理要素。

Parameters:
Name Type Description
feature module:feature~Vector

要删除的地理要素

removeFeatures(features)

删除一组指定的地理要素。

Parameters:
Name Type Description
features Array.<module:feature~Vector>

要删除的地理要素