WebGLLabelIndicatorStyle

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

Inheritance Hierarchy

WebGLLabelIndicatorStyle

Remarks

This style is meant to be used with the nodeLabelStyle, edgeLabelStyle, nodeLabelStyle, edgeLabelStyle, nodeLabelStyle, and 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.

Type Details

yFiles module: view

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.

ParametersOptions Overload

options - Object
A map of options to pass to the method.

shape - WebGLLabelIndicatorShape: The shape of the label. Defaults to LABEL_SHAPE.
type - WebGLIndicatorType: 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: The primary color of the indicator style. Defaults to a suitable value based on the theme of the CanvasComponent.
secondaryColor - Color: 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: How the style is affected by the current zoom level. Defaults to VIEW_COORDINATES.
enterTransition - WebGLTransition: The transition to use when an element enters the indicator state. No visible transition by default.
leaveTransition - WebGLTransition: The transition to use when an element leaves the indicator state. No visible transition by default.
dashStrokeAnimation - WebGLAnimationTiming: The values that specify how the dash/dotted strokes should be animated. No visible animation by default.

Properties

dashStrokeAnimation

: WebGLAnimationTiming

Gets the values that specify how the dash/dotted strokes should be animated.

Remarks

By default strokes are not animated and the value is INSTANT.

enterTransition

: WebGLTransition

Gets the transition to apply when this style gets newly applied to a label visualization.

leaveTransition

: WebGLTransition

Gets the transition to apply when this style gets removed from a label visualization.

margins

: number

Gets the margins around the label layout.

Remarks

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.

primaryColor

: Color

Gets the primary color of the indicator style.

secondaryColor

: Color

Gets the secondary color of the indicator style.

Remarks

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.