An IEdgeLayout encapsulates the layout information for an edge.
Inheritance Hierarchy
IEdgeLayout
Remarks
The layout information consists of the two end points of the edge layout and a sequence of control points that determine the visual path of the edge.
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.IEdgeLayout
See Also
Properties
Gets or sets the relative coordinates of the first end point of this layout.
Remarks
These coordinates are relative to the center location of the edge's source node. To obtain the absolute coordinates of the end point, the relative coordinates have to be added to the center coordinates of the source INodeLayout.
See Also
Gets or sets the relative coordinates of the second end point of this layout.
Remarks
These coordinates are relative to the center location of the edge's target node. To obtain the absolute coordinates of the end point, the relative coordinates have to be added to the center coordinates of the target INodeLayout.
See Also
Methods
Removes all control points from this edge layout.
Remarks
Returns the control point at the given position in the sequence of control points.
Remarks
The first control point in the sequence has index
0
and the last control point has index pointCount -1
.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- index - number
- the position of the control point in the control point sequence
Returns
- ↪YPoint
- the absolute coordinates of the control point at the given index
See Also
Sets the absolute coordinates of the control point at the given position in the sequence of control points.
Remarks
The first control point in the sequence has index
0
and the last control point has index pointCount -1
.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- index - number
- the position of the changing control point in the sequence
- x - number
- the new absolute x-coordinate of the control point at the given index
- y - number
- the new absolute y-coordinate of the control point at the given index