This model parameter encodes a label position within FreeEdgeLabelLayoutModel.
Inheritance Hierarchy
FreeEdgeLabelLayoutModelParameter
Remarks
It represents every possible location in relation to the source point of the edge. The radius describes the distance of the label center from the source point. There is an angle
theta which defines the location on the circle with the given radius. It is the angle between the first segment of the underlying edge and the imaginary line to the center of the label. Finally, there is a second angle that describes the rotation of the label box.Default Values of Properties
| angle | 0 | The label is placed paraxial. |
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.FreeEdgeLabelLayoutModelParameter
See Also
Constructors
Creates a new instance of FreeEdgeLabelLayoutModelParameter with radius 50 and angle 0.
Creates a new instance of FreeEdgeLabelLayoutModelParameter with the given radius, angle and rotation angle.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- radius - number
- the distance of the label from the source node of the underlying edge
- theta - number
- the angle in radians between the first segment of the underlying edge and the imaginary line to the center of the label
- angle - number
- the rotation angle of the label
Properties
Gets a point that represents the location of the label's center in relation to the source point of the edge.
Remarks
The x-coordinate corresponds to the radius which describes the distance of the label to the source point. The y-coordinate corresponds to the angle between the first segment of the underlying edge and the imaginary line to the center of the label.
Methods
Specifies a point that represents the location of the label's center in relation to the source point of the edge.
Remarks
The x-coordinate corresponds to the radius which describes the distance of the label to the source point. The y-coordinate corresponds to the angle between the first segment of the underlying edge and the imaginary line to the center of the label.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- radius - number
- the distance to the source point
- theta - number
- the location on the radius