TextElement this state represents
Optional index for TextElements of type LineMarker.
TextElement this state represents
Returns the icon render state for the case where the text element has only one icon.
The icon render state if the text element has a single icon, otherwise undefined.
Returns the index into the path of the TextElement if the TextElement is of type LineMarker,
undefined
otherwise.
Returns the position of the TextElement. If this TextElementState belongs to a TextElement of type LineMarker, it returns the position of the marker at the references index in the path of the TextElement.
Return the last distance that has been computed for sorting during placement. This may not be
the actual distance if the camera is moving, as the distance is computed only during
placement. If the property alwaysOnTop
is true, the value returned is always 0
.
0 or negative distance to camera.
Return the last text placement used.
If the text wasn't yet rendered or have no alternative placements it will fallback to style/theme based placement.
TextPlacement object containing vertical/horizontal align.
Set text placement to be used.
This may be base text anchor placement as defined by style or alternative placement.
The new TextPlacement to be used.
TextPlacement object containing vertical/horizontal align.
The text render state.
Returns the last computed distance of the text element to the camera.
Distance to camera.
true
if any component of the element is visible, false
otherwise.
Returns information if the text placement provided is the base one defined in style (theme).
The TextPlacement to check.
[[true]] if the placement provided is exactly the same as in theme base layout, [[false]] if it differs from the basic layout provided in style or [[undefined]] if the layout style is not yet defined so it is hard to say.
Replaces given text element, inheriting its current state. The predecessor text element state is erased.
Text element state to be replaced.
Resets the element to an initialized state.
Sets the distance of the element to the current view center.
The new view distance to set. If undefined
, element is considered to
be out of view.
Updates the text element state.
The new view distance to set. If undefined
, element is considered to
be out of view.
Updates the fading state to the specified time.
The current time.
If True
there will be no fading transitions, i.e., state will go
directly from FadedIn to FadedOut and vice versa.
Generated using TypeDoc
TextElementState
keeps the current state of a text element while it's being rendered.