Class: Label

Members

static enableRightToLeftDetectionBoolean

Determines whether or not run the algorithm, that match the text of the label to right-to-left languages

Default Value:

false

Examples

// Example 1.
// Set a label's rightToLeft before init
SuperMap3D.Label.enableRightToLeftDetection = true;
var myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: 'זה טקסט בעברית \n ועכשיו יורדים שורה',
  }
});

// Example 2.
var myLabelEntity = viewer.entities.add({
  label: {
    id: 'my label',
    text: 'English text'
  }
});
// Set a label's rightToLeft after init
SuperMap3D.Label.enableRightToLeftDetection = true;
myLabelEntity.text = 'טקסט חדש';

获取并设置视点坐标中应用于此标签的三维Cartesian偏移量。 视点坐标是一个左手坐标系，其中x指向观看者的右侧，y指向上方，而z指向屏幕。 视点坐标使用与地理和模型坐标相同的尺度，通常是米。

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

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

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

Default Value:

Cartesian3.ZERO

获取或设置此标签的水平原点，该原点确定标签是绘制在其锚位置的左侧、中间还是右侧。

Default Value:

HorizontalOrigin.LEFT

Example

// Use a top, right origin
l.horizontalOrigin = SuperMap3D.HorizontalOrigin.RIGHT;
l.verticalOrigin = SuperMap3D.VerticalOrigin.TOP;

获取或设置屏幕空间中相对于此标签原点的像素偏移量。 这通常用于在同一位置对齐多个标签和布告板，例如影像和文本。屏幕空间原点位于画布的左上角;x从左到右递增，y从上到下递增。

default

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

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

Default Value:

Cartesian2.ZERO

// 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 SuperMap3D.Cartesian2(0.0, 1.0);
text.pixelOffsetScaleByDistance = new SuperMap3D.NearFarScalar(1.5e2, 0.0, 8.0e6, 10.0);

// Example 2.
// disable pixel offset by distance
text.pixelOffsetScaleByDistance = undefined;

获取或设置与标签大小(以像素为单位)相乘的统一比例。 1.0不改变标签的大小，大于1.0的刻度会放大标签，小于1.0的正刻度缩小标签。

应用较大的比例值可能会使标签像素化。要使文本变大而没有像素化，在调用Label#font时使用更大的字体大小。

上图从左到右依次为0.5、1.0、2.0。

Default Value:

1.0

// 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 SuperMap3D.NearFarScalar(1.5e2, 1.5, 8.0e6, 0.0);

// Example 2.
// disable scaling by distance
label.scaleByDistance = undefined;

// 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 SuperMap3D.NearFarScalar(1.5e2, 1.0, 8.0e6, 0.0);

// Example 2.
// disable translucency by distance
text.translucencyByDistance = undefined;

获取或设置此标签的垂直原点，该原点确定标签位于其锚位置的上方、下方还是中心。

Default Value:

VerticalOrigin.BASELINE

Example

// Use a top, right origin
l.horizontalOrigin = SuperMap3D.HorizontalOrigin.RIGHT;
l.verticalOrigin = SuperMap3D.VerticalOrigin.TOP;

Methods

computeScreenSpacePosition(scene, result){Cartesian2}

计算标签原点的屏幕空间位置，考虑视点偏移和像素偏移。 屏幕空间原点位于画布的左上角;X从左到右递增，y从上到下递增。

Name	Type	Description
scene	Scene	标签所在的场景。
result	Cartesian2	可选 存储结果的对象。

See:

• Label#eyeOffset
• Label#pixelOffset

Returns:

Type	Description
Cartesian2	标签的屏幕空间位置。

Example

console.log(l.computeScreenSpacePosition(scene).toString());

equals(other){Boolean}

确定此标签是否等于另一个标签。如果标签的所有属性都相等，则标签相等。不同集合中的标签可以相等。

Name	Type	Description
other	Label	The label to compare for equality.

Returns:

Type	Description
Boolean	true if the labels are equal; otherwise, false.

isDestroyed(){Boolean}

如果该对象已被销毁，则返回 true；否则返回 false。

如果该对象已被销毁，则不应使用；调用 isDestroyed 以外的任何函数都将导致 DeveloperError 异常。

Returns:

Type	Description
Boolean	如果该对象已被销毁，则为 true；否则为 false。