Allows the use of an ILabelStyle to render the selection, highlight, or focus indicator of labels.
Remarks
The renderer of the labelStyle used by this class must create SvgVisuals.
The zoomPolicy property defines how the zoom level affects the rendering of the indicator. It can either scale according to the zoom level similar to regular graph items or have always the same thickness regardless of the zoom, similar to the default yFiles indicators.
Type Details
- yFiles module
- view
See Also
Constructors
Create a new instance of this class.
Parameters
A map of options to pass to the method.
- zoomPolicy - StyleIndicatorZoomPolicy
- How the style is affected by the current zoom level. This option sets the zoomPolicy property on the created object.
- margins - Insets
- The margins around the label layout. This option sets the margins property on the created object.
- labelStyle - ILabelStyle
- The style to use for the rendering. This option sets the labelStyle property on the created object.
Properties
Gets or sets the style to use for the rendering.
Remarks
Gets or sets the margins around the label layout.
Remarks
Actually, the bounds rendered by the style are the original label layout enlarged by these margins.
The default margins have a value of 5 for all four sides.
Gets or sets how the style is affected by the current zoom level.
Remarks
Methods
Returns an implementation of IBoundsProvider that can determine the visible bounds of the rendering of the render tag.
Remarks
Parameters
A map of options to pass to the method.
- renderTag - ILabel
- the render tag to query the bounds for
Returns
- ↪IBoundsProvider
- An implementation of IBoundsProvider to determine the bounds of the visualization.
Implements
Returns an implementation of IHitTestable that can determine whether the rendering of the render tag has been hit at a given coordinate.
Remarks
Parameters
A map of options to pass to the method.
- renderTag - ILabel
- the render tag to do the hit testing for
Returns
- ↪IHitTestable
- An implementation of IHitTestable to determine visibility.
Implements
Returns an implementation of IVisibilityTestable that can determine if the rendering of the render tag would be visible in a given context.
Remarks
Parameters
A map of options to pass to the method.
- renderTag - ILabel
- the render tag to query visibility for
Returns
- ↪IVisibilityTestable
- An implementation of IVisibilityTestable to determine visibility.
Implements
Returns an implementation of IVisualCreator that will create the Visual tree for the render tag.
Remarks
Parameters
A map of options to pass to the method.
Returns
- ↪IVisualCreator
- An implementation of IVisualCreator to create or update the visualization.