Defines the geometry of ILabel instances with respect to specific ILabelModelParameters.
Remarks
In addition to defining the geometry of a label with respect to a specific ILabelModelParameter, a label model is typically the factory of the label model parameters that are compatible with it, too.
Typically, the label model defines a, possibly infinite, compilation of valid geometries for labels, and a specific label model parameter specifies an exact geometry for a label.
By design, the same instance of a label model can be shared by multiple label model parameters. Similarly, the same instance of a label model parameter can be shared by multiple labels.
This interface provides the getContext method that can be used to query additional aspects of the implementation.
Type Details
- yFiles module
- view
See Also
Methods
Provides a lookup context for the given label.
Calculates the geometry of the given label using the given model parameter.
Parameters
A map of options to pass to the method.
- label - ILabel
- The label to calculate the geometry for.
- layoutParameter - ILabelModelParameter
- A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property model returns this instance.
Returns
- ↪IOrientedRectangle
- An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.