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 指向屏幕。 眼睛坐标使用与世界和模型坐标相同的比例。 通常为 meters。

眼图偏移通常用于将多个标签或对象排列在同一位置，例如，将 将标签排列在相应的 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;

获取或设置uniform scale，该比例乘以标签的大小(以像素为单位)。 比例为 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;

获取或设置vertical origin 的 Origin，用于确定标签是否为 拖动到其锚点位置的上方、下方或中心。

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	Cartesian3 指定在眼坐标中应用于此标签的 3D 笛卡尔偏移量。
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>		一个数字，用于指定与摄像机的距离，在该距离处禁用深度测试，例如，防止针对地形进行裁剪。