Label

Members

Default Value: false

Examples:

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

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

Default Value: new Color(0.165, 0.165, 0.165, 0.8)

Default Value: new Cartesian2(7, 5)

Default Value: undefined

Gets and sets the 3D Cartesian offset applied to this label in eye coordinates. Eye coordinates is a left-handed coordinate system, where x points towards the viewer's right, y points up, and z points into the screen. Eye coordinates use the same scale as world and model coordinates, which is typically meters.

An eye offset is commonly used to arrange multiple label or objects at the same position, e.g., to arrange a label above its corresponding 3D model.

Below, the label is positioned at the center of the Earth but an eye offset makes it always appear on top of the Earth regardless of the viewer's or Earth's orientation.

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

Default Value: Cartesian3.ZERO

Default Value: Color.WHITE

See:

• HTML canvas 2D context fill and stroke styles

Default Value: '30px sans-serif'

See:

• HTML canvas 2D context text styles

Default Value: HeightReference.NONE

Gets or sets the horizontal origin of this label, which determines if the label is drawn to the left, center, or right of its anchor position.

Default Value: HorizontalOrigin.LEFT

Example:

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

Default Value: Color.BLACK

See:

• HTML canvas 2D context fill and stroke styles

Default Value: 1.0

See:

• HTML canvas 2D context fill and stroke styles

Gets or sets the pixel offset in screen space from the origin of this label. This is commonly used to align multiple labels and billboards at the same position, e.g., an image and text. The screen space origin is the top, 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 label's origin is indicated by the yellow point.

Default Value: Cartesian2.ZERO

Examples:

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

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

Gets or sets the uniform scale that is multiplied with the label's size in pixels. A scale of 1.0 does not change the size of the label; a scale greater than 1.0 enlarges the label; a positive scale less than 1.0 shrinks the label.

Applying a large scale value may pixelate the label. To make text larger without pixelation, use a larger font size when calling Label#font instead.

From left to right in the above image, the scales are 0.5, 1.0, and 2.0.

Default Value: 1.0

Examples:

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

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

Default Value: true

Default Value: false

Default Value: LabelStyle.FILL

Default Value: 1.0

Examples:

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

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

Gets or sets the vertical origin of this label, which determines if the label is to the above, below, or at the center of its anchor position.

Default Value: VerticalOrigin.BASELINE

Example:

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

Methods

Returns:

Example:

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

See:

• Label#eyeOffset
• Label#pixelOffset

Returns:

Returns:

Type Definitions

Properties:

Name	Type	Attributes	Default	Description
position	Cartesian3			The cartesian position of the label.
id	*	<optional>		A user-defined object to return when the label is picked with Scene#pick.
show	boolean	<optional>	true	Determines if this label will be shown.
text	string	<optional>		A string specifying the text of the label.
font	string	<optional>	'30px sans-serif'	A string specifying the font used to draw this label. Fonts are specified using the same syntax as the CSS 'font' property.
style	LabelStyle	<optional>	LabelStyle.FILL	A LabelStyle specifying the style of the label.
scale	number	<optional>	1.0	A number specifying the uniform scale that is multiplied with the label size.
showBackground	boolean	<optional>	false	Determines if a background behind this label will be shown.
backgroundColor	Color	<optional>	new Color(0.165, 0.165, 0.165, 0.8)	A Color specifying the background color of the label.
backgroundPadding	Cartesian2	<optional>	new Cartesian2(7, 5)	A Cartesian2 Specifying the horizontal and vertical background padding in pixels.
pixelOffset	Cartesian2	<optional>	Cartesian2.ZERO	A Cartesian2 specifying the pixel offset in screen space from the origin of this label.
eyeOffset	Cartesian3	<optional>	Cartesian3.ZERO	A Cartesian3 specifying the 3D Cartesian offset applied to this label in eye coordinates.
horizontalOrigin	HorizontalOrigin	<optional>	HorizontalOrigin.LEFT	A HorizontalOrigin specifying the horizontal origin of this label.
verticalOrigin	VerticalOrigin	<optional>	VerticalOrigin.BASELINE	A VerticalOrigin specifying the vertical origin of this label.
heightReference	HeightReference	<optional>	HeightReference.NONE	A HeightReference specifying the height reference of this label.
fillColor	Color	<optional>	Color.WHITE	A Color specifying the fill color of the label.
outlineColor	Color	<optional>	Color.BLACK	A Color specifying the outline color of the label.
outlineWidth	number	<optional>	1.0	A number specifying the outline width of the label.
translucencyByDistance	NearFarScalar	<optional>		A NearFarScalar specifying near and far translucency properties of the label based on the label's distance from the camera.
pixelOffsetScaleByDistance	NearFarScalar	<optional>		A NearFarScalar specifying near and far pixel offset scaling properties of the label based on the label's distance from the camera.
scaleByDistance	NearFarScalar	<optional>		A NearFarScalar specifying near and far scaling properties of the label based on the label's distance from the camera.
distanceDisplayCondition	DistanceDisplayCondition	<optional>		A DistanceDisplayCondition specifying at what distance from the camera that this label will be displayed.
disableDepthTestDistance	number	<optional>		A number specifying the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.