Click or drag to resize

LabelGraphics Class

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.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.CesiumLabelGraphics

Namespace:  AGI.Foundation.Cesium
Assembly:  AGI.Foundation.Cesium (in AGI.Foundation.Cesium.dll) Version: 20.3.405.0 (20.3.405.0)
Syntax
public class LabelGraphics

The LabelGraphics type exposes the following members.

Constructors
  NameDescription
Public methodLabelGraphics
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyBackgroundColor
Gets or 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.
Public propertyBackgroundPadding
Gets or 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.
Public propertyDisableDepthTestDistance
Gets or 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 PositiveInfinity, the depth test is never applied. If not specified, the default is 0.0.
Public propertyDistanceDisplayCondition
Gets or sets the distances from the camera at which this label will be displayed. If not specified, the label is displayed regardless of camera distance.
Public propertyEyeOffset
Gets or sets the label's offset from the origin in eye coordinates. Eye coordinates are specified in a left-handed coordinate system where X points toward the viewer's right, Y points up, and Z points into the screen. If not specified, the default is Zero.
Public propertyFillColor
Gets or sets the fill color of the label. This property only has an effect if Style is Fill or FillAndOutline. If not specified, the default is White.
Public propertyFont
Gets or 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".
Public propertyHeightReference
Gets or sets the height reference of the label. If not specified, the default is None.
Public propertyHorizontalOrigin
Gets or sets whether the label is left, center, or right-aligned with the origin. If not specified, the default is Center.
Public propertyOutlineColor
Gets or sets the outline color of the label. This property only has an effect if Style is Outline or FillAndOutline. If not specified, the default is Black.
Public propertyOutlineWidth
Gets or sets the outline width of the label. This property only has an effect if Style is Outline or FillAndOutline. If not specified, the default is 1.0.
Public propertyPixelOffset
Gets or sets the label's offset from the origin in pixel coordinates. The Y coordinate moves the label upwards, and the X coordinate moves the label to the right. If not specified, the default is Zero.
Public propertyPixelOffsetScaleByDistance
Gets or 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. If not specified, then the pixel offset does not change based on the camera distance.
Public propertyScale
Gets or sets the scale of the label text. If not specified, the default is 1.0.
Public propertyScaleByDistance
Gets or 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. If not specified, then the scale does not change based on the camera distance.
Public propertyShow
Gets or sets whether or not the label is shown. If not specified, the default is .
Public propertyShowBackground
Gets or sets whether or not a background behind the label is shown. If not specified, the default is .
Public propertyStyle
Gets or sets the style of the label. If not specified, the default is Fill.
Public propertyText
Gets or sets the text of the label. A newline character (\n) indicates line breaks.
Public propertyTranslucencyByDistance
Gets or 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.
Public propertyVerticalOrigin
Gets or sets whether the label is bottom, center, or top-aligned with the origin. If not specified, the default is Center.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also