A foundational implementation of ILabelStyle that delegates its behavior to several style instances.
Remarks
This class can be used to combine multiple SVG-based style instances into one.
The following aspects will be delegated to all instances:
- creating and updating the visuals.
- testing for visibility.
- hit testing.
- calculating the total bounds of the label.
- determining if a label is within a rectangular marquee selection area.
- determining if a label is within a lasso selection path.
The following aspects will be delegated to the first/main style, only:
This class can be subclassed like LabelStyleBase<TVisual> to allow for custom implementations of the various aspects of the delegation.
Type Details
- yFiles module
- view
Constructors
Creates a new instance of this style.
Parameters
A map of options to pass to the method.
- mainStyle - ILabelStyle
- The main style which will be rendered first and to which all requests will delegate to.
- additionalStyles - ILabelStyle
- Additional styles which will be rendered on top and which will also be included in the hit-, visibility-, and bounds tests.
Properties
Gets the renderer implementation for this instance.
Remarks
Implements
Gets a readonly list of the styles used by this instance.
Remarks
Methods
Returns a memberwise clone.
Creates the visual by delegating to all styles.
Remarks
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The render context.
- label - ILabel
- The label to which this style instance is assigned.
Returns
- ↪Visual?
- The visual as required by the createVisual interface.
See Also
Implements
Calculates the bounds as the union of bounds from all styles.
Parameters
A map of options to pass to the method.
- context - ICanvasContext
- The canvas context.
- label - ILabel
- The label to which this style instance is assigned.
Returns
- ↪Rect
- The visual bounds of the visual representation.
Overrides
Gets the size from the first style as the reference.
Checks whether any style is hit at the given location.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context.
- location - Point
- The point to test.
- label - ILabel
- The label to which this style instance is assigned.
Returns
- ↪boolean
trueif the specified label is hit;falseotherwise.
Overrides
Determines if the label is in the box based on any style.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context.
- rectangle - Rect
- The marquee selection box.
- label - ILabel
- The label to which this style instance is assigned.
Returns
- ↪boolean
trueif the specified label is visible and selected by the marquee rectangle;falseotherwise.
Overrides
Determines if the label is in the path based on any style.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context.
- path - GeneralPath
- The lasso selection path.
- label - ILabel
- The label to which this style instance is assigned.
Returns
- ↪boolean
trueif the specified label is visible and selected by the lasso path;falseotherwise.
Overrides
Determines visibility based on the visibility of all styles.
Parameters
A map of options to pass to the method.
- context - ICanvasContext
- The canvas context.
- rectangle - Rect
- The clipping rectangle.
- label - ILabel
- The label to which this style instance is assigned.
Returns
- ↪boolean
trueif the specified label is visible in the clipping rectangle;falseotherwise.
Overrides
Performs a lookup using the first style as the reference.
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to use for the context lookup.
- type - Constructor
- The type to query.
Returns
- ↪any?
- An implementation of the
typeornull.
Overrides
Updates the visual by delegating to all styles.
Remarks
Parameters
A map of options to pass to the method.
- context - IRenderContext
- The render context.
- oldVisual - Visual
- The visual that has been created in the call to createVisual.
- label - ILabel
- The label to which this style instance is assigned.
Returns
- ↪Visual?
- The visual as required by the createVisual interface.