CIMCubeSDK v3.34.0

Class: ClusterLayer

Glodon.CIMCube.Layer. ClusterLayer

ClusterLayer聚合图层

new ClusterLayer(options)

ClusterLayer图层构造函数
Parameters:
Name Type Description
options Object 图层配置参数
Properties
Name Type Argument Default Description
enabled Boolean <optional>
 false 开启聚合
show Boolean <optional>
 true 显示entity对象
pixelRange Number <optional>
 20 扩展屏幕空间边界框的像素范围
minimumClusterSize Number <optional>
 5 可以聚集的最小屏幕空间对象数
cartesian3Range Number <optional>
 聚合三维距离，点位距离小于这个值将不自动展开
expandRadius Number <optional>
 20 扩展半径
expandRadiusAdd Number <optional>
 40 大于6个聚合图标扩展半径
clusterCategory Array.<ClusterCategoryOptions> <optional>
 聚合类别
boundary Array <optional>
 聚合范围，GeoJSON 几何面
imageSize Array <optional>
 [50,59] 聚合对象图片大小
labelSize Number <optional>
 20 标注字号
labelColor String <optional>
 #ffffff 标注颜色
labelOffset Array <optional>
 [-4.0, -28.0] 标注偏移量，(0,0)在中下方，水平向右为正，垂直向下为正
clampToGround Boolean <optional>
 false 是否贴地
translucencyByDistance Array <optional>
 按距离控制透明度。 数组格式：[nearDistance, nearAlpha, farDistance, farAlpha] - nearDistance {Number}: 近距离值（米） - nearAlpha {Number}: 近距离时的透明度（0.0完全透明 - 1.0完全不透明） - farDistance {Number}: 远距离值（米，必须大于nearDistance） - farAlpha {Number}: 远距离时的透明度（0.0完全透明 - 1.0完全不透明） 也可以直接传入NearFarScalar对象
disableDepthTest boolean <optional>
 false 是否禁用深度测试

Extends

Members

alpha :Number

图层透明度 0.0~1.0
Type:
  • Number
Inherited From:
Overrides:
Default Value:
  • 1.0

cacheable :Boolean

是否可缓存
Type:
  • Boolean
Inherited From:
Overrides:

canHighlight :Boolean

可否高亮
Type:
  • Boolean
Inherited From:
Overrides:

canSelected :Boolean

可否被选中
Type:
  • Boolean
Inherited From:
Overrides:

clampToGround :Boolean

是否贴地
Type:
  • Boolean

disableDepthTest :Boolean

是否禁用深度测试
Type:
  • Boolean

enabled :Boolean

是否开启聚合
Type:
  • Boolean

enableMouseMove :Boolean

图层是否可以触发鼠标移动事件
Type:
  • Boolean
Inherited From:
Overrides:
Default Value:
  • true

entities :Array.<Entity>

entities 数组
Type:
  • Array.<Entity>

glowColor :String

发光颜色
Type:
  • String
Inherited From:
Overrides:

glowTimeInterval :String

闪烁的颜色
Type:
  • String
Inherited From:
Overrides:

id :String

id
Type:
  • String
Inherited From:
Overrides:

isPipeline :Boolean

数据是否是管线类型
Type:
  • Boolean
Inherited From:
Overrides:

matrix :Object

图层偏移
Type:
  • Object
Inherited From:
Overrides:

minimumClusterSize :Number

可以聚集的最小屏幕空间对象数
Type:
  • Number

name :String

图层名称
Type:
  • String
Inherited From:
Overrides:

pickable :Boolean

pickable
Type:
  • Boolean
Inherited From:
Overrides:

pixelRange :Number

扩展屏幕空间边界框的像素范围
Type:
  • Number

<readonly> ready :Boolean

数据是否已经加载
Type:
  • Boolean
Inherited From:
Overrides:

rotationPointOffset :Cartesian3

图层指定的旋转点，模型坐标系下基于原点的偏移点，默认是包围盒中心点
Type:
  • Cartesian3
Inherited From:
Overrides:

selectedColor :String

选中颜色
Type:
  • String
Inherited From:
Overrides:

show :Boolean

是否显示
Type:
  • Boolean
Overrides:

translucencyByDistance :Array|undefined

获取或设置按距离控制透明度的属性 该属性用于控制聚合图层中实体（billboard、point、label）的透明度随相机距离的变化。 透明度在指定的距离范围内进行插值计算。
Type:
  • Array | undefined
Examples
// 获取当前设置
const current = clusterLayer.translucencyByDistance;
// current可能是 [100.0, 1.0, 10000.0, 0.2] 或 undefined
// 设置透明度控制（数组格式）
clusterLayer.translucencyByDistance = [100.0, 1.0, 10000.0, 0.2];
// 参数说明：
// 100.0 - 近距离（米）
// 1.0 - 近距离时的透明度（完全不透明）
// 10000.0 - 远距离（米）
// 0.2 - 远距离时的透明度（较透明）
// 清除透明度控制
clusterLayer.translucencyByDistance = undefined;

<readonly> type :String

图层类型
Type:
  • String
Inherited From:
Overrides:

url :String

图层url地址
Type:
  • String
Inherited From:
Overrides:

Methods

add(options)

添加entity实例
Parameters:
Name Type Description
options Object 参数
Properties
Name Type Argument Description
id String <optional>
 ID
location Array 点坐标
style Object | HTMLDivElement 样式，参考：https://cimcube.glodon.com/openservice/user-guide/405?categoryId=2448&origin=homepage
label Object 标注
Returns:
entity对象
Type
Object

addTo(map)

将图层添加到图层管理器中
Parameters:
Name Type Description
map Glodon.CIMCube 地图实例
Inherited From:
Overrides:

contains(entity)

判断图层是否包含该对象
Parameters:
Name Type Description
entity Cesium.Entity Entity对象
Returns:
Type
Boolean

dispatchEvent(event)

在此事件派发器上派发事件.
Parameters:
Name Type Description
event Object 待派发的事件.
Inherited From:
Overrides:

dispose()

释放资源

flyTo()

飞行定位

getById(id)

通过ID获取Entity对象
Parameters:
Name Type Description
id String 对象ID
Returns:
Entity对象
Type
Cesium.Entity

getParentId()

获取父节点ID
Inherited From:
Overrides:
Returns:
父节点ID
Type
String

remove(entity)

移除对象
Parameters:
Name Type Description
entity Cesium.Entity Entity对象
Returns:
Type
Boolean

removeAll()

移除所有对象

removeById(id)

通过ID移除对象
Parameters:
Name Type Description
id String 对象ID
Returns:
Type
Boolean

removeDragHandle()

在场景中移除操作句柄
Inherited From:
Overrides:

removeFrom()

将图层从图层管理器中移除
Inherited From:
Overrides:

Events

ENTITY_CLICK

鼠标点击Entity时触发
Example
layer.on(Glodon.CIMCube.Global.Defines.LayerEventType.ENTITY_CLICK, function (event) {
 console.log(event);
})

ENTITY_MOUSE_ENTER

鼠标进入Entity时触发
Example
layer.on(Glodon.CIMCube.Global.Defines.LayerEventType.ENTITY_MOUSE_ENTER, function (event) {
 console.log(event);
})

ENTITY_MOUSE_LEAVE

鼠标离开Entity时触发
Example
layer.on(Glodon.CIMCube.Global.Defines.LayerEventType.ENTITY_MOUSE_LEAVE, function (event) {
 console.log(event);
})