A label model that can be used to describe any position and orientation of a label.
Inheritance Hierarchy
FreeLabelModel
Implemented Interfaces
Remarks
The position of the label is stored absolutely and is not influenced by the layout or position of the owner of the label. In fact the owner is not even queried during a call to getGeometry.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.FreeLabelModel
See Also
Methods
Creates a new label model parameter that places the label at the given absolute position using the provided angle.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- anchorLocation - Point
- The location for the parameter.
- angle - number
- The angle of rotation. The default is 0.
Returns
- ↪ILabelModelParameter
- A new parameter that is associated with this instance.
Creates a new label at the given dynamic location using the provided angle.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- location - IPoint
- The location to place the parameter at. That instance is stored by reference.
- angle - number
- The angle of rotation. The default is 0.
Returns
- ↪ILabelModelParameter
- A new parameter that is associated with this instance.
Creates a default parameter that can be used for this model.
Creates a new label model parameter that dynamically reads the label layout from the provided instance.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- layout - IOrientedRectangle
- The oriented rectangle to dynamically retrieve the values from.
Returns
- ↪ILabelModelParameter
- A new parameter that is associated with this instance.
findBestParameter
(label: ILabel, model: ILabelModel, layout: IOrientedRectangle) : ILabelModelParameterTries to find a parameter that best matches the given layout for the provided label instance.
Remarks
This method may not necessarily find a parameter that matches the provided layout exactly. Implementations may choose to simply return the model's default parameter but may never 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 find a parameter for.
- model - ILabelModel
- The model instance to use. This should be the instance this instance has been obtained from.
- 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.
Implements
Provides a lookup context for the given combination of label and parameter.
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 use in the context.
- layoutParameter - ILabelModelParameter
- The parameter to use for the label in the context.
Returns
- ↪ILookup
- An implementation of the ILookup interface that can be used to query additional aspects of the label/parameter combination.
See Also
Implements
Calculates the geometry of the given label using the given model parameter.
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 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.
Implements
Returns an instance that implements the given type or null.
Remarks
Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-
null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.Type Parameters
- T: any
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- type - Class<T>
- The type for which an instance shall be returned.
Returns
- ↪T
- an instance that is assignable to type or
null
See Also
Implements
Constants
A shared public instance that can be used to obtain parameters.