This port label model can be used to specify any position and orientation of a label.
Remarks
The position of the label is stored relative to the position of the port the label belongs to.
Type Details
- yFiles module
- view
Methods
createParameter
(locationOffset: Point, labelRatio: Point, labelOffset?: Point, angle?: number) : FreePortLabelModelParameterCreates a parameter instance that anchors the label to the port at a given position.
Remarks
The parameter will use the ratio and offset values to determine a point on both the label and the port. It will place the label in such a way that both points coincide.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- locationOffset - Point
- The offset to apply to the port's location.
- labelRatio - Point
- The ratio that describes the point on the label's layout relative to its size.
- labelOffset - Point
- The offset to apply to the point on the label after the ratio has been determined. This defaults to (0,0), representing no further offset.
- angle - number
- The angle by which the label should be rotated around the point described using the ratio and offset, measured in radians. The default is 0.
Returns
- ↪FreePortLabelModelParameter
- A parameter that exactly fits the described location.
Throws
- Exception({ name: 'ArgumentError' })
locationOffset,labelRatioorlabelOffsetcontains one or more NaN values.
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 predefined parameter instance that places the label anchored at the center of the port and has no rotation.
A shared public instance that can be used to obtain parameters.