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

获取和设置应用于该标签的 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);

标签的原点由黄色点表示。

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:

// 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>		指定距离相机的距离，在此处禁用深度测试，以防止与地形剪裁。