LabelGraphics

new Cesium.LabelGraphics(options)

描述位于包含 Entity 位置的二维标签。


标签示例

Name Type Description
options LabelGraphics.ConstructorOptions optional 描述初始化选项的对象
Demo:

Members

获取或设置指定背景 Color 的属性。
Default Value: new Color(0.165, 0.165, 0.165, 0.8)
获取或设置指定标签水平和垂直背景填充(像素)的 Cartesian2 属性。
Default Value: new Cartesian2(7, 5)
获取每当属性或子属性更改或修改时引发的事件。

disableDepthTestDistance : Property|undefined

获取或设置距离相机多远时禁用深度测试,例如防止与地形裁剪。 设置为零时始终应用深度测试。设置为Number.POSITIVE_INFINITY时从不应用深度测试。

distanceDisplayCondition : Property|undefined

获取或设置指定标签在距离相机多远时显示的 DistanceDisplayCondition 属性。
获取或设置指定标签在眼坐标中偏移的 Cartesian3 属性。 眼坐标是左手坐标系,其中 x 指向观察者的右侧,y 指向上方,z 指向屏幕内。

眼偏移通常用于在同一位置排列多个标签或对象,例如将标签排列在其对应的3D模型上方。

下面,标签位于地球中心,但眼偏移使其始终显示在地球顶部,无论观察者或地球的朝向如何。

l.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);

Default Value: Cartesian3.ZERO
获取或设置指定填充 Color 的属性。
获取或设置指定CSS语法字体的字符串属性。
See:
获取或设置指定 HeightReference 的属性。
Default Value: HeightReference.NONE
获取或设置指定 HorizontalOrigin 的属性。
获取或设置指定轮廓 Color 的属性。
获取或设置指定轮廓宽度的数值属性。
获取或设置指定标签在屏幕空间中相对于标签原点的像素偏移的 Cartesian2 属性。 这通常用于对齐多个标签和同一位置的标签,例如图像和文本。屏幕空间原点是画布的左上角; x 从左向右增加,y 从上向下增加。

默认
l.pixeloffset = new Cartesian2(25, 75);
标签的原点由黄点指示。

Default Value: Cartesian2.ZERO

pixelOffsetScaleByDistance : Property|undefined

获取或设置根据与相机距离指定标签像素偏移的 NearFarScalar 属性。 当相机距离在指定的 NearFarScalar#nearNearFarScalar#far 的上下界内时, 标签的像素偏移将在 NearFarScalar#nearValueNearFarScalar#farValue 之间插值。 在这些范围之外,标签的像素偏移保持钳位到最近的边界。
获取或设置指定应用于图像的均匀缩放的数值属性。 大于 1.0 的缩放会放大标签,小于 1.0 的缩放会缩小标签。


上图中从左到右的缩放分别为 0.51.02.0

Default Value: 1.0
获取或设置基于标签与相机距离的远近缩放属性。 当相机距离在指定的 NearFarScalar#nearNearFarScalar#far 的上下界内时, 标签的缩放将在 NearFarScalar#nearValueNearFarScalar#farValue 之间插值。 在这些范围之外,标签的缩放保持钳位到最近的边界。如果未定义,scaleByDistance将被禁用。
获取或设置指定标签可见性的布尔属性。
获取或设置指定标签背景可见性的布尔属性。
Default Value: false
获取或设置指定 LabelStyle 的属性。
获取或设置指定标签文本的字符串属性。 支持显式换行符'\n'。

translucencyByDistance : Property|undefined

获取或设置根据与相机距离指定标签透明度的 NearFarScalar 属性。 当相机距离在指定的 NearFarScalar#nearNearFarScalar#far 的上下界内时, 标签的透明度将在 NearFarScalar#nearValueNearFarScalar#farValue 之间插值。 在这些范围之外,标签的透明度保持钳位到最近的边界。
获取或设置指定 VerticalOrigin 的属性。

Methods

复制此实例。
Name Type Description
result LabelGraphics optional 存储结果的对象。
Returns:
修改后的结果参数,如果未提供则返回新实例。
将此对象上每个未赋值的属性分配给提供的源对象上相同属性的值。
Name Type Description
source LabelGraphics 要合并到此对象中的对象。

Type Definitions

Cesium.LabelGraphics.ConstructorOptions

LabelGraphics构造函数的初始化选项
Properties:
Name Type Attributes Default Description
show Property | boolean <optional>
true 指定标签可见性的布尔属性。
text Property | string <optional>
指定文本的属性。支持显式换行符'\n'。
font Property | string <optional>
'30px sans-serif' 指定CSS字体的属性。
style Property | LabelStyle <optional>
LabelStyle.FILL 指定 LabelStyle 的属性。
scale Property | number <optional>
1.0 指定应用于文本的比例的数值属性。
showBackground Property | boolean <optional>
false 指定标签背景可见性的布尔属性。
backgroundColor Property | Color <optional>
new Color(0.165, 0.165, 0.165, 0.8) 指定背景 Color 的属性。
backgroundPadding Property | Cartesian2 <optional>
new Cartesian2(7, 5) 指定水平和垂直背景填充(像素)的 Cartesian2 属性。
pixelOffset Property | Cartesian2 <optional>
Cartesian2.ZERO 指定像素偏移的 Cartesian2 属性。
eyeOffset Property | Cartesian3 <optional>
Cartesian3.ZERO 指定眼偏移的 Cartesian3 属性。
horizontalOrigin Property | HorizontalOrigin <optional>
HorizontalOrigin.CENTER 指定 HorizontalOrigin 的属性。
verticalOrigin Property | VerticalOrigin <optional>
VerticalOrigin.CENTER 指定 VerticalOrigin 的属性。
heightReference Property | HeightReference <optional>
HeightReference.NONE 指定高度相对参照的属性。
fillColor Property | Color <optional>
Color.WHITE 指定填充 Color 的属性。
outlineColor Property | Color <optional>
Color.BLACK 指定轮廓 Color 的属性。
outlineWidth Property | number <optional>
1.0 指定轮廓宽度的数值属性。
translucencyByDistance Property | NearFarScalar <optional>
用于根据与相机距离设置透明度的 NearFarScalar 属性。
pixelOffsetScaleByDistance Property | NearFarScalar <optional>
用于根据与相机距离设置像素偏移的 NearFarScalar 属性。
scaleByDistance Property | NearFarScalar <optional>
用于根据与相机距离设置缩放的 NearFarScalar 属性。
distanceDisplayCondition Property | DistanceDisplayCondition <optional>
指定标签在距离相机多远时显示的属性。
disableDepthTestDistance Property | number <optional>
指定距离相机多远时禁用深度测试的属性。
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.