CIMCubeSDK v3.34.0

Class: LabelGraphic

Glodon.CIMCube.Graphic. LabelGraphic

文本图形

new LabelGraphic(opts)

文本图形构造函数
Parameters:
Name Type Description
opts Object 配置参数
Properties
Name Type Argument Default Description
name String <optional>
 名称
position Array 文本地理坐标，必填
text String <optional>
 '' 文本
font String <optional>
 '30px sans-serif' 字体
scale Number <optional>
 1.0 比例
fillColor string <optional>
 'white' 字体颜色
outlineColor string <optional>
 'black' 边界颜色
outlineWidth Number <optional>
 1.0 边界勾绘粗度（单位像素）
style Glodon.CIMCube.Graphic.LabelStyle <optional>
 Glodon.CIMCube.Graphic.LabelStyle.FILL 注记样式
showBackground Boolean <optional>
 false 是否显示背景
backgroundColor string <optional>
 'rgba(42,42,42,0.8)' 背景颜色
backgroundPadding Array <optional>
 [7,5] 缩进尺寸（单位像素）
pixelOffset Array | Glodon.CIMCube.Graphic.TwoDimensionPoint <optional>
 [0,0] 注记偏移值（单位像素）
horizontalOrigin Glodon.CIMCube.Graphic.HorizontalOrigin <optional>
 Glodon.CIMCube.Graphic.HorizontalOrigin.CENTER 文本坐标点与文本框水平相对位置
verticalOrigin Glodon.CIMCube.Graphic.VerticalOrigin <optional>
 Glodon.CIMCube.Graphic.VerticalOrigin.CENTER 文本坐标点与文本框垂直相对位置
heightReference Glodon.CIMCube.Graphic.HeightReference <optional>
 Glodon.CIMCube.Graphic.HeightReference.NONE 坐标高度模式
distanceDisplayCondition Array <optional>
 视距显示，格式为[near, far]
scaleByDistance Array <optional>
 视距缩放，格式为[near, nearValue, far, farValue]
translucencyByDistance Array <optional>
 视距透明度，格式为[near, nearValue, far, farValue]
pixelOffsetScaleByDistance Array <optional>
 视距像素偏移，格式为[near, nearValue, far, farValue]
disableDepthTest boolean <optional>
 false 是否禁用深度测试
style LabelStyleOptions <optional>
 样式选项（优先级高于其他样式选项），参考：https://cimcube.glodon.com/openservice/user-guide/405?categoryId=2448&origin=homepage

Extends

Members

<readonly> cesiumEntity :Cesium.Entity

获取原生Entity
Type:
  • Cesium.Entity
Inherited From:
Overrides:

clampToGround :boolean

是否贴地（贴地形或模型）
Type:
  • boolean
Default Value:
  • false

disableDepthTest :boolean

禁用深度测试距离
Type:
  • boolean
Default Value:
  • false

distanceDisplayCondition :Array

视距显示，格式为[near, far]
Type:
  • Array

dynamic :Boolean

是否动态绘制
Type:
  • Boolean
Inherited From:
Overrides:

fillColor :Color

填充颜色
Type:
  • Color

heightReference :Glodon.CIMCube.Graphic.HeightReference

顶点坐标高度模式
Type:

horizontalOrigin :Number

文本坐标点与文本框水平相对位置
Type:
  • Number

<readonly> id :String

id
Type:
  • String
Inherited From:
Overrides:

<readonly> name :String

名称
Type:
  • String
Inherited From:
Overrides:

outlineColor :Color

边界颜色
Type:
  • Color

outlineWidth :Number

边界线宽，单位像素
Type:
  • Number

pixelOffsetScaleByDistance :Array

视距像素偏移，格式为[near, nearValue, far, farValue]
Type:
  • Array

position :Array

顶点坐标
Type:
  • Array

scaleByDistance :Array

视距缩放，格式为[near, nearValue, far, farValue]
Type:
  • Array

show :Boolean

是否显示
Type:
  • Boolean
Inherited From:
Overrides:

showBackground :Number

是否显示背景
Type:
  • Number

translucencyByDistance :Array

视距透明度，格式为[near, nearValue, far, farValue]
Type:
  • Array

verticalOrigin :Number

文本坐标点与文本框垂直相对位置
Type:
  • Number

Methods

addProperty(key, value)

添加属性
Parameters:
Name Type Description
key Object 属性key值
value Object 属性值
Inherited From:
Overrides:
Returns:
Type
void

addToViewer(dataSource)

添加到视图
Parameters:
Name Type Description
dataSource Cesium.DataSource
Inherited From:
Overrides:
Returns:
Type
void

flyTo()

飞到图形
Inherited From:
Overrides:
Returns:
Type
void

getAllProperties()

获取所有属性
Inherited From:
Overrides:
Returns:
属性Map
Type
Map

getEntity()

获取原生Entity
Inherited From:
Overrides:
Returns:
原生Entity
Type
Cesium.Entity

getProperty(key)

通过key获取属性
Parameters:
Name Type Description
key Object 属性key值
Inherited From:
Overrides:
Returns:
属性值
Type
Object

removeProperty(key)

删除属性
Parameters:
Name Type Description
key Object 属性key值
Inherited From:
Overrides:
Returns:
Type
void

removeSelf(dataSource)

删除图形
Parameters:
Name Type Description
dataSource Cesium.DataSource
Inherited From:
Overrides:
Returns:
Type
void

setOptions(options)

设置选项
Parameters:
Name Type Description
options Object 样式选项
Properties
Name Type Argument Description
text String <optional>
 文本内容
font string <optional>
 字体（包含font_family、font_size、font_weight、font_style）
font_family String <optional>
 字体
font_size Number <optional>
 字体大小
font_weight String <optional>
 字体粗细
font_style String <optional>
 字体样式
color String <optional>
 字体颜色
scale String <optional>
 比例
pixelOffset Array <optional>
 偏移量
clampToGround Boolean <optional>
 是否贴地
distanceDisplayCondition Boolean <optional>
 可见范围
distanceDisplayCondition_far Number <optional>
 可见范围-最大值
distanceDisplayCondition_near Number <optional>
 可见范围-最小值
scaleByDistance Boolean <optional>
 视距缩放
scaleByDistance_near Number <optional>
 视距缩放-最小值
scaleByDistance_nearValue Number <optional>
 视距缩放-最小缩放系数
scaleByDistance_far Number <optional>
 视距缩放-最大值
scaleByDistance_farValue Number <optional>
 视距缩放-最大缩放系数
border Boolean <optional>
 是否衬色
border_color String <optional>
 衬色
border_width Number <optional>
 衬色的宽度
background Boolean <optional>
 是否有背景
background_color String <optional>
 背景色

setStyle(styleOptions)

设置样式
Parameters:
Name Type Description
styleOptions LabelStyleOptions 样式选项，参考：https://cimcube.glodon.com/openservice/user-guide/405?categoryIdId=2448&origin=homepage