DynamicLabel

Members

eyeOffset :DynamicProperty

A DynamicProperty of type CzmlCartesian3 which determines the label's eye offset.

Default Value:

• undefined

fillColor :DynamicProperty

A DynamicProperty of type CzmlColor which determines the label's fill color.

Default Value:

• undefined

font :DynamicProperty

A DynamicProperty of type CzmlString which determines the label's font.

Default Value:

• undefined

horizontalOrigin :DynamicProperty

A DynamicProperty of type CzmlHorizontalOrigin which determines the label's horizontal origin.

Default Value:

• undefined

outlineColor :DynamicProperty

A DynamicProperty of type CzmlColor which determines the label's outline color.

Default Value:

• undefined

outlineWidth :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the label's outline width.

Default Value:

• undefined

pixelOffset :DynamicProperty

A DynamicProperty of type CzmlCartesian2 which determines the label's pixel offset.

Default Value:

• undefined

scale :DynamicProperty

A DynamicProperty of type CzmlNumber which determines the label's scale.

Default Value:

• undefined

show :DynamicProperty

A DynamicProperty of type CzmlBoolean which determines the label's visibility.

Default Value:

• undefined

style :DynamicProperty

A DynamicProperty of type CzmlLabelStyle which determines the label's style.

Default Value:

• undefined

text :DynamicProperty

A DynamicProperty of type CzmlString which determines the label's text.

Default Value:

• undefined

verticalOrigin :DynamicProperty

A DynamicProperty of type CzmlVerticalOrigin which determines the label's vertical origin.

Default Value:

• undefined

Methods

<static> mergeProperties

Given two DynamicObjects, takes the label properties from the second and assigns them to the first, assuming such a property did not already exist. This method is not normally called directly, but is part of the array of CZML processing functions that is passed into the CompositeDynamicObjectCollection constructor.

Parameters:

Name	Type	Description
targetObject	DynamicObject	The DynamicObject which will have properties merged onto it.
objectToMerge	DynamicObject	The DynamicObject containing properties to be merged.

See:

• CzmlDefaults

<static> processCzmlPacket

Processes a single CZML packet and merges its data into the provided DynamicObject's label. If the DynamicObject does not have a label, one is created. This method is not normally called directly, but is part of the array of CZML processing functions that is passed into the DynamicObjectCollection constructor.

Parameters:

Name	Type	Description
dynamicObject	DynamicObject	The DynamicObject which will contain the label data.
packet	Object	The CZML packet to process.

Returns:

Boolean true if any new properties were created while processing the packet, false otherwise.

See:

• DynamicObject
• DynamicProperty
• DynamicObjectCollection
• CzmlDefaults#updaters

<static> undefineProperties

Given a DynamicObject, undefines the label associated with it. This method is not normally called directly, but is part of the array of CZML processing functions that is passed into the CompositeDynamicObjectCollection constructor.

Parameters:

Name	Type	Description
dynamicObject	DynamicObject	The DynamicObject to remove the label from.

See:

• CzmlDefaults