LabelGraphics

java.lang.Object
- agi.foundation.cesium.LabelGraphics

```
public class LabelGraphics
extends Object
```
Defines the graphical properties of a label. A label is viewport-aligned text positioned in the scene. This will produce the label property in CZML.

See Also:

CZML specification for the label property

Constructor Summary

Constructors
Constructor and Description

LabelGraphics()
Initializes a new instance.

Constructors
Constructor and Description
`LabelGraphics()` Initializes a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CesiumProperty<Color>`	`getBackgroundColor()` Gets the color of the background behind the label.
`CesiumProperty<Rectangular>`	`getBackgroundPadding()` Gets the amount of padding between the text and the label's background in each dimension, in pixels.
`CesiumProperty<Double>`	`getDisableDepthTestDistance()` Gets the distance from the camera at which to disable the depth test.
`CesiumProperty<Bounds>`	`getDistanceDisplayCondition()` Gets the distances from the camera at which this label will be displayed.
`CesiumProperty<Cartesian>`	`getEyeOffset()` Gets the label's offset from the origin in eye coordinates.
`CesiumProperty<Color>`	`getFillColor()` Gets the fill color of the label.
`CesiumProperty<String>`	`getFont()` Gets the font of the label.
`CesiumProperty<CesiumHeightReference>`	`getHeightReference()` Gets the height reference of the label.
`CesiumProperty<CesiumHorizontalOrigin>`	`getHorizontalOrigin()` Gets whether the label is left, center, or right-aligned with the origin.
`CesiumProperty<Color>`	`getOutlineColor()` Gets the outline color of the label.
`CesiumProperty<Double>`	`getOutlineWidth()` Gets the outline width of the label.
`CesiumProperty<Rectangular>`	`getPixelOffset()` Gets the label's offset from the origin in pixel coordinates.
`CesiumProperty<NearFarScalar>`	`getPixelOffsetScaleByDistance()` Gets how the label's pixel offset should change based on the label's distance from the camera.
`CesiumProperty<Double>`	`getScale()` Gets the scale of the label text.
`CesiumProperty<NearFarScalar>`	`getScaleByDistance()` Gets how the label's scale should change based on the label's distance from the camera.
`CesiumProperty<Boolean>`	`getShow()` Gets whether or not the label is shown.
`CesiumProperty<Boolean>`	`getShowBackground()` Gets whether or not a background behind the label is shown.
`CesiumProperty<CesiumLabelStyle>`	`getStyle()` Gets the style of the label.
`CesiumProperty<String>`	`getText()` Gets the text of the label.
`CesiumProperty<NearFarScalar>`	`getTranslucencyByDistance()` Gets how the label's translucency should change based on the label's distance from the camera.
`CesiumProperty<CesiumVerticalOrigin>`	`getVerticalOrigin()` Gets whether the label is bottom, center, or top-aligned with the origin.
`void`	`setBackgroundColor(CesiumProperty<Color> value)` Sets the color of the background behind the label.
`void`	`setBackgroundPadding(CesiumProperty<Rectangular> value)` Sets the amount of padding between the text and the label's background in each dimension, in pixels.
`void`	`setDisableDepthTestDistance(CesiumProperty<Double> value)` Sets the distance from the camera at which to disable the depth test.
`void`	`setDistanceDisplayCondition(CesiumProperty<Bounds> value)` Sets the distances from the camera at which this label will be displayed.
`void`	`setEyeOffset(CesiumProperty<Cartesian> value)` Sets the label's offset from the origin in eye coordinates.
`void`	`setFillColor(CesiumProperty<Color> value)` Sets the fill color of the label.
`void`	`setFont(CesiumProperty<String> value)` Sets the font of the label.
`void`	`setHeightReference(CesiumProperty<CesiumHeightReference> value)` Sets the height reference of the label.
`void`	`setHorizontalOrigin(CesiumProperty<CesiumHorizontalOrigin> value)` Sets whether the label is left, center, or right-aligned with the origin.
`void`	`setOutlineColor(CesiumProperty<Color> value)` Sets the outline color of the label.
`void`	`setOutlineWidth(CesiumProperty<Double> value)` Sets the outline width of the label.
`void`	`setPixelOffset(CesiumProperty<Rectangular> value)` Sets the label's offset from the origin in pixel coordinates.
`void`	`setPixelOffsetScaleByDistance(CesiumProperty<NearFarScalar> value)` Sets how the label's pixel offset should change based on the label's distance from the camera.
`void`	`setScale(CesiumProperty<Double> value)` Sets the scale of the label text.
`void`	`setScaleByDistance(CesiumProperty<NearFarScalar> value)` Sets how the label's scale should change based on the label's distance from the camera.
`void`	`setShow(CesiumProperty<Boolean> value)` Sets whether or not the label is shown.
`void`	`setShowBackground(CesiumProperty<Boolean> value)` Sets whether or not a background behind the label is shown.
`void`	`setStyle(CesiumProperty<CesiumLabelStyle> value)` Sets the style of the label.
`void`	`setText(CesiumProperty<String> value)` Sets the text of the label.
`void`	`setTranslucencyByDistance(CesiumProperty<NearFarScalar> value)` Sets how the label's translucency should change based on the label's distance from the camera.
`void`	`setVerticalOrigin(CesiumProperty<CesiumVerticalOrigin> value)` Sets whether the label is bottom, center, or top-aligned with the origin.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LabelGraphics
```
public LabelGraphics()
```
    Initializes a new instance.
- Method Detail
  - getShow
```
public final CesiumProperty<Boolean> getShow()
```
    Gets whether or not the label is shown. If not specified, the default is true.
  - setShow
```
public final void setShow(CesiumProperty<Boolean> value)
```
    Sets whether or not the label is shown. If not specified, the default is true.
  - getText
```
public final CesiumProperty<String> getText()
```
    Gets the text of the label. A newline character (\n) indicates line breaks.
  - setText
```
public final void setText(CesiumProperty<String> value)
```
    Sets the text of the label. A newline character (\n) indicates line breaks.
  - getFont
```
public final CesiumProperty<String> getFont()
```
    Gets the font of the label. The format of the string is expected to be a CSS font property. If not specified, the default is "30px sans-serif".
  - setFont
```
public final void setFont(CesiumProperty<String> value)
```
    Sets the font of the label. The format of the string is expected to be a CSS font property. If not specified, the default is "30px sans-serif".
  - getStyle
```
public final CesiumProperty<CesiumLabelStyle> getStyle()
```
    Gets the style of the label. If not specified, the default is CesiumLabelStyle.FILL.
  - setStyle
```
public final void setStyle(CesiumProperty<CesiumLabelStyle> value)
```
    Sets the style of the label. If not specified, the default is CesiumLabelStyle.FILL.
  - getScale
```
public final CesiumProperty<Double> getScale()
```
    Gets the scale of the label text. If not specified, the default is 1.0.
  - setScale
```
public final void setScale(CesiumProperty<Double> value)
```
    Sets the scale of the label text. If not specified, the default is 1.0.
  - getShowBackground
```
public final CesiumProperty<Boolean> getShowBackground()
```
    Gets whether or not a background behind the label is shown. If not specified, the default is false.
  - setShowBackground
```
public final void setShowBackground(CesiumProperty<Boolean> value)
```
    Sets whether or not a background behind the label is shown. If not specified, the default is false.
  - getBackgroundColor
```
public final CesiumProperty<Color> getBackgroundColor()
```
    Gets the color of the background behind the label. If not specified, the default is (in CSS syntax): rgba(42, 42, 42, 0.8), or, in CSS hexadecimal notation: #2a2a2a with alpha 0.8.
  - setBackgroundColor
```
public final void setBackgroundColor(CesiumProperty<Color> value)
```
    Sets the color of the background behind the label. If not specified, the default is (in CSS syntax): rgba(42, 42, 42, 0.8), or, in CSS hexadecimal notation: #2a2a2a with alpha 0.8.
  - getBackgroundPadding
```
public final CesiumProperty<Rectangular> getBackgroundPadding()
```
    Gets the amount of padding between the text and the label's background in each dimension, in pixels. If not specified, the default is 7 pixels horizontally and 5 pixels vertically.
  - setBackgroundPadding
```
public final void setBackgroundPadding(CesiumProperty<Rectangular> value)
```
    Sets the amount of padding between the text and the label's background in each dimension, in pixels. If not specified, the default is 7 pixels horizontally and 5 pixels vertically.
  - getPixelOffset
```
public final CesiumProperty<Rectangular> getPixelOffset()
```
    Gets the label's offset from the origin in pixel coordinates. The Y (get) coordinate moves the label upwards, and the X (get) coordinate moves the label to the right. If not specified, the default is Zero (get).
  - setPixelOffset
```
public final void setPixelOffset(CesiumProperty<Rectangular> value)
```
    Sets the label's offset from the origin in pixel coordinates. The Y (get) coordinate moves the label upwards, and the X (get) coordinate moves the label to the right. If not specified, the default is Zero (get).
  - getEyeOffset
```
public final CesiumProperty<Cartesian> getEyeOffset()
```
    Gets the label's offset from the origin in eye coordinates. Eye coordinates are specified in a left-handed coordinate system where X (get) points toward the viewer's right, Y (get) points up, and Z (get) points into the screen. If not specified, the default is Zero (get).
  - setEyeOffset
```
public final void setEyeOffset(CesiumProperty<Cartesian> value)
```
    Sets the label's offset from the origin in eye coordinates. Eye coordinates are specified in a left-handed coordinate system where X (get) points toward the viewer's right, Y (get) points up, and Z (get) points into the screen. If not specified, the default is Zero (get).
  - getHorizontalOrigin
```
public final CesiumProperty<CesiumHorizontalOrigin> getHorizontalOrigin()
```
    Gets whether the label is left, center, or right-aligned with the origin. If not specified, the default is CesiumHorizontalOrigin.CENTER.
  - setHorizontalOrigin
```
public final void setHorizontalOrigin(CesiumProperty<CesiumHorizontalOrigin> value)
```
    Sets whether the label is left, center, or right-aligned with the origin. If not specified, the default is CesiumHorizontalOrigin.CENTER.
  - getVerticalOrigin
```
public final CesiumProperty<CesiumVerticalOrigin> getVerticalOrigin()
```
    Gets whether the label is bottom, center, or top-aligned with the origin. If not specified, the default is CesiumVerticalOrigin.CENTER.
  - setVerticalOrigin
```
public final void setVerticalOrigin(CesiumProperty<CesiumVerticalOrigin> value)
```
    Sets whether the label is bottom, center, or top-aligned with the origin. If not specified, the default is CesiumVerticalOrigin.CENTER.
  - getHeightReference
```
public final CesiumProperty<CesiumHeightReference> getHeightReference()
```
    Gets the height reference of the label. If not specified, the default is CesiumHeightReference.NONE.
  - setHeightReference
```
public final void setHeightReference(CesiumProperty<CesiumHeightReference> value)
```
    Sets the height reference of the label. If not specified, the default is CesiumHeightReference.NONE.
  - getFillColor
```
public final CesiumProperty<Color> getFillColor()
```
    Gets the fill color of the label. This property only has an effect if Style (get / set) is CesiumLabelStyle.FILL or CesiumLabelStyle.FILL_AND_OUTLINE. If not specified, the default is White (get).
  - setFillColor
```
public final void setFillColor(CesiumProperty<Color> value)
```
    Sets the fill color of the label. This property only has an effect if Style (get / set) is CesiumLabelStyle.FILL or CesiumLabelStyle.FILL_AND_OUTLINE. If not specified, the default is White (get).
  - getOutlineColor
```
public final CesiumProperty<Color> getOutlineColor()
```
    Gets the outline color of the label. This property only has an effect if Style (get / set) is CesiumLabelStyle.OUTLINE or CesiumLabelStyle.FILL_AND_OUTLINE. If not specified, the default is Black (get).
  - setOutlineColor
```
public final void setOutlineColor(CesiumProperty<Color> value)
```
    Sets the outline color of the label. This property only has an effect if Style (get / set) is CesiumLabelStyle.OUTLINE or CesiumLabelStyle.FILL_AND_OUTLINE. If not specified, the default is Black (get).
  - getOutlineWidth
```
public final CesiumProperty<Double> getOutlineWidth()
```
    Gets the outline width of the label. This property only has an effect if Style (get / set) is CesiumLabelStyle.OUTLINE or CesiumLabelStyle.FILL_AND_OUTLINE. If not specified, the default is 1.0.
  - setOutlineWidth
```
public final void setOutlineWidth(CesiumProperty<Double> value)
```
    Sets the outline width of the label. This property only has an effect if Style (get / set) is CesiumLabelStyle.OUTLINE or CesiumLabelStyle.FILL_AND_OUTLINE. If not specified, the default is 1.0.
  - getTranslucencyByDistance
```
public final CesiumProperty<NearFarScalar> getTranslucencyByDistance()
```
    Gets how the label's translucency should change based on the label's distance from the camera. This scalar value should range from 0 to 1. If not specified, then the translucency does not change based on the camera distance.
  - setTranslucencyByDistance
```
public final void setTranslucencyByDistance(CesiumProperty<NearFarScalar> value)
```
    Sets how the label's translucency should change based on the label's distance from the camera. This scalar value should range from 0 to 1. If not specified, then the translucency does not change based on the camera distance.
  - getPixelOffsetScaleByDistance
```
public final CesiumProperty<NearFarScalar> getPixelOffsetScaleByDistance()
```
    Gets how the label's pixel offset should change based on the label's distance from the camera. This scalar value will be multiplied by PixelOffset (get / set). If not specified, then the pixel offset does not change based on the camera distance.
  - setPixelOffsetScaleByDistance
```
public final void setPixelOffsetScaleByDistance(CesiumProperty<NearFarScalar> value)
```
    Sets how the label's pixel offset should change based on the label's distance from the camera. This scalar value will be multiplied by PixelOffset (get / set). If not specified, then the pixel offset does not change based on the camera distance.
  - getScaleByDistance
```
public final CesiumProperty<NearFarScalar> getScaleByDistance()
```
    Gets how the label's scale should change based on the label's distance from the camera. This scalar value will be multiplied by Scale (get / set). If not specified, then the scale does not change based on the camera distance.
  - setScaleByDistance
```
public final void setScaleByDistance(CesiumProperty<NearFarScalar> value)
```
    Sets how the label's scale should change based on the label's distance from the camera. This scalar value will be multiplied by Scale (get / set). If not specified, then the scale does not change based on the camera distance.
  - getDistanceDisplayCondition
```
public final CesiumProperty<Bounds> getDistanceDisplayCondition()
```
    Gets the distances from the camera at which this label will be displayed. If not specified, the label is displayed regardless of camera distance.
  - setDistanceDisplayCondition
```
public final void setDistanceDisplayCondition(CesiumProperty<Bounds> value)
```
    Sets the distances from the camera at which this label will be displayed. If not specified, the label is displayed regardless of camera distance.
  - getDisableDepthTestDistance
```
public final CesiumProperty<Double> getDisableDepthTestDistance()
```
    Gets the distance from the camera at which to disable the depth test. This can be used to prevent clipping against terrain, for example. When set to zero, the depth test is always applied. When set to Double.POSITIVE_INFINITY, the depth test is never applied. If not specified, the default is 0.0.
  - setDisableDepthTestDistance
```
public final void setDisableDepthTestDistance(CesiumProperty<Double> value)
```
    Sets the distance from the camera at which to disable the depth test. This can be used to prevent clipping against terrain, for example. When set to zero, the depth test is always applied. When set to Double.POSITIVE_INFINITY, the depth test is never applied. If not specified, the default is 0.0.

Class LabelGraphics

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getShow

setShow

getText

setText

getFont

setFont

getStyle

setStyle

getScale

setScale

getShowBackground

setShowBackground

getBackgroundColor

setBackgroundColor

getBackgroundPadding

setBackgroundPadding

getPixelOffset

setPixelOffset

getEyeOffset

setEyeOffset

getHorizontalOrigin

setHorizontalOrigin

getVerticalOrigin

setVerticalOrigin

getHeightReference

setHeightReference

getFillColor

setFillColor

getOutlineColor

setOutlineColor

getOutlineWidth

setOutlineWidth

getTranslucencyByDistance

setTranslucencyByDistance

getPixelOffsetScaleByDistance

setPixelOffsetScaleByDistance

getScaleByDistance

setScaleByDistance

getDistanceDisplayCondition

setDistanceDisplayCondition

getDisableDepthTestDistance

setDisableDepthTestDistance