org.cesiumjs.cs.datasources.graphics

Class LabelGraphics

java.lang.Object

org.cesiumjs.cs.datasources.graphics.LabelGraphics

@JsType(isNative=true,
        namespace="Cesium",
        name="LabelGraphics")
public class LabelGraphics
extends Object

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Property	backgroundColor A Property specifying the background Color.
Property	backgroundPadding A Cartesian2 Property specifying the horizontal and vertical background padding in pixels.
Property	disableDepthTestDistance Gets or sets the distance from the camera at which to disable the depth test to, for example, prevent clipping against terrain.
Property	distanceDisplayCondition A Property specifying at what distance from the camera that this label will be displayed.
Property	eyeOffset A Cartesian3 Property specifying the eye offset.
Property	fillColor A Property specifying the fill Color.
Property	font A Property specifying the CSS font.
Property	heightReference A Property specifying what the height is relative to.
Property	horizontalOrigin A Property specifying the HorizontalOrigin.
Property	outlineColor A Property specifying the outline Color.
Property	outlineWidth A numeric Property specifying the outline width.
Property	pixelOffset A Cartesian2 Property specifying the pixel offset.
Property	pixelOffsetScaleByDistance A NearFarScalar Property used to set pixelOffset based on distance from the camera.
Property	scale A numeric Property specifying the scale to apply to the text.
Property	show A boolean Property specifying the visibility of the label.
Property	showBackground A boolean Property specifying the visibility of the background behind the label.
Property	style A Property specifying the LabelStyle.
Property	text A Property specifying the text.
Property	translucencyByDistance A NearFarScalar Property used to set translucency based on distance from the camera.
Property	verticalOrigin A Property specifying the VerticalOrigin.

Constructor Summary

Constructors

Constructor and Description
LabelGraphics()
LabelGraphics(LabelGraphicsOptions options)

Method Summary

Modifier and Type	Method and Description
LabelGraphics	clone(LabelGraphics result) Duplicates this instance.
Event	definitionChanged() Gets the event that is raised whenever a property or sub-property is changed or modified.
void	merge(LabelGraphics source) Assigns each unassigned property on this object to the value of the same property on the provided source object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

text

@JsProperty
public Property text

A Property specifying the text.

font

@JsProperty
public Property font

A Property specifying the CSS font. Default: '10px sans-serif'

style

@JsProperty
public Property style

A Property specifying the LabelStyle. Default: LabelStyle.FILL()

fillColor

@JsProperty
public Property fillColor

A Property specifying the fill Color. Default: Color.BLACK()

outlineColor

@JsProperty
public Property outlineColor

A Property specifying the outline Color. Default: Color.BLACK()

outlineWidth

@JsProperty
public Property outlineWidth

A numeric Property specifying the outline width. Default: 1.0

show

@JsProperty
public Property show

A boolean Property specifying the visibility of the label. Default: true

showBackground

@JsProperty
public Property showBackground

A boolean Property specifying the visibility of the background behind the label. Default: false

backgroundColor

@JsProperty
public Property backgroundColor

A Property specifying the background Color. Default: Color(0.165, 0.165, 0.165, 0.8)

backgroundPadding

@JsProperty
public Property backgroundPadding

A Cartesian2 Property specifying the horizontal and vertical background padding in pixels. Default: Cartesian2(7, 5)

disableDepthTestDistance

@JsProperty
public Property disableDepthTestDistance

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. Default: 0.0

scale

@JsProperty
public Property scale

A numeric Property specifying the scale to apply to the text. Default: 1.0

horizontalOrigin

@JsProperty
public Property horizontalOrigin

A Property specifying the HorizontalOrigin. Default: VerticalOrigin.CENTER()

verticalOrigin

@JsProperty
public Property verticalOrigin

A Property specifying the VerticalOrigin. Default: VerticalOrigin.CENTER()

eyeOffset

@JsProperty
public Property eyeOffset

A Cartesian3 Property specifying the eye offset. Default: Cartesian3.ZERO()

pixelOffset

@JsProperty
public Property pixelOffset

A Cartesian2 Property specifying the pixel offset. Default: Cartesian2.ZERO()

translucencyByDistance

@JsProperty
public Property translucencyByDistance

A NearFarScalar Property used to set translucency based on distance from the camera.

pixelOffsetScaleByDistance

@JsProperty
public Property pixelOffsetScaleByDistance

A NearFarScalar Property used to set pixelOffset based on distance from the camera.

heightReference

@JsProperty
public Property heightReference

A Property specifying what the height is relative to. Default: HeightReference.NONE()

distanceDisplayCondition

@JsProperty
public Property distanceDisplayCondition

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

Constructor Detail

LabelGraphics

@JsConstructor
public LabelGraphics()

LabelGraphics

@JsConstructor
public LabelGraphics(LabelGraphicsOptions options)

Method Detail

definitionChanged

@JsProperty(name="definitionChanged")
public Event definitionChanged()

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

clone

public LabelGraphics clone(@JsOptional
                           LabelGraphics result)

Duplicates this instance.

Parameters:

result - The object onto which to store the result.

Returns:

The modified result parameter or a new instance if one was not provided.

merge

public void merge(LabelGraphics source)

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

Parameters:

source - The object to be merged into this object.