An edge label model that can be used to describe any position and orientation of a label.
Remarks
The position of the label is stored relative to the positions of the ports of the edge the label belongs to.
Type Details
- yFiles module
- view
Constructors
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- edgeRelativeAngle - boolean
- A property that indicates whether the angle used by the parameter should be interpreted relative to the edge's orientation or as an absolute angle in the coordinate system. This option sets the edgeRelativeAngle property on the created object.
Properties
Gets or sets a property that indicates whether the angle used by the parameter should be interpreted relative to the edge's orientation or as an absolute angle in the coordinate system.
Remarks
By default, the angle is interpreted to be relative to the world coordinate axes.
Methods
Creates a parameter for the given location.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- ratio - number
- The ratio at which the label will be anchored between the location of the source port and the location of the target port. The default is 0.5.
- distance - number
- The distance orthogonally to the connection between the source and target point. The default is 0.
- angle - number
- The angle by which the label should be rotated. The default is 0.
Returns
- ↪FreeEdgeLabelModelParameter
- A parameter that describes the position.
See Also
Tries to find a parameter that best matches the given layout for the provided label instance.
Remarks
This implementation will match the provided layout perfectly.
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.
- 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.
Provides a lookup context for the given label.
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
Constants
A shared unmodifiable public instance that can be used to obtain parameters.