CIMCubeSDK v3.34.0

Class: GmlLayer

Glodon.CIMCube.Layer. GmlLayer

GmlLayer图层

new GmlLayer(opts)

GML图层构造函数
Parameters:
Name Type Description
opts Object 图层配置参数
Properties
Name Type Argument Default Description
data Object <optional>
 GeoJSON 对象
style String | Object | Array.<Object> <optional>
 Style 对象
height Number 距地面高度
extrudedHeight Number 下底面距地面高度
defaultColor String | Cesium.Color <optional>
 #FFFF00 默认保底颜色，默认是黄色
defaultImage String 默认图片url
defaultSize Array 图片大小，默认[30,36]
clampToGround Boolean <optional>
 false 是否贴地
clampToModel Boolean <optional>
 false 是否贴模型
geometryType String <optional>
 图层几何类型
enableLighting Boolean <optional>
 true 是否受光照影响产生明暗效果
zIndex Number <optional>
 图层层级,仅支持线和面

Extends

Members

alpha :Number

透明度
Type:
  • Number
Overrides:

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
Default Value:
  • false

clampToModel :Boolean

贴模型设置
Type:
  • Boolean
Default Value:
  • false

cluster :Object

聚合对象
Type:
  • Object
Properties:
Name Type Description
cluster

enableCluster :Boolean

开启聚合
Type:
  • Boolean
Default Value:
  • false

enableLabel :Boolean

开启标注
Type:
  • Boolean

enableLabelAlphaByDistance :Boolean

开启标注随距离的透明度
Type:
  • Boolean
Default Value:
  • false

enableLabelAvoidance :Boolean

开启标注避让
Type:
  • Boolean
Default Value:
  • false

enableLabelOffsetByDistance :Boolean

开启标注随距离的偏移值
Type:
  • Boolean
Default Value:
  • false

enableLabelScaleByDistance :Boolean

开启标注随距离的缩放比
Type:
  • Boolean
Default Value:
  • false

enableLabelVisibleByDistance :Boolean

开启标注的可视范围
Type:
  • Boolean
Default Value:
  • false

enableMouseMove :Boolean

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

enableThinning :Boolean

开启抽稀
Type:
  • Boolean
Default Value:
  • false

enableVisibleByDistance :Boolean

开启Entity的可视范围
Type:
  • Boolean

geometryType :String

几何类型
Type:
  • String

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:

labelAvoidanceThreshold :Number

标注避让阈值
Type:
  • Number
Default Value:
  • 10

matrix :Object

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

name :String

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

pickable :Boolean

pickable
Type:
  • Boolean
Inherited From:
Overrides:

<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:

thinningTolerance :Number

抽稀容差
Type:
  • Number
Default Value:
  • 10

<readonly> type :String

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

url :String

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

zIndex :Number

图层层级,仅支持线和面
Type:
  • Number

Methods

addFeatures(features)

添加要素
Parameters:
Name Type Description
features String | Object | Array 要素

addTo(map)

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

dispatchEvent(event)

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

dispose()

释放资源

flyTo()

摄像机定位到图层

getEntities()

获取图层的所有实体
Returns:
实体数组，参见Cesium.EntityCollection
Type
Array

getEntitiesByProperty()

根据属性值获取实体
Returns:
实体数组，参见Cesium.EntityCollection
Type
Array

getEntityByID(id)

根据id获取实体
Parameters:
Name Type Description
id String 实体id
Returns:
实体
Type
Entity

getEntityProperty(entity, propName)

获取实体某个属性值
Parameters:
Name Type Description
entity Entity 实体对象，参见Cesium.Entity
propName String 属性名称
Returns:
属性值
Type
Object

getEntityPropertyList(entity)

获取实体属性表
Parameters:
Name Type Description
entity Entity 实体对象，参见Cesium.Entity
Returns:
属性字典
Type
Map

getFields()

获取字段
Returns:
字段数组.
Type
Array

getGeometryType()

获取图层几何类型
Returns:
几何类型
Type
String

getLabelStyle()

获取标注样式
Returns:
标注样式选项
Type
Object

getLegendInfo()

获取图例
Returns:
图例数组.
Type
Array

getParentId()

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

getStyle()

获取样式Json

load(data)

加载GeoJSON数据,替换现有数据
Parameters:
Name Type Description
data Object GeoJSON object 数据

queryFeatures(filter)

筛选要素
Parameters:
Name Type Description
filter Object 筛选条件，以下筛选方式三选一
Properties
Name Type Description
id Number 按id筛选，例: var filter = {id:1}
list Array 按id列表筛选，例: var filter = {list: [1, 2, 3, 4, 5]}
filter Object 按属性筛选，例:var filter = {filter: { field: 'name', value: '国有土地', equal: false}}
Returns:
geojson要素集，GeoJsonFeatureCollection具体接口请参考文档
Type
GeoJsonFeatureCollection

removeAll()

移除所有的Entity

removeDragHandle()

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

removeFrom()

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

setBlockByField(field [, factor])

通过字段构建体块
Parameters:
Name Type Argument Default Description
field String 字段名称
factor Number <optional>
 1 系数

setBlockByValue(blockHeight)

通过高度值构建体块
Parameters:
Name Type Description
blockHeight Number 体块高度

setEntityStyle(entity, style)

设置Entity样式(仅支持单一符号化样式)
Parameters:
Name Type Description
entity Cesium.Entity
style Object

setHeight(height)

设置entity的离地高度
Parameters:
Name Type Description
height Number 离地高度,单位米

setHeightByField(field [, factor])

通过字段设置离地高度
Parameters:
Name Type Argument Default Description
field String 字段名称
factor Number <optional>
 1 系数

setLabelAlphaByDistance( [near] [, nearValue] [, far] [, farValue])

设置标注随距离的透明度
Parameters:
Name Type Argument Default Description
near Number <optional>
 0.0 相机范围的下限
nearValue Number <optional>
 1.0 相机范围的下限值
far Number <optional>
 Number.MAX_VALUE 相机范围的上限
farValue Number <optional>
 1.0 相机范围的上限值

setLabelHeight(height)

设置的高度随着体块高度去变化
Parameters:
Name Type Description
height Number 高度,单位米

setLabelOffsetByDistance( [near] [, nearValue] [, far] [, farValue])

设置标注随距离的偏移值
Parameters:
Name Type Argument Default Description
near Number <optional>
 0.0 相机范围的下限
nearValue Number <optional>
 0.0 相机范围的下限值
far Number <optional>
 Number.MAX_VALUE 相机范围的上限
farValue Number <optional>
 0.0 相机范围的上限值

setLabelScaleByDistance( [near] [, nearValue] [, far] [, farValue])

设置标注随距离的缩放比
Parameters:
Name Type Argument Default Description
near Number <optional>
 0.0 相机范围的下限
nearValue Number <optional>
 1.0 相机范围的下限值
far Number <optional>
 Number.MAX_VALUE 相机范围的上限
farValue Number <optional>
 1.0 相机范围的上限值

setLabelStyle(options)

设置标注样式
Parameters:
Name Type Description
options Object 样式配置参数
Properties
Name Type Argument Default Description
fieldName String 字段名称
font String <optional>
 '30px sans-serif' 字体
scale Number <optional>
 1.0 比例
style Cesium.LabelStyle <optional>
 Cesium.LabelStyle.FILL_AND_OUTLINE 字体样式
fillColor String | Cesium.Color <optional>
 Cesium.Color.WHITE 填充颜色
outlineColor String | Cesium.Color <optional>
 Cesium.Color.BLACK 外边框颜色
outlineWidth Number <optional>
 1.0 外边框宽度
horizontalOrigin Cesium.HorizontalOrigin <optional>
 Cesium.HorizontalOrigin.CENTER 水平对齐方式
verticalOrigin Cesium.VerticalOrigin <optional>
 Cesium.VerticalOrigin.BOTTOM 垂直对齐方式
eyeOffset Cesium.Cartesian3 <optional>
 new Cesium.Cartesian3(0.0,0.0,0.0) 标注偏移值,单位:米 默认不偏移
pixelOffset Cesium.Cartesian2 <optional>
 new Cesium.Cartesian2(0.0,0.0) 标注偏移值,单位:像素 默认不偏移
showBackground Boolean <optional>
 false 是否显示背景 默认不显示
backgroundColor String | Cesium.Color <optional>
 rgba(0.165, 0.165, 0.165, 0.8) 背景色

setLabelVisibleByDistance( [near] [, far])

通过距离控制标注显隐
Parameters:
Name Type Argument Default Description
near Number <optional>
 0.0 相机范围的下限值
far Number <optional>
 Number.MAX_VALUE 相机范围的上限

setStyle(styleJson)

设置样式Json
Parameters:
Name Type Description
styleJson Object 样式Json

setVisibleByDistance( [near] [, far])

通过距离控制entity显隐
Parameters:
Name Type Argument Default Description
near Number <optional>
 0.0
far Number <optional>
 Number.MAX_VALUE

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);
})

LOADED

数据加载完成后触发
Example
layer.on(Glodon.CIMCube.Global.Defines.LayerEventType.LOADED, function (event) {
 console.log(event);
})