LabelGraphics

external class LabelGraphics(source)

Describes a two dimensional label located at the position of the containing Entity.

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard

Gets or sets the Property specifying the background Color.

Link copied to clipboard

Gets or sets the Cartesian2 Property specifying the label's horizontal and vertical background padding in pixels.

Link copied to clipboard

Gets the event that is raised whenever a property or sub-property is changed or modified.

Link copied to clipboard

Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain. When set to zero, the depth test is always applied. When set to Number.POSITIVE_INFINITY, the depth test is never applied.

Link copied to clipboard

Gets or sets the DistanceDisplayCondition Property specifying at what distance from the camera that this label will be displayed.

Link copied to clipboard

Gets or sets the Cartesian3 Property specifying the label's offset 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.

Link copied to clipboard

Gets or sets the Property specifying the fill Color.

Link copied to clipboard

Gets or sets the string Property specifying the font in CSS syntax.

Link copied to clipboard

Gets or sets the Property specifying the HeightReference.

Link copied to clipboard

Gets or sets the Property specifying the HorizontalOrigin.

Link copied to clipboard

Gets or sets the Property specifying the outline Color.

Link copied to clipboard

Gets or sets the numeric Property specifying the outline width.

Link copied to clipboard

Gets or sets the Cartesian2 Property specifying the label's pixel offset in screen space from the origin of this label. This is commonly used to align multiple labels and labels 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.

Link copied to clipboard

Gets or sets NearFarScalar Property specifying the pixel offset of the label based on the distance from the camera. A label's pixel offset will interpolate between the NearFarScalar.nearValue and NearFarScalar.farValue while the camera distance falls within the lower and upper bounds of the specified NearFarScalar.near and NearFarScalar.far. Outside of these ranges the label's pixel offset remains clamped to the nearest bound.

Link copied to clipboard

Gets or sets the numeric Property specifying the uniform scale to apply to the image. A scale greater than 1.0 enlarges the label while a scale less than 1.0 shrinks it.

Link copied to clipboard

Gets or sets near and far scaling properties of a Label based on the label's distance from the camera. A label's scale will interpolate between the NearFarScalar.nearValue and NearFarScalar.farValue while the camera distance falls within the lower and upper bounds of the specified NearFarScalar.near and NearFarScalar.far. Outside of these ranges the label's scale remains clamped to the nearest bound. If undefined, scaleByDistance will be disabled.

Link copied to clipboard

Gets or sets the boolean Property specifying the visibility of the label.

Link copied to clipboard

Gets or sets the boolean Property specifying the visibility of the background behind the label.

Link copied to clipboard

Gets or sets the Property specifying the LabelStyle.

Link copied to clipboard

Gets or sets the string Property specifying the text of the label. Explicit newlines '\n' are supported.

Link copied to clipboard

Gets or sets NearFarScalar Property specifying the translucency of the label based on the distance from the camera. A label's translucency will interpolate between the NearFarScalar.nearValue and NearFarScalar.farValue while the camera distance falls within the lower and upper bounds of the specified NearFarScalar.near and NearFarScalar.far. Outside of these ranges the label's translucency remains clamped to the nearest bound.

Link copied to clipboard

Gets or sets the Property specifying the VerticalOrigin.

Functions

Link copied to clipboard
fun clone(result: LabelGraphics? = definedExternally): LabelGraphics

Duplicates this instance.

Link copied to clipboard
fun merge(source: LabelGraphics)

Assigns each unassigned property on this object to the value of the same property on the provided source object.