LabelGraphics

new Cesium.LabelGraphics(options)

engine/Source/DataSources/LabelGraphics.js 51

描述一个位于其所包含的 Entity 位置的二维标签。

示例标签

Name	Type	Description
options	LabelGraphics.ConstructorOptions	optional 描述初始化选项的对象。

Demo:

• Cesium Sandcastle Labels Demo

Members

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

Default Value: new Cartesian2(7, 5)

获取或设置指定标签在视点坐标系中的偏移的 Cartesian3 Property。 视点坐标系是一个左手坐标系，其中 x 指向观察者 右侧，y 指向上方，z 指向屏幕内部。

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

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

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

Default Value: Cartesian3.ZERO

See:

• CSS font on MDN

Default Value: HeightReference.NONE

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

default

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

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

Default Value: Cartesian2.ZERO

获取或设置指定应用于图像的统一缩放的数值 Property。 大于 1.0 的缩放会放大标签，而小于 1.0 的缩放会缩小标签。

在上图中从左到右，缩放分别为 0.5、1.0、 和 2.0。

Default Value: 1.0

Default Value: false

Methods

Returns:

Type Definitions

Properties:

Name	Type	Attributes	Default	Description
show	Property | boolean	<optional>	true	指定标签可见性的布尔 Property。
text	Property | string	<optional>		指定文本的 Property。支持显式换行符 '\n'。
font	Property | string	<optional>	'30px sans-serif'	指定 CSS 字体的 Property。
style	Property | LabelStyle	<optional>	LabelStyle.FILL	指定 LabelStyle 的 Property。
scale	Property | number	<optional>	1.0	指定应用于文本的缩放的数值 Property。
showBackground	Property | boolean	<optional>	false	指定标签背后背景可见性的布尔 Property。
backgroundColor	Property | Color	<optional>	new Color(0.165, 0.165, 0.165, 0.8)	指定背景 Color 的 Property。
backgroundPadding	Property | Cartesian2	<optional>	new Cartesian2(7, 5)	指定水平和垂直背景内边距（以像素为单位）的 Cartesian2 Property。
pixelOffset	Property | Cartesian2	<optional>	Cartesian2.ZERO	指定像素偏移的 Cartesian2 Property。
eyeOffset	Property | Cartesian3	<optional>	Cartesian3.ZERO	指定视点偏移的 Cartesian3 Property。
horizontalOrigin	Property | HorizontalOrigin	<optional>	HorizontalOrigin.CENTER	指定 HorizontalOrigin 的 Property。
verticalOrigin	Property | VerticalOrigin	<optional>	VerticalOrigin.CENTER	指定 VerticalOrigin 的 Property。
heightReference	Property | HeightReference	<optional>	HeightReference.NONE	指定高度所相对对象的 Property。
fillColor	Property | Color	<optional>	Color.WHITE	指定填充 Color 的 Property。
outlineColor	Property | Color	<optional>	Color.BLACK	指定描边 Color 的 Property。
outlineWidth	Property | number	<optional>	1.0	指定描边宽度的数值 Property。
translucencyByDistance	Property | NearFarScalar	<optional>		用于根据距相机的距离设置透明度的 NearFarScalar Property。
pixelOffsetScaleByDistance	Property | NearFarScalar	<optional>		用于根据距相机的距离设置 pixelOffset 的 NearFarScalar Property。
scaleByDistance	Property | NearFarScalar	<optional>		用于根据距相机的距离设置缩放的 NearFarScalar Property。
distanceDisplayCondition	Property | DistanceDisplayCondition	<optional>		指定此标签将在距相机多远处显示的 Property。
disableDepthTestDistance	Property | number	<optional>		指定从相机的距离、在该距离处禁用深度测试的 Property。