new LabelGraphics(options)

绘制标签类

位置由 Entity定义。

Example labels

Name Type Description

options

Object

可选

Object 包含如下属性的对象:

Name	Type	Default	Description
`show`	Property	true	可选 boolean属性，指定标签的可见性。
`text`	Property		可选 string属性，指定标签的文本。换行符使用'\n'。
`font`	Property	'30px sans-serif'	可选指定 CSS 字体.
`style`	Property	LabelStyle.FILL	可选 `LabelStyle`属性。
`scale`	Property	1.0	可选 number属性，指定标签的缩放比例。
`showBackground`	Property	false	可选 boolean属性，指定标签背景是否显示显示。
`backgroundColor`	Property	new Color(0.165, 0.165, 0.165, 0.8)	可选 `Color`属性，指定标签背景颜色。
`backgroundPadding`	Property	new Cartesian2(7, 5)	可选 `Cartesian2`属性，指定标签水平方向与垂直方向的背景padding距离，单位像素。
`pixelOffset`	Property	Cartesian2.ZERO	可选 `Cartesian2`属性，指定像素偏移。
`eyeOffset`	Property	Cartesian3.ZERO	可选 `Cartesian3`属性，指定eye offset。
`horizontalOrigin`	Property	HorizontalOrigin.CENTER	可选 `HorizontalOrigin`属性。
`verticalOrigin`	Property	VerticalOrigin.CENTER	可选 `VerticalOrigin`属性。
`heightReference`	Property	HeightReference.NONE	可选 `HeightReference`属性，指定height的相对参考点。
`fillColor`	Property	Color.WHITE	可选 `Color`属性，指定标签的填充颜色。
`outlineColor`	Property	Color.BLACK	可选 `Color`属性，指定轮廓的颜色。
`outlineWidth`	Property	1.0	可选 number属性，指定轮廓的像素宽度。
`translucencyByDistance`	Property		可选 `NearFarScalar` 属性，用于根据标签到相机的距离修改标签的透明度。
`pixelOffsetScaleByDistance`	Property		可选 `NearFarScalar`属性，用于根据标签到相机的距离缩放标签的像素偏移。
`scaleByDistance`	Property		可选 `NearFarScalar`属性，用于根据标签到相机的距离缩放标签的大小。
`distanceDisplayCondition`	Property		可选 `DistanceDisplayCondition`属性，指定该标签在距离相机多远的位置显示。
`disableDepthTestDistance`	Property		可选 number属性，指定当标签到相机的距离小于指定值时关闭深度检测。

Members

backgroundColorProperty

获取或设置Color属性，指定标签背景颜色。

Default Value:

backgroundPaddingProperty

获取或设置Cartesian2属性，指定标签水平方向与垂直方向的背景padding距离，单位像素。

Default Value:

readonly definitionChangedEvent

获取事件。该事件在属性或者子属性的值被修改，或者定义被修改时被抛出。

disableDepthTestDistanceProperty

获取或设置标签与相机的距离，当标签到相机距离小于该距离时，要关闭深度检测。比如以次来防止被地形遮挡而裁掉。当值为0时，始终开启深度检测。当值为Number.POSITIVE_INFINITY，始终关闭深度检测。

distanceDisplayConditionProperty

获取或设置DistanceDisplayCondition属性，指定该标签在距离相机多远的位置显示。

eyeOffsetProperty

获取或设置一个Cartesian3属性，该属性指定标签在相机空间的偏移量。该相机空间是一个左手坐标系的空间。x轴指向观察者的右边，y轴指向观察者的上边，z指向屏幕内。

eyeOffset通常用于安排在同一个位置的多个标签，比如把一个标签放置到它对应模型的上边

下图显示，标签被放置地球的中心。但是eyeOffset可以让标签始终出现在地球的上方，无论观察者或这地球的姿态如何

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

Default Value:

fillColorProperty

获取或设置Color属性，指定填充颜色。

fontProperty

获取或设置string属性，指定标签的文本的字体信息，格式为CSS语法。

heightReferenceProperty

获取或设置HeightReference属性。

Default Value:

horizontalOriginProperty

获取或设置指定 HorizontalOrigin 的属性。

outlineColorProperty

获取或设置Color属性，指定轮廓的颜色。

outlineWidthProperty

获取或设置number属性，指定轮廓宽度。

pixelOffsetProperty

获取或设置 Cartesian2 属性。指定标签在屏幕空间中从该标签原点出发的像素偏移量。这通常用于将多个标签对齐到同一位置。屏幕空间的原点是画布的左上角；x 值从左到右递增，y 值从上到下递增。

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

标签原点为黄色点。

Default Value:

pixelOffsetScaleByDistanceProperty

获取或设置 NearFarScalar的值。该属性根据标签与相机的距离来指定标签的像素偏移。当相机到标签的距离NearFarScalar#near 和 NearFarScalar#far之间时，标签的像素偏移将在NearFarScalar#nearValue 和 NearFarScalar#farValue 之间插值当相机到标签的距离NearFarScalar#near 和 NearFarScalar#far之外，标签的像素偏移将为最近的那个值。

scaleProperty

获取或设置number属性，指定标签的缩放比例。该比例大于 1.0 会放大表亲啊，而比例小于 1.0 则会缩小标签。

上图从左到右，缩放比分别是0.5, 1.0, and 2.0.

Default Value:

scaleByDistanceProperty

获取或设置 NearFarScalar属性。该属性根据标签与相机的距离来指定标签的缩放比例。当相机到标签的距离NearFarScalar#near 和 NearFarScalar#far之间时，标签的缩放比例将在NearFarScalar#nearValue 和 NearFarScalar#farValue 之间插值当相机到标签的距离NearFarScalar#near 和 NearFarScalar#far之外，标签的缩放比例将为最近的那个值。如果未定义该属性，scaleByDistance属性将不起作用。

showProperty

获取或设置boolean属性，指定标签的可见性。

showBackgroundProperty

获取或设置boolean属性，指定标签背景是否显示。

Default Value:

styleProperty

获取或设置 LabelStyle属性。

textProperty

获取或设置string属性，指定标签的文本。换行符使用'\n'。

translucencyByDistanceProperty

获取或设置 NearFarScalar的值。该属性根据标签与相机的距离来指定标签的透明度。当相机到标签的距离NearFarScalar#near 和 NearFarScalar#far之间时，标签的透明度将在NearFarScalar#nearValue 和 NearFarScalar#farValue 之间插值当相机到标签的距离NearFarScalar#near 和 NearFarScalar#far之外，标签的透明度将为最近的那个值。

verticalOriginProperty

获取或设置指定 VerticalOrigin 的属性。

Methods

clone(result){LabelGraphics}

拷贝实例

Name	Type	Description
`result`	LabelGraphics	可选存储拷贝结果的对象.

Returns:

Type	Description
LabelGraphics	如果提供了输入参数，返回修改后的输入参数对象。如果没提供入参，返回一个新的实例。

merge(source)

为本实例所有未指定值的属性赋上source对象对应的属性值。

Name	Type	Description
`source`	LabelGraphics	提供属性值的对象。

Class: LabelGraphics