A void implementation of a label style renderer that does nothing.
Remarks
This class implements the singleton pattern. Use the shared static INSTANCE of this class instead of
null
where null
is not allowed. For example you cannot assign null
to the renderer property of an ILabelStyle.Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.styles.VoidLabelStyleRenderer
Methods
Yields the EMPTY that will return empty bounds.
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
Implements
Yields a lookup that will only return NEVER if an ILassoTestable is queried.
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-
null
lookup implementation.
See Also
Implements
Yields the NEVER that will always report misses.
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
null
to indicate that the label cannot be hit tested.
Implements
Yields the NEVER that will always report misses.
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
Implements
Yields EMPTY.
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
Implements
Yields the NEVER that will always claim invisibility.
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
Implements
Yields the INSTANCE that will do nothing.
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
null
but should yield a void implementation instead.
See Also
Implements
Constants
The singleton instance of this renderer.