C

WebGLBeaconNodeIndicatorStyle

Show Usages
A selection, highlight, or focus style which renders a beacon effect around nodes using WebGL2.
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

WebGLNodeIndicatorStyle

Members

No filters for this type

Constructors

WebGLBeaconNodeIndicatorStyle

(
shape?: WebGLNodeIndicatorShape
type?: WebGLBeaconAnimationType
color?: Color
pulseWidth?: number
pulseCount?: number
pulseDistance?: number
magnitude?: number
smooth?: boolean
zoomPolicy?: StyleIndicatorZoomPolicy
enterTransition?: WebGLTransition
leaveTransition?: WebGLTransition
timing?: WebGLAnimationTiming
)
Creates a new beacon indicator style for nodes with WebGL2.

Parameters

shape?: WebGLNodeIndicatorShape
The shape of the node. Defaults to NODE_SHAPE.
type?: WebGLBeaconAnimationType
The type of the beacon. Defaults to FADE.
color?: Color
The color of the beacon. Defaults to black if not specified.
pulseWidth?: number
The thickness of a single beacon pulse. Defaults to 4.
pulseCount?: number
How many beacon pulses should be simultaneously visible. Defaults to 1.
pulseDistance?: number
The distance between multiple beacon pulses. Defaults to 20.
magnitude?: number
The distance the beacon extends to. Defaults to 50.
smooth?: boolean
Whether to draw each pulse smoothly or with hard edges. Defaults to true.
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.

If no transition or a SCALE transition is specified, the beacon animation will immediately start when a node enters the indicator state.

leaveTransition?: WebGLTransition

The transition to use when an element leaves the indicator state. No visible transition by default.

If no transition is specified, the beacon animation will stop immediately when the node leaves the indicator state. If an OPACITY transition is specified, the beacon animation will continue for the duration of the transition while fading out. If a SCALE transition is specified, the beacon animation will finish it's current iteration and will not start another iteration, even if there is transition time remaining.

timing?: WebGLAnimationTiming
Specifies the timing function to use for the beacon animation. Defaults to "1s linear infinite normal".

Properties

animationTiming

: WebGLAnimationTiming
readonly
Gets the values that specify how the beacon should be animated.
The default is "1s linear infinite normal".
readonlyfinal

color

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

enterTransition

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

leaveTransition

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

magnitude

: number
readonly
The distance the beacon extends to.
Defaults to 50.
readonlyfinal

pulseCount

: number
readonly
How many beacon pulses should be simultaneously visible.
Defaults to 1.
readonlyfinal

pulseDistance

: number
readonly
The distance between multiple beacon pulses.
Defaults to 20.
readonlyfinal

pulseWidth

: number
readonly
Gets thickness of a single beacon pulse.
Defaults to 4.
readonlyfinal

shape

: WebGLNodeIndicatorShape
readonly
Gets the shape of this style.
The default value is NODE_SHAPE.
readonlyfinal

smooth

: boolean
readonly
Whether to draw each pulse smoothly or with hard edges.
The default is true
readonlyfinal

type

: WebGLBeaconAnimationType
readonly
Gets the type of the indicator style.
The default value is FADE.
readonlyfinal

zoomPolicy

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