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 = 'טקסט חדש';

Obtain and set the 3D Cartesian offset applied to this label in the viewpoint coordinates. The viewpoint coordinate is a left-hand coordinate system, where x points to the right of the viewer, y points upwards, and z points to the screen. The viewpoint coordinates use the same scale as geographic and model coordinates, usually in meters. Viewpoint shift is commonly used to arrange multiple labels or objects at the same location, such as placing labels on their corresponding 3D models. Below, this label is located at the center of the Earth, but a viewpoint offset causes it to always appear at the top of the Earth, regardless of the viewer or the direction of the Earth.

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

Default Value:

Cartesian3.ZERO

Get or set the horizontal origin of this label, which determines whether the label is drawn to the left, middle, or right of its anchor position.

Default Value:

HorizontalOrigin.LEFT

Example

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

Get or set the pixel offset relative to the origin of this label in screen space. This is typically used to align multiple labels and bulletin boards in the same location, such as images and text. The origin of the screen space is located in the upper left corner of the canvas; X increases from left to right, and y increases from top to bottom.

default

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

The origin of the label is represented by a yellow dot.

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;

Get or set a uniform ratio that multiplies the label size (in pixels). 1.0 does not change the size of the label, scales larger than 1.0 will enlarge the label, and positive scales smaller than 1.0 will shrink the label. Applying a larger proportion value may cause the label to be pixelated. To make the text larger without pixelation, use a larger font size when calling Label # font.

The image above, from left to right, shows0.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;

Get or set the vertical origin of this label, which determines whether the label is located above, below, or at the center of its anchor position.

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}

Calculate the screen spatial position of the label origin, taking into account viewpoint offset and pixel offset. The origin of the screen space is located in the upper left corner of the canvas; X increases from left to right, and y increases from top to bottom.

Name	Type	Description
scene	Scene	The scene where the label is located.
result	Cartesian2	optional The object that stores the results.

See:

• Label#eyeOffset
• Label#pixelOffset

Returns:

Type	Description
Cartesian2	The screen space position of the label.

Example

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

equals(other){Boolean}

Determine if this label is equal to another label. If all attributes of the label are equal, then the label is equal. Labels in different sets can be equal.

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}

If the object has been destroyed, return true; Otherwise, return false. If the object has been destroyed, it should not be used; Calling any function other than isDestroyed will result in a Developer Error exception.

Returns:

Type	Description
Boolean	If the object has been destroyed, it is true; Otherwise, it is false.