Name | Type | Description |
---|---|---|
options |
LabelGraphics.ConstructorOptions | optional 描述初始化选项的对象 |
Members
backgroundColor : Property|undefined
获取或设置指定背景
Color
的属性。
-
Default Value:
new Color(0.165, 0.165, 0.165, 0.8)
backgroundPadding : Property|undefined
获取或设置
Cartesian2
指定标签的 horizontal 和 vertical 的属性
background padding in pixels.
-
Default Value:
new Cartesian2(7, 5)
readonly definitionChanged : Event
获取在更改或修改属性或子属性时引发的事件。
disableDepthTestDistance : Property|undefined
获取或设置与摄像机的距离,以禁用深度测试,以防止根据地形进行裁剪。
当设置为零时,始终应用深度测试。设置为 Number.POSITIVE_INFINITY 时,从不应用深度测试。
distanceDisplayCondition : Property|undefined
获取或设置
DistanceDisplayCondition
指定此标签将在距摄像机多远处显示的属性。
eyeOffset : Property|undefined
获取或设置
Cartesian3
指定标签在眼睛坐标中的偏移量的属性。
眼睛坐标是左手坐标系,其中 x
指向查看者的
向右,Y
指向上方,Z
指向屏幕。
眼图偏移通常用于将多个标签或对象排列在同一位置,例如,将 将标签排列在相应的 3D 模型上方。
在下图中,标签位于地球的中心,但眼睛偏移使其始终 显示在地球顶部,无论观看者或地球的方向如何。
![]() |
![]() |
l.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);
-
Default Value:
Cartesian3.ZERO
fillColor : Property|undefined
获取或设置指定填充
Color
的属性。
font : Property|undefined
获取或设置string 属性,用于指定 CSS 语法中的字体。
See:
heightReference : Property|undefined
获取或设置指定
HeightReference
的属性。
-
Default Value:
HeightReference.NONE
horizontalOrigin : Property|undefined
获取或设置指定
HorizontalOrigin
的属性。
outlineColor : Property|undefined
获取或设置指定轮廓
Color
的属性。
outlineWidth : Property|undefined
获取或设置numeric 指定轮廓宽度的属性。
pixelOffset : Property|undefined
获取或设置
标签的原点由黄点指示。
Cartesian2
指定标签在屏幕空间中的像素偏移量的属性
来自此标签的原点。 这通常用于对齐多个标签和
相同的位置,例如,图像和文本。 屏幕空间原点是
canvas; x
从左到右增加,以及 y
从上到下增加。
default ![]() |
l.pixeloffset = new Cartesian2(25, 75); ![]() |
-
Default Value:
Cartesian2.ZERO
pixelOffsetScaleByDistance : Property|undefined
获取或设置
NearFarScalar
属性,根据与相机的距离指定标签的像素偏移量。
标签的像素偏移量将在 NearFarScalar#nearValue
和
NearFarScalar#farValue
当摄像机距离落在下限和上限内时
指定的 NearFarScalar#near
和 NearFarScalar#far
的 。
在这些范围之外,标签的像素偏移量将保持限制在最近的边界上。
scale : Property|undefined
获取或设置numeric 指定要应用于图像的统一缩放的属性。
大于

在上图中,比例尺从左到右依次为
1.0
的比例会放大标签,而小于 1.0
的比例会缩小标签。

在上图中,比例尺从左到右依次为
0.5
, 1.0
,
和 2.0
.
-
Default Value:
1.0
scaleByDistance : Property|undefined
根据标签与相机的距离获取或设置 Label 的近距和远距缩放属性。
标签的比例将在
NearFarScalar#nearValue
和
NearFarScalar#farValue
当摄像机距离落在下限和上限内时
指定的 NearFarScalar#near
和 NearFarScalar#far
的 。
超出这些范围时,标签的刻度将保持限制为最近的边界。 如果未定义,则
scaleByDistance 将被禁用。
show : Property|undefined
获取或设置boolean 指定标签可见性的属性。
showBackground : Property|undefined
获取或设置boolean 属性,用于指定标签后面背景的可见性。
-
Default Value:
false
style : Property|undefined
获取或设置指定
LabelStyle
的属性。
text : Property|undefined
获取或设置string 属性,用于指定标签的文本。
支持显式换行符 '\n'。
translucencyByDistance : Property|undefined
获取或设置
NearFarScalar
属性,根据与摄像机的距离指定标签的半透明性。
标签的半透明性将在 NearFarScalar#nearValue
和
NearFarScalar#farValue
当摄像机距离落在下限和上限内时
指定的 NearFarScalar#near
和 NearFarScalar#far
的。
在这些范围之外,标签的半透明性仍然被限制在最近的边界上。
verticalOrigin : Property|undefined
获取或设置指定
VerticalOrigin
的属性。
Methods
clone(result) → LabelGraphics
复制实例。
Name | Type | Description |
---|---|---|
result |
LabelGraphics | optional 要在其上存储结果的对象。 |
Returns:
修改后的结果参数或者一个新实例(如果未提供)。
将此对象上每个未分配的属性分配给值
的 API 值。
Name | Type | Description |
---|---|---|
source |
LabelGraphics | 要合并到此对象中的对象。 |
Type Definitions
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 属性,用于根据与摄像机的距离设置 pixelOffset。 |
|
scaleByDistance |
Property | NearFarScalar |
<optional> |
一个 NearFarScalar 属性,用于根据与摄像机的距离设置缩放。 |
|
distanceDisplayCondition |
Property | DistanceDisplayCondition |
<optional> |
一个属性,指定在距相机多远处显示此标签。 | |
disableDepthTestDistance |
Property | number |
<optional> |
一个属性,用于指定要禁用深度测试的摄像头的距离。 |