Interface used by ILabelStyle implementations to query the actual IVisualCreator, IVisibilityTestable, IBoundsProvider, IHitTestable, and IMarqueeTestable implementations for a label and an associated style.
Inheritance Hierarchy
Remarks
Implementations of this interface should be designed to be sharable between multiple style instances and should therefore not contain style specific state.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.ILabelStyleRenderer
See Also
ILabelStyle,
ILabel,
INodeStyleRenderer,
IEdgeStyleRenderer,
IPortStyleRenderer,
Separating Style and Renderer,
The Preferred Label Size
Methods
Gets an implementation of the IBoundsProvider interface that can handle the provided label and its associated style.
Remarks
This method may return a flyweight implementation.
Parameters
options - Object
A map of options to pass to the method.
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 the calculating the painting bounds
Returns
- ↪IBoundsProvider
- An implementation that may be used to subsequently query the label's painting 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
Implementations may return EMPTY if they don't support this, but may not return
null.Parameters
options - Object
A map of options to pass to the method.
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
- An non-
nulllookup implementation.
See Also
Gets an implementation of the IHitTestable interface that can handle the provided label and its associated style.
Remarks
This method may return a flyweight implementation.
Parameters
options - Object
A map of options to pass to the method.
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 the querying 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 IMarqueeTestable interface that can handle the provided label and its associated style.
Remarks
This method may return a flyweight implementation.
Parameters
options - Object
A map of options to pass to the method.
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 the querying marquee intersection test.
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 preferred size of a given label using the associated style.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- label - ILabel
- The label to determine the preferred size for
- style - ILabelStyle
- The style instance that uses this instance as its renderer
Returns
- ↪Size
- A size that can be used as the preferredSize if this renderer renders the label using the associated style.
See Also
Gets an implementation of the IVisibilityTestable interface that can handle the provided label and its associated style.
Remarks
This method may return a flyweight implementation.
Parameters
options - Object
A map of options to pass to the method.
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 the 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
This method may return a flyweight implementation, but never
null.Parameters
options - Object
A map of options to pass to the method.
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 the creation of the visual
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.