C

WebGLLabelIndicatorStyle

Show Usages
A style for use in WebGL2 rendering to render the selection, highlight, or focus indicator of labels.
Inheritance Hierarchy

Remarks

This style is meant to be used with the WebGLSelectionIndicatorManager.nodeLabelStyle, WebGLSelectionIndicatorManager.edgeLabelStyle, WebGLHighlightIndicatorManager.nodeLabelStyle, WebGLHighlightIndicatorManager.edgeLabelStyle, WebGLFocusIndicatorManager.nodeLabelStyle, and WebGLFocusIndicatorManager.nodeLabelStyle properties. It is implemented as an immutable class. All properties need to be set at construction time. The instance properties are all read-only.

Members

No filters for this type

Constructors

WebGLLabelIndicatorStyle

(
shape?: WebGLLabelIndicatorShape
type?: WebGLIndicatorType
thickness?: number
primaryColor?: Color
secondaryColor?: Color
margins?: number
zoomPolicy?: StyleIndicatorZoomPolicy
enterTransition?: WebGLTransition
leaveTransition?: WebGLTransition
dashStrokeAnimation?: WebGLAnimationTiming
)
Creates a new indicator style for labels with WebGL2.

Parameters

shape?: WebGLLabelIndicatorShape
conversion
The shape of the label. Defaults to WebGLLabelIndicatorShape.LABEL_SHAPE.
type?: WebGLIndicatorType
conversion
The type of the indicator. Defaults to a suitable value based on the theme of the CanvasComponent.
thickness?: number
The total thickness of the indicator style. Defaults to a suitable value based on the theme of the CanvasComponent.
primaryColor?: Color
conversion
The primary color of the indicator style. Defaults to a suitable value based on the theme of the CanvasComponent.
secondaryColor?: Color
conversion
The secondary color used for the outline or background of the indicator style. Defaults to a suitable value based on the theme of the CanvasComponent.
margins?: number
The margins around the label layout. Defaults to a suitable value based on the theme of the CanvasComponent.
zoomPolicy?: StyleIndicatorZoomPolicy
conversion
How the style is affected by the current zoom level. Defaults to StyleIndicatorZoomPolicy.VIEW_COORDINATES.
enterTransition?: WebGLTransition
conversion
The transition to use when an element enters the indicator state. No visible transition by default.
leaveTransition?: WebGLTransition
conversion
The transition to use when an element leaves the indicator state. No visible transition by default.
dashStrokeAnimation?: WebGLAnimationTiming
conversion
The values that specify how the dash/dotted strokes should be animated. No visible animation by default.

Properties

dashStrokeAnimation

: WebGLAnimationTiming
readonly
Gets the values that specify how the dash/dotted strokes should be animated.
By default strokes are not animated and the value is WebGLAnimationTiming.INSTANT.
readonlyfinal

enterTransition

: WebGLTransition
readonly
Gets the transition to apply when this style gets newly applied to a label visualization.
readonlyfinal

leaveTransition

: WebGLTransition
readonly
Gets the transition to apply when this style gets removed from a label visualization.
readonlyfinal

margins

: number
readonly
Gets the margins around the label layout.

Actually, the bounds rendered by the style is the original label layout enlarged by these margins. Taking into account the zoomPolicy, this will either be interpreted in view or world coordinates. If not specified explicitly, this will be adopted from the theme.

The default margins have a value of 0.

readonlyfinal

primaryColor

: Color
readonly
Gets the primary color of the indicator style.
readonlyfinal

secondaryColor

: Color
readonly
Gets the secondary color of the indicator style.
For indicator styles with borders this will represent the color of the outline while, for other styles like dash, dotted or stripes this will represent the background color. For the hatch brush, this will be the second color.
readonlyfinal

shape

: WebGLLabelIndicatorShape
readonly
Gets the shape of this style.
readonlyfinal

thickness

: number
readonly
Gets the total thickness of the indicator style.
The default value is taken from the theme of the CanvasComponent.
readonlyfinal

type

: WebGLIndicatorType
readonly
Gets the type of the indicator style.
The default value is taken from the theme of the CanvasComponent.
readonlyfinal

zoomPolicy

: StyleIndicatorZoomPolicy
readonly
Gets how the style is affected by the current zoom level.
readonlyfinal