ConstructorOptions

Initialization options for the Label constructor

See also

Properties

Link copied to clipboard
abstract var backgroundColor: Color?

A Color specifying the background color of the label. Default value - Color(0.165, 0.165, 0.165, 0.8)

Link copied to clipboard

A Cartesian2 Specifying the horizontal and vertical background padding in pixels. Default value - Cartesian2(7, 5)

Link copied to clipboard

A number specifying the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.

Link copied to clipboard

A DistanceDisplayCondition specifying at what distance from the camera that this label will be displayed.

Link copied to clipboard
abstract var eyeOffset: Cartesian3?

A Cartesian3 specifying the 3D Cartesian offset applied to this label in eye coordinates. Default value - Cartesian3.ZERO

Link copied to clipboard
abstract var fillColor: Color?

A Color specifying the fill color of the label. Default value - Color.WHITE

Link copied to clipboard
abstract var font: String?

A string specifying the font used to draw this label. Fonts are specified using the same syntax as the CSS 'font' property. Default value - '30px sans-serif'

Link copied to clipboard

A HeightReference specifying the height reference of this label. Default value - HeightReference.NONE

Link copied to clipboard

A HorizontalOrigin specifying the horizontal origin of this label. Default value - HorizontalOrigin.LEFT

Link copied to clipboard
abstract var id: Any?

A user-defined object to return when the label is picked with Scene.pick.

Link copied to clipboard
abstract var outlineColor: Color?

A Color specifying the outline color of the label. Default value - Color.BLACK

Link copied to clipboard
abstract var outlineWidth: Double?

A number specifying the outline width of the label. Default value - 1.0

Link copied to clipboard
abstract var pixelOffset: Cartesian2?

A Cartesian2 specifying the pixel offset in screen space from the origin of this label. Default value - Cartesian2.ZERO

Link copied to clipboard

A NearFarScalar specifying near and far pixel offset scaling properties of the label based on the label's distance from the camera.

Link copied to clipboard
abstract var position: Cartesian3

The cartesian position of the label.

Link copied to clipboard
abstract var scale: Double?

A number specifying the uniform scale that is multiplied with the label size. Default value - 1.0

Link copied to clipboard

A NearFarScalar specifying near and far scaling properties of the label based on the label's distance from the camera.

Link copied to clipboard
abstract var show: Boolean?

Determines if this label will be shown. Default value - true

Link copied to clipboard
abstract var showBackground: Boolean?

Determines if a background behind this label will be shown. Default value - false

Link copied to clipboard
abstract var style: LabelStyle?

A LabelStyle specifying the style of the label. Default value - LabelStyle.FILL

Link copied to clipboard
abstract var text: String?

A string specifying the text of the label.

Link copied to clipboard

A NearFarScalar specifying near and far translucency properties of the label based on the label's distance from the camera.

Link copied to clipboard

A VerticalOrigin specifying the vertical origin of this label. Default value - VerticalOrigin.BASELINE