LabelGraphics

new SuperMap3D.LabelGraphics(options)

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


Example labels

Name Type Description
options Object optional 具有以下属性的对象:
Name Type Default Description
text Property optional
font Property '10px sans-serif' optional 指定CSS字体的属性。
style Property LabelStyle.FILL optional 指定LabelStyle的属性。
fillColor Property Color.WHITE optional 指定填充Color的属性。
outlineColor Property Color.BLACK optional 指定轮廓 Color 的属性。
outlineWidth Property 1.0 optional 指定轮廓宽度的数值属性。
show Property true optional 布尔属性,用于指定标签的可见性。
showBackground Property false optional 布尔属性,用于指定标签背后背景的可见性。
backgroundColor Property new Color(0.165, 0.165, 0.165, 0.8) optional 指定背景 Color 的属性。
backgroundPadding Property new Cartesian2(7, 5) optional Cartesian2 属性 以像素为单位指定水平和垂直背景填充的属性。
scale Property 1.0 optional 数值属性,指定应用于文本的缩放比例。
horizontalOrigin Property HorizontalOrigin.CENTER optional 指定 HorizontalOrigin 的属性。
verticalOrigin Property VerticalOrigin.CENTER optional 指定 VerticalOrigin 的属性。
eyeOffset Property Cartesian3.ZERO optional Cartesian3 指定视点偏移的属性。
pixelOffset Property Cartesian2.ZERO optional Cartesian2 指定像素偏移量的属性。
translucencyByDistance Property optional NearFarScalar 用于根据与相机的距离设置半透明度的属性。
pixelOffsetScaleByDistance Property optional NearFarScalar 用于根据与相机的距离设置 pixelOffset的属性。
scaleByDistance Property optional NearFarScalar 用于根据与相机的距离设置缩放比例的属性。
heightReference Property HeightReference.NONE optional 指定高度相对于的位置的属性。
distanceDisplayCondition Property optional 指定该标签显示在距离相机多远的位置的属性。

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)

readonlydefinitionChanged : Event

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

disableDepthTestDistance : Property

获取或设置与相机的距离,在该距离上要禁用深度测试,以防止对地形的剪切。 当设置为零时,始终应用深度测试。当设置为Number时。POSITIVE_INFINITY,深度测试从未应用。

distanceDisplayCondition : Property

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

eyeOffset : Property

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

视点偏移通常用于在同一位置安排多个标签或对象,例如,将标签安排在其相应的三维模型上。

下面,这个标签位于地球的中心,但视点偏移使它总是出现在地球的顶部,无论观看者或地球的方向如何。

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

获取或设置指定标签文本的字符串属性。

translucencyByDistance : Property

获取或设置NearFarScalar属性,该属性根据与相机的距离指定标签的透明度。 标签的半透明将在NearFarScalar#nearValueNearFarScalar#farValue之间插值,而相机距离落在指定的NearFarScalar#nearNearFarScalar#far的上下边界内。在这些范围之外,标签的半透明仍然被限制在最近的范围内。

verticalOrigin : Property

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

Methods

clone(result)LabelGraphics

复制此实例。
Name Type Description
result LabelGraphics optional 存储结果的对象。
Returns:
修改后的结果参数,或一个新实例(如果没有提供)。

merge(source)

将此对象上每个未指定的属性赋值给所提供源对象上相同属性的值。
Name Type Description
source LabelGraphics 要合并到该对象中的对象。