Gets the primary color of the indicator style.
A style for use in WebGL2 rendering to render the selection, highlight, or focus indicator of labels.
Inheritance Hierarchy
WebGL2LabelIndicatorStyle
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-webgl
- yfiles-umd modules
- view-webgl, view
- Legacy UMD name
- yfiles.view.WebGL2LabelIndicatorStyle
Constructors
WebGL2LabelIndicatorStyle
(shape?: WebGL2LabelIndicatorShape, type?: WebGL2IndicatorType, thickness?: number, primaryColor?: Color, secondaryColor?: Color, margins?: number, zoomPolicy?: StyleDecorationZoomPolicy, enterTransition?: WebGL2Transition, leaveTransition?: WebGL2Transition, dashStrokeAnimation?: WebGL2AnimationTiming)Creates a new indicator style for labels with WebGL2.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- shape - WebGL2LabelIndicatorShape
- The shape of the label. Defaults to LABEL_SHAPE.
- type - WebGL2IndicatorType
- The type of the indicator. Defaults to a suitable value based on the theme.
- thickness - number
- The total thickness of the indicator style. Defaults to a suitable value based on the theme.
- primaryColor - Color
- The primary color of the indicator style. Defaults to a suitable value based on the theme.
- secondaryColor - Color
- The secondary color used for the outline or background of the indicator style. Defaults to a suitable value based on the theme.
- margins - number
- The margins around the label layout. Defaults to
0
. - zoomPolicy - StyleDecorationZoomPolicy
- How the style is affected by the current zoom level. Defaults to VIEW_COORDINATES.
- enterTransition - WebGL2Transition
- The transition to use when an element enters the indicator state. No visible transition by default.
- leaveTransition - WebGL2Transition
- The transition to use when an element leaves the indicator state. No visible transition by default.
- dashStrokeAnimation - WebGL2AnimationTiming
- 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.
Remarks
By default strokes are not animated and the value is INSTANT.
Gets the transition to apply when this style gets newly applied to a label visualization.
Gets the transition to apply when this style gets removed from a label visualization.
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.
Gets the shape of this style.
Remarks
The default value is LABEL_SHAPE.
Gets the total thickness of the indicator style.
Remarks
The default value is taken from the theme.
Gets the type of the indicator style.
Remarks
The default value is taken from the theme.
Gets how the style is affected by the current zoom level.
Remarks
The default value is VIEW_COORDINATES.