Label

Members

Default Value: false

Examples:

// 示例 1。
// 在初始化前设置标签的 rightToLeft
Cesium.Label.enableRightToLeftDetection = true;
const myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: 'זה טקסט בעברית \n ועכשיו יורדים שורה',
  }
});

// 示例 2。
const myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: 'English text'
  }
});
// 在初始化后设置标签的 rightToLeft
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:

// 使用顶部、右侧原点
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

Gets or sets the pixel offset in screen space from the origin of this label. This is commonly used to align multiple labels and billboards at the same position, e.g., an image and text. The screen space origin is the top, left corner of the canvas; x increases from left to right, and y increases from top to bottom.

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 时使用更大的字体大小。

上图从左到右的缩放比例分别为 0.5、1.0 和 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:

// 使用顶部、右侧原点
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>		从相机到此距离之外，深度测试将被禁用——例如，防止与地形裁剪。