C

WebGLNodeIndicatorStyle

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

Remarks

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

See Also

API

WebGLBeaconNodeIndicatorStyle

Members

No filters for this type

Constructors

Creates a new indicator style for nodes with WebGL2.

Parameters

shape?: WebGLNodeIndicatorShape
The shape of the node. Defaults to NODE_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 node 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

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
Gets the transition to apply when this style gets newly applied to a node visualization.
readonlyfinal
Gets the transition to apply when this style gets removed from a node visualization.
readonlyfinal
Gets the margins around the node layout.

Actually, the bounds rendered by the style is the original node layout enlarged by these margins. Taking into account the zoomPolicy, this will either be interpreted in view or world coordinates.

The default margins have a value of 0.

readonlyfinal
Gets the primary color of the indicator style.
readonlyfinal
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
Gets the shape of this style.
The default value is NODE_SHAPE.
readonlyfinal
Gets the total thickness of the indicator style.
The default value is taken from the theme of the CanvasComponent.
readonlyfinal
Gets the type of the indicator style.
The default value is taken from the theme of the CanvasComponent.
readonlyfinal
Gets how the style is affected by the current zoom level.
The default value is VIEW_COORDINATES.
readonlyfinal