LabelEntity

文字 Entity对象

new mars3d.graphic.LabelEntity(options)

参数名称 类型 描述信息
options object

参数对象,包括以下:

参数名称 类型 默认值 描述信息
position LngLatPoint | Cesium.Cartesian3 | Cesium.PositionProperty | BaseGraphic.AjaxPosition | Array.<number> | string 可选

坐标位置

style LabelEntity.StyleOptions

样式信息

attr object | BaseGraphic.AjaxAttr 可选

附件的属性信息,可以任意附加属性,导出geojson或json时会自动处理导出。

availability Cesium.TimeIntervalCollection | Cesium.TimeInterval | Array | object 可选

指定时间范围内显示该对象

description Cesium.Property | string 可选

指定此实体的HTML描述的字符串属性(infoBox中展示)。

viewFrom Cesium.Property 可选

观察这个物体时建议的初始偏移量。

parent Cesium.Entity 可选

要与此实体关联的父实体。

onBeforeCreate function 可选

在 new Cesium.Entity(addattr) 前的回调方法,可以对addattr做额外个性化处理。

drawShow boolean true 可选

绘制时,是否自动隐藏entity,可避免拾取坐标存在问题。

hasEdit boolean true 可选

是否允许编辑

hasEditContextMenu boolean true 可选

编辑时,是否绑定右键编辑菜单

popup string | Array | function 可选

绑定的popup弹窗值,也可以bindPopup方法绑定

popupOptions Popup.StyleOptions 可选

popup弹窗时的配置参数,也支持如pointerEvents等Popup构造参数

tooltip string | Array | function 可选

绑定的tooltip弹窗值,也可以bindTooltip方法绑

tooltipOptions Tooltip.StyleOptions 可选

tooltip弹窗时的配置参数,也支持如pointerEvents等Tooltip构造参数

contextmenuItems object 可选

当矢量数据支持右键菜单时,也可以bindContextMenu方法绑定

id string | number createGuid() 可选

矢量数据id标识

name string '' 可选

矢量数据名称

show boolean true 可选

矢量数据是否显示

eventParent BaseClass | boolean 可选

指定的事件冒泡对象,默认为所加入的图层对象,false时不冒泡事件

allowDrillPick boolean | function 可选

是否允许鼠标穿透拾取

flyTo boolean 可选

加载完成数据后是否自动飞行定位到数据所在的区域。

flyToOptions object 可选

加载完成数据后是否自动飞行定位到数据所在的区域的对应 BaseGraphic#flyTo方法参数。 @extends {BasePointEntity}

参考:

成员(属性)

readonly entityGraphic : Cesium.LabelGraphics

矢量数据对应的 Cesium内部对象的具体类型对象

readonly text : string

文本内容

方法

setOpacity(value)void

设置透明度

参数名称 类型 描述信息
value number

透明度

返回值:

startBounce(options)void

开始执行弹跳动画

参数名称 类型 描述信息
options object 可选

参数,包括

参数名称 类型 默认值 描述信息
maxHeight number 50 可选

弹跳的最大高度, 单位:像素

step number 1 可选

弹跳增量, 控制速度,单位:像素

autoStop boolean 可选

是否自动停止,true时:会逐渐减弱至停止状态

返回值:

stopBounce()void

停止弹跳动画

返回值:

定义的类型

mars3d.graphic.LabelEntity.StyleOptions

文本点 支持的样式信息

属性:
属性名称 类型 可选 默认值 描述信息
text string <可选>
"文字"

文本内容,换行可以用换行符'\n'。

scale number <可选>
1.0

指定缩放比例。

horizontalOrigin Cesium.HorizontalOrigin <可选>

横向方向的定位

verticalOrigin Cesium.VerticalOrigin <可选>

垂直方向的定位

font_family string <可选>
"楷体"

字体 ,可选项:微软雅黑,宋体,楷体,隶书,黑体 等

font_size number <可选>
30

字体大小

font_weight string <可选>
"normal"

是否加粗 ,可选项:bold (解释:是),normal (解释:否),

font_style string <可选>
"normal"

是否斜体 ,可选项:italic (解释:是),normal (解释:否),

font string <可选>
'30px normal normal 楷体'

上叙4个属性的一次性指定CSS字体的属性。

fill boolean <可选>
true

是否填充

color string | Cesium.Color <可选>
"#ffffff"

文本颜色

opacity number <可选>
1.0

透明度,取值范围:0.0-1.0

outline boolean <可选>
false

是否衬色

outlineColor string | Cesium.Color <可选>
"#000000"

衬色颜色

outlineOpacity number <可选>
0.6

衬色透明度

outlineWidth number <可选>
2.0

衬色宽度

background boolean <可选>
false

是否背景

backgroundColor string | Cesium.Color <可选>
"#000000"

背景颜色

backgroundOpacity number <可选>
0.5

背景透明度

backgroundPadding number | Cesium.Cartesian2 <可选>
new Cesium.Cartesian2(7, 5)

背景内边距,指定文字与填充边界内容之间的空间(以像素为单位)。

hasPixelOffset boolean <可选>
false

是否存在偏移量

pixelOffsetX number <可选>
0

横向偏移像素

pixelOffsetY number <可选>
0

纵向偏移像素

pixelOffset Cesium.Cartesian2 | Array.<number> <可选>
Cartesian2.ZERO

A Cartesian2 Property specifying the pixel offset.

pixelOffsetScaleByDistance boolean | Cesium.NearFarScalar <可选>

用于基于与相机的距离设置pixelOffset。

pixelOffsetScaleByDistance_far number <可选>
1000000

上限

pixelOffsetScaleByDistance_farValue number <可选>
0.1

比例值

pixelOffsetScaleByDistance_near number <可选>
1000

下限

pixelOffsetScaleByDistance_nearValue number <可选>
1

比例值

eyeOffset Cesium.Cartesian3 <可选>
Cartesian3.ZERO

A Cartesian3 Property specifying the eye offset.

scaleByDistance boolean | Cesium.NearFarScalar <可选>
false

是否按视距缩放 或 设定基于与相机的距离设置比例。

scaleByDistance_far number <可选>
1000000

上限

scaleByDistance_farValue number <可选>
0.1

比例值

scaleByDistance_near number <可选>
1000

下限

scaleByDistance_nearValue number <可选>
1

比例值

distanceDisplayCondition boolean | Cesium.DistanceDisplayCondition <可选>
false

是否按视距显示 或 指定此框将显示在与摄像机的多大距离。

distanceDisplayCondition_far number <可选>
Number.MAX_VALUE

最大距离

distanceDisplayCondition_near number <可选>
0

最小距离

clampToGround boolean <可选>
false

是否贴地

heightReference Cesium.HeightReference <可选>
Cesium.HeightReference.NONE

指定高度相对于什么的属性。

visibleDepth boolean <可选>
true

是否被遮挡

disableDepthTestDistance number <可选>

指定从相机到禁用深度测试的距离。

translucencyByDistance Cesium.NearFarScalar <可选>

用于基于与相机的距离设置半透明度。

setHeight number | string <可选>

指定坐标高度值(对编辑时无效,仅初始化传入有效,常用于图层中配置),也支持字符串模版配置

addHeight number | string <可选>

在现有坐标基础上增加的高度值(对编辑时无效,仅初始化传入有效,常用于图层中配置),也支持字符串模版配置

templateEmptyStr string <可选>
""

当text存在模版字符串配置时,空值时显示的内容

highlight LabelEntity.StyleOptions <可选>

鼠标移入或单击(type:'click')后的对应高亮的部分样式,提示:原有style的配置项需要与highlightStyle配置有一一对应关系,否则无法清除 // * @param {string} [highlight.type] 事件方式,鼠标移入高亮 或 单击高亮(type:'click') // * @param {boolean} [highlight.enabled=true] 是否启用

参考:
  • Cesium.LabelGraphics.ConstructorOptions