标签绘制定位在三维场景中的与视口对齐的文本。此构造函数
不应直接使用,而是通过调用
LabelCollection#add
创建标签。Throws:
-
DeveloperError :translucencyByDistance.far公司必须大于translucencyByDistance.近
-
DeveloperError :像素ffsetScaleByDistance.far距离必须大于pixelOffsetScaleByDistance.近
-
DeveloperError :距离取消显示条件.far必须大于距离取消显示条件。接近
Members
确定是否运行将标签文本与从右向左语言匹配的算法
-
Default Value:
false
Examples:
// Example 1.
// Set a label's rightToLeft before init
Cesium.Label.enableRightToLeftDetection = true;
var myLabelEntity = viewer.entities.add({
label: {
id: 'my label',
text: 'זה טקסט בעברית \n ועכשיו יורדים שורה',
}
});
// Example 2.
var myLabelEntity = viewer.entities.add({
label: {
id: 'my label',
text: 'English text'
}
});
// Set a label's rightToLeft after init
Cesium.Label.enableRightToLeftDetection = true;
myLabelEntity.text = 'טקסט חדש';
backgroundColor : Color
获取或设置此标签的背景色。
-
Default Value:
new Color(0.165, 0.165, 0.165, 0.8)
backgroundPadding : Cartesian2
获取或设置此标签的背景填充(以pi
x
els为单位)。x值
控制水平填充,y
值控制垂直填充。-
Default Value:
new Cartesian2(7, 5)
获取或设置与摄影机的距离,在该距离处禁用深度测试,以防止针对地形进行剪裁。
设置为零时,始终应用深度测试。设置为时数正无穷大,则不应用深度测试。
distanceDisplayCondition : DistanceDisplayCondition
获取或设置一个条件,该条件指定此标签将显示在距摄像机的距离。
-
Default Value:
undefined
eyeOffset : Cartesian3
66668171
获取并设置应用于该标签的E61668166E坐标中的三维笛卡尔偏移。眼睛坐标是左手 坐标系,其中
x
指向观众的右侧,y点向上,以及
z
点进入屏幕。眼睛坐标使用与世界坐标和模型坐标相同的比例,
通常是米。
眼睛偏移通常用于将多个标签或对象排列在同一位置,例如
在相应的三维模型上方排列标签。
下面,标签位于地球的中心,但眼睛偏移使其始终
无论观众或地球的方位如何,都会出现在地球的顶部。
![]() |
![]() |
l.eyeOffset = new Cartesian3(0.0, 8000000.0, 0.0);
-
Default Value:
Cartesian3.ZERO
fillColor : Color
获取或设置此标签的填充颜色。
-
Default Value:
Color.WHITE
See:
获取或设置用于绘制此标签的字体。使用与CSS“font”属性相同的语法指定字体。
-
Default Value:
'30px sans-serif'
See:
heightReference : HeightReference
获取或设置此公告牌的高度引用。
-
Default Value:
HeightReference.NONE
horizontalOrigin : HorizontalOrigin
获取或设置此标签的水平原点,它决定是否绘制标签 在其锚定位置的左侧、中心或右侧。

-
Default Value:
HorizontalOrigin.LEFT
Example:
// Use a top, right origin
l.horizontalOrigin = Cesium.HorizontalOrigin.RIGHT;
l.verticalOrigin = Cesium.VerticalOrigin.TOP;
获取或设置拾取标签时返回的用户定义值。
outlineColor : Color
获取或设置此标签的大纲颜色。
-
Default Value:
Color.BLACK
See:
获取或设置此标签的大纲宽度。
-
Default Value:
1.0
See:
pixelOffset : Cartesian2
1666像素的标签从这个屏幕的原点偏移。这是常见的
y
在同一位置对齐多个标签和广告牌,如图像和文本。这个
屏幕空间原点是画布的左上角;x从
从右到下,从右到下依次递增。
default ![]() |
l.pixeloffset = new Cartesian2(25, 75); ![]() |
-
Default Value:
Cartesian2.ZERO
pixelOffsetScaleByDistance : NearFarScalar
获取或设置基于标签与相机的距离的标签的近像素和远像素偏移缩放属性。
标签的像素偏移将在
NearFarScalar#nearValue
和
NearFarScalar#farValue
,摄像机距离在上下限范围内
指定的NearFarScalar#near
和NearFarScalar#far
。
在这些范围之外,标签的像素偏移缩放保持为最近的边界。如果未定义,
pixelOffsetScaleByDistance将被禁用。Examples:
// Example 1.
// Set a label's pixel offset scale to 0.0 when the
// camera is 1500 meters from the label and scale pixel offset to 10.0 pixels
// in the y direction the camera distance approaches 8.0e6 meters.
text.pixelOffset = new Cesium.Cartesian2(0.0, 1.0);
text.pixelOffsetScaleByDistance = new Cesium.NearFarScalar(1.5e2, 0.0, 8.0e6, 10.0);
// Example 2.
// disable pixel offset by distance
text.pixelOffsetScaleByDistance = undefined;
position : Cartesian3
获取或设置此标签的笛卡尔位置。
获取或设置与标签大小(以像素为单位)相乘的统一比例。 比例尺
1.0
不会改变标签的大小;比例尺大于
1.0
放大标签;小于1.0
的正刻度缩小
标签。
应用大比例值可能会使标签像素化。要使文本变大而不使用像素,
在调用Label#font
时请改用较大的字体。

From left to right in the above image, the scales are
0.5
, 1.0
,
and 2.0
.
-
Default Value:
1.0
scaleByDistance : NearFarScalar
获取或设置基于标签与摄影机的距离的标签的近缩放和远缩放属性。
标签的刻度将在
NearFarScalar#nearValue
和
NearFarScalar#farValue
,摄像机距离在上下限范围内
指定的NearFarScalar#near
和NearFarScalar#far
。
在这些范围之外,标签的刻度保持在最近的范围内。如果未定义,
scaleByDistance将被禁用。Examples:
// Example 1.
// Set a label's scaleByDistance to scale by 1.5 when the
// camera is 1500 meters from the label and disappear as
// the camera distance approaches 8.0e6 meters.
label.scaleByDistance = new Cesium.NearFarScalar(1.5e2, 1.5, 8.0e6, 0.0);
// Example 2.
// disable scaling by distance
label.scaleByDistance = undefined;
确定是否显示此标签。使用此选项可以隐藏或显示标签
删除并重新添加到集合中。
-
Default Value:
true
确定是否显示此标签后面的背景。
-
Default Value:
false
style : LabelStyle
获取或设置此标签的样式。
-
Default Value:
LabelStyle.FILL
获取或设置此标签的文本。
获取标签的总比例,即标签的比例乘以计算的相对大小
所需字体与生成的字形大小相比。
-
Default Value:
1.0
translucencyByDistance : NearFarScalar
获取或设置基于标签与摄影机的距离的标签的近半透明和远半透明属性。
标签的半透明性将在
NearFarScalar#nearValue
和
NearFarScalar#farValue
,摄像机距离在上下限范围内
指定的NearFarScalar#near
和NearFarScalar#far
。
在这些范围之外,标签的半透明性将保持钳制到最近的边界。如果未定义,
半透明ByDistance将被禁用。Examples:
// Example 1.
// Set a label's translucencyByDistance to 1.0 when the
// camera is 1500 meters from the label and disappear as
// the camera distance approaches 8.0e6 meters.
text.translucencyByDistance = new Cesium.NearFarScalar(1.5e2, 1.0, 8.0e6, 0.0);
// Example 2.
// disable translucency by distance
text.translucencyByDistance = undefined;
verticalOrigin : VerticalOrigin
获取或设置此标签的垂直原点,它确定标签是否 在其锚位置的上方、下方或中心。

-
Default Value:
VerticalOrigin.BASELINE
Example:
// Use a top, right origin
l.horizontalOrigin = Cesium.HorizontalOrigin.RIGHT;
l.verticalOrigin = Cesium.VerticalOrigin.TOP;
Methods
computeScreenSpacePosition(scene, result) → Cartesian2
计算标签原点的屏幕空间位置,同时考虑E
y
6E和pix
el偏移。
屏幕空间原点是画布的左上角;x从
从右到下,从右到下依次递增。Name | Type | Description |
---|---|---|
scene |
Scene | 标签所在的场景。 |
result |
Cartesian2 | optional 要将结果存储到的对象。 |
Returns:
标签的屏幕空间位置。
Example:
console.log(l.computeScreenSpacePosition(scene).toString());
See:
确定此标签是否等于另一个标签。如果标签的所有属性都相同
是平等的。不同集合中的标签可以相等。
Name | Type | Description |
---|---|---|
other |
Label | 要比较的标签是否相等。 |
Returns:
如果标签相等,则为
true
;否则为false
。Returns:
如果此对象被销毁,则为True;否则为false。