LabelGraphics

描述位于包含Entity位置的二维标签。


示例标签

new LabelGraphics(options)
Parameters:
options (Object)
Name Description
options.show
Property
default true
指定标签可见性的布尔属性。
options.text
Property
指定文本的属性。支持显式换行符'\n'。
options.font
Property
default '30px sans-serif'
指定CSS字体的属性。
options.style
Property
default LabelStyle.FILL
指定LabelStyle的属性。
options.scale
Property
default 1.0
指定要应用于文本的比例的数值属性。
options.showBackground
Property
default false
一个布尔属性,指定标签后面背景的可见性。
options.backgroundColor
Property
default new Color(0.165, 0.165, 0.165, 0.8)
指定背景Color的属性。
options.backgroundPadding
Property
default new Cartesian2(7, 5)
以像素为单位指定水平和垂直背景填充的Cartesian2属性。
options.pixelOffset
Property
default Cartesian2.ZERO
指定像素偏移的Cartesian2属性。
options.eyeOffset
Property
default Cartesian3.ZERO
指定眼偏移的Cartesian3属性。
options.horizontalOrigin
Property
default HorizontalOrigin.CENTER
指定HorizontalOrigin的属性。
options.verticalOrigin
Property
default VerticalOrigin.CENTER
指定VerticalOrigin的属性。
options.heightReference
Property
default HeightReference.NONE
指定高度相对高度的属性。
options.fillColor
Property
default Color.WHITE
指定填充Color的属性。
options.outlineColor
Property
default Color.BLACK
指定大纲Color的属性。
options.outlineWidth
Property
default 1.0
指定轮廓宽度的数值属性。
options.translucencyByDistance
Property
一个NearFarScalar属性,用于根据与相机的距离设置半透明。
options.pixelOffsetScaleByDistance
Property
一个NearFarScalar属性,用于根据与相机的距离设置PixeLoffset。
options.scaleByDistance
Property
一个NearFarScalar属性,用于根据与相机的距离设置比例。
options.distanceDisplayCondition
Property
一个属性,指定此标签将显示在与相机的距离。
options.disableDepthTestDistance
Property
一个属性,指定从要禁用深度测试的相机到的距离。

Members

backgroundColor : Property

获取或设置指定背景Color的属性。
Default Value: new Color(0.165, 0.165, 0.165, 0.8)

backgroundPadding : Property

获取或设置以像素为单位指定标签水平和垂直背景填充的Cartesian2属性。
Default Value: new Cartesian2(7, 5)

(readonly) definitionChanged : Event

获取每当属性或子属性更改或修改时引发的事件。

disableDepthTestDistance : Property

获取或设置与要禁用深度测试的照相机之间的距离,例如,防止对地形进行剪切。当设置为零时,始终应用深度测试。当设置为数字正无穷大时,深度测试永远不会应用。

distanceDisplayCondition : Property

获取或设置DistanceDisplayCondition属性,指定此标签将显示在距相机的距离。

eyeOffset : Property

获取或设置Cartesian3属性,该属性以眼坐标指定标签的偏移量。眼睛坐标是一个左手坐标系,其中x指向观看者的右侧,y指向上方,z指向屏幕。

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

下面,标签位于地球中心,但眼睛偏移使其始终出现在地球顶部,而不管观众或地球的方向如何。

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

Default Value: Cartesian3.ZERO

fillColor : Property

获取或设置指定填充Color的属性。

font : Property

获取或设置用CSS语法指定字体的字符串属性。
See:

heightReference : Property

获取或设置指定HeightReference的属性。
Default Value: HeightReference.NONE

horizontalOrigin : Property

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

outlineColor : Property

获取或设置指定大纲Color的属性。

outlineWidth : Property

获取或设置指定大纲宽度的数值属性。

pixelOffset : Property

获取或设置Cartesian2属性,该属性指定标签在屏幕空间中相对于此标签原点的像素偏移量。这通常用于在同一位置对齐多个标签和标签,例如图像和文本。屏幕空间原点是画布的左上角;x从左到右增加,y从上到下增加。

default
l.pixeloffset = new Cartesian2(25, 75);
以黄色点表示标签的原点。

Default Value: Cartesian2.ZERO

pixelOffsetScaleByDistance : Property

获取或设置NearFarScalar属性,该属性基于与相机的距离指定标签的像素偏移量。标签的像素偏移量将在NearFarScalar#nearValueNearFarScalar#farValue之间插入,而相机距离在指定NearFarScalar#nearNearFarScalar#far的上下限内。在这些范围之外,标签的像素偏移量保持固定到最近的界限。

scale : Property

获取或设置指定要应用于图像的统一比例的数值属性。大于1.0的比例放大标签,而小于1.0的比例缩小标签。


从左到右在上图中,比例分别为0.51.02.0

Default Value: 1.0

scaleByDistance : Property

根据标签与相机的距离获取或设置标签的近缩放和远缩放属性。标签的比例将在NearFarScalar#nearValueNearFarScalar#farValue之间插入,而相机距离在指定NearFarScalar#nearNearFarScalar#far的上下限内。在这些范围之外,标签的刻度将保持在最近的范围内。如果未定义,将禁用scaleByDistance。

show : Property

获取或设置用于指定标签可见性的布尔属性。

showBackground : Property

获取或设置用于指定标签后面背景的可见性的布尔属性。
Default Value: false

style : Property

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

text : Property

获取或设置指定标签文本的字符串属性。支持显式换行符'\n'。

translucencyByDistance : Property

获取或设置NearFarScalar属性,该属性基于与相机的距离指定标签的半透明性。标签的半透明性将插入NearFarScalar#nearValueNearFarScalar#farValue之间,而相机距离在指定NearFarScalar#nearNearFarScalar#far的上下限内。在这些范围之外,标签的半透明性保持固定到最近的边界。

verticalOrigin : Property

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

Methods

clone(result) → {LabelGraphics}
复制此实例。
Parameters:
result (LabelGraphics) 存储结果的对象。
merge(source)
将此对象上的每个未分配属性分配给所提供源对象上相同属性的值。
Parameters:
source (LabelGraphics) 要合并到此对象中的对象。