Implementations of this interface can be used to find the best ILabelModelParameter to approximate a given layout for a given ILabelModel.
Inheritance Hierarchy
ILabelModelParameterFinder
Remarks
Implementations of this interface may be retrieved from getContext implementations using their lookup method. Note that ILabelModel implementations are not required to return an instance if queried for this interface.
Type Details
- yFiles module
- view
Methods
Tries to find a parameter that best matches the given layout for the label instance whose lookup returned this finder.
Remarks
This method does not necessarily have to find a parameter that exactly matches the specified layout.
Implementations may choose to simply return the current parameter of the label, but must never return null.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- layout - IOrientedRectangle
- The anticipated layout for the label.
Returns
- ↪ILabelModelParameter
- A non-
nullparameter that can be used for the label to approximate the provided layout.