Label

Members

Default Value: false

Examples:

// Example 1.
// Set a label's rightToLeft before init
Cesium.Label.enableRightToLeftDetection = true;
const myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: 'זה טקסט בעברית \n ועכשיו יורדים שורה',
  }
});

// Example 2.
const myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: 'English text'
  }
});
// Set a label's rightToLeft after init
Cesium.Label.enableRightToLeftDetection = true;
myLabelEntity.text = 'טקסט חדש';

Default Value: new Color(0.165, 0.165, 0.165, 0.8)

Default Value: new Cartesian2(7, 5)

Default Value: undefined

Default Value: undefined

获取并设置应用于此标签视点坐标系中的 3D 笛卡尔偏移。视点坐标系是一个左手坐标系， 其中 x 指向观察者右侧，y 指向上方， z 指向屏幕内部。视点坐标系使用与世界和模型坐标相同的比例， 通常为米。

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

下图中，标签位于地球中心，但视点偏移使其始终 显示在地球上方，无论观察者与地球的朝向如何。

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

Default Value: Cartesian3.ZERO

Default Value: Color.WHITE

See:

• HTML canvas 2D context fill and stroke styles

Default Value: '30px sans-serif'

See:

• HTML canvas 2D context text styles

Default Value: HeightReference.NONE

获取或设置此标签的水平原点，它决定标签是绘制在其锚点位置的左侧、中心还是右侧。

Default Value: HorizontalOrigin.LEFT

Example:

// Use a top, right origin
l.horizontalOrigin = Cesium.HorizontalOrigin.RIGHT;
l.verticalOrigin = Cesium.VerticalOrigin.TOP;

Default Value: Color.BLACK

See:

• HTML canvas 2D context fill and stroke styles

Default Value: 1.0

See:

• HTML canvas 2D context fill and stroke styles

获取或设置此标签屏幕空间中相对于其原点的像素偏移。这通常用于 在同一位置对齐多个标签和广告牌，例如图像和文本。 屏幕空间的原点是画布的左上角；x 从 左向右递增，y 从上向下递增。

default

l.pixeloffset = new Cartesian2(25, 75);

The label's origin is indicated by the yellow point.

Default Value: Cartesian2.ZERO

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;

获取或设置与标签像素大小相乘的统一缩放。 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

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

Default Value: LabelStyle.FILL

Default Value: 1.0

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;

获取或设置此标签的垂直线原点，它决定标签位于 其锚点位置的上方、下方还是中心。

Default Value: VerticalOrigin.BASELINE

Example:

// Use a top, right origin
l.horizontalOrigin = Cesium.HorizontalOrigin.RIGHT;
l.verticalOrigin = Cesium.VerticalOrigin.TOP;

Methods

Returns:

Example:

console.log(l.computeScreenSpacePosition(scene).toString());

See:

• Label#eyeOffset
• Label#pixelOffset

Returns:

Returns:

Type Definitions

Properties:

Name	Type	Attributes	Default	Description
position	Cartesian3			标签的笛卡尔坐标位置。
id	*	<optional>		当标签被 Scene#pick 拾取时返回的用户定义对象。
show	boolean	<optional>	true	确定此标签是否显示。
text	string	<optional>		指定标签文本的字符串。
font	string	<optional>	'30px sans-serif'	指定用于绘制此标签的字体的字符串。字体使用与 CSS 'font' 属性相同的语法指定。
style	LabelStyle	<optional>	LabelStyle.FILL	指定标签样式的 LabelStyle。
scale	number	<optional>	1.0	指定与标签大小相乘的统一缩放的数值。
showBackground	boolean	<optional>	false	确定此标签背后的背景是否显示。
backgroundColor	Color	<optional>	new Color(0.165, 0.165, 0.165, 0.8)	指定标签背景颜色的 Color。
backgroundPadding	Cartesian2	<optional>	new Cartesian2(7, 5)	指定水平和垂直背景内边距（以像素为单位）的 Cartesian2。
pixelOffset	Cartesian2	<optional>	Cartesian2.ZERO	指定此标签屏幕空间中相对于其原点像素偏移的 Cartesian2。
eyeOffset	Cartesian3	<optional>	Cartesian3.ZERO	指定在视点坐标系中应用于此标签的 3D 笛卡尔偏移的 Cartesian3。
horizontalOrigin	HorizontalOrigin	<optional>	HorizontalOrigin.LEFT	指定此标签水平原点的 HorizontalOrigin。
verticalOrigin	VerticalOrigin	<optional>	VerticalOrigin.BASELINE	指定此标签垂直线原点的 VerticalOrigin。
heightReference	HeightReference	<optional>	HeightReference.NONE	指定此标签高度参考的 HeightReference。
fillColor	Color	<optional>	Color.WHITE	指定标签填充颜色的 Color。
outlineColor	Color	<optional>	Color.BLACK	指定标签描边颜色的 Color。
outlineWidth	number	<optional>	1.0	指定标签描边宽度的数值。
translucencyByDistance	NearFarScalar	<optional>		指定基于标签距相机距离的近远透明度属性的 NearFarScalar。
pixelOffsetScaleByDistance	NearFarScalar	<optional>		指定基于标签距相机距离的近远像素偏移缩放属性的 NearFarScalar。
scaleByDistance	NearFarScalar	<optional>		指定基于标签距相机距离的近远缩放属性的 NearFarScalar。
distanceDisplayCondition	DistanceDisplayCondition	<optional>		指定此标签将在距相机多远处显示的 DistanceDisplayCondition。
disableDepthTestDistance	number	<optional>		从相机的距离，超过该距离后禁用深度测试——例如，防止被地形裁剪。