C

WebGLEdgeIndicatorStyle

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

Remarks

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

WebGLEdgeIndicatorStyle

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

Parameters

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.
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
readonly
Gets the values that specify how the dash/dotted strokes should be animated.
By default strokes are not animated and the value is INSTANT.
readonlyfinal

enterTransition

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

leaveTransition

: WebGLTransition
readonly
Gets the transition to apply when this style gets removed from an edge visualization.
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

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 HATCH_BRUSH.
readonlyfinal

zoomPolicy

: StyleIndicatorZoomPolicy
readonly
Gets how the style is affected by the current zoom level.
The default value is VIEW_COORDINATES.
readonlyfinal