Interface used by ILabelStyle implementations to query the actual IVisualCreator, IVisibilityTestable, IBoundsProvider, IHitTestable, IMarqueeTestable, and ILassoTestable implementations for a label and an associated style.
Remarks
Type Details
- yFiles module
- view
See Also
Methods
Gets an implementation of the IBoundsProvider interface that can handle the provided label and its associated style.
Remarks
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to provide an instance for
- style - ILabelStyle
- The style to use for calculating the rendering bounds
Returns
- ↪IBoundsProvider
- An implementation that may be used to subsequently query the label's rendering bounds. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations
Gets a temporary context instance that can be used to query additional information for the label's style.
Remarks
null.Parameters
A map of options to pass to the method.
- label - ILabel
- The label to provide a context instance for.
- style - ILabelStyle
- The style to use for the context.
Returns
- ↪ILookup
- A non-
nulllookup implementation.
See Also
Gets an implementation of the IHitTestable interface that can handle the provided label and its associated style.
Remarks
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to provide an instance for
- style - ILabelStyle
- The style to use for calculating hit tests
Returns
- ↪IHitTestable
- An implementation that may be used to subsequently perform hit tests. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may return
nullto indicate that the label cannot be hit tested.
Gets an implementation of the ILassoTestable interface that can handle the provided label and its associated style.
Remarks
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to provide an instance for
- style - ILabelStyle
- The style to use for calculating lasso intersection tests
Returns
- ↪ILassoTestable
- An implementation that may be used to subsequently query the lasso intersections. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations
Gets an implementation of the IMarqueeTestable interface that can handle the provided label and its associated style.
Remarks
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to provide an instance for
- style - ILabelStyle
- The style to use for calculating marquee intersection tests
Returns
- ↪IMarqueeTestable
- An implementation that may be used to subsequently query the marquee intersections. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations
Calculates the preferredSize of a given label using the associated style.
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to determine the preferred size for
- style - ILabelStyle
- The style to use for calculating the preferred size
Returns
- ↪Size
- A size that can be used as the preferredSize if this renderer renders the label using the associated style.
Gets an implementation of the IVisibilityTestable interface that can handle the provided label and its associated style.
Remarks
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to provide an instance for
- style - ILabelStyle
- The style to use for testing the visibility
Returns
- ↪IVisibilityTestable
- An implementation that may be used to subsequently query the label's visibility. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations
Gets an implementation of the IVisualCreator interface that can handle the provided label and its associated style.
Remarks
null.Parameters
A map of options to pass to the method.
- label - ILabel
- The label to provide an instance for
- style - ILabelStyle
- The style to use for creating the label visualization
Returns
- ↪IVisualCreator
- An implementation that may be used to subsequently create or update the visual for the label. Clients should not cache this instance and must always call this method immediately before using the value returned. This enables the use of the flyweight design pattern for implementations. This method may not return
nullbut should yield a void implementation instead.