LinkPath
extends Path
The LinkPath class represents a link in a node-link visualization. To create a LinkPath object, use the mark method in the Scene class, for example:
let link = scene.mark("link", {strokeColor: "#eee", mode: "curveVertical"});
Properties
| property | explanation | type | default value |
|---|---|---|---|
| mode | how the link will be drawn, current supports three modes: “linear”, “curveHorizontal”, and “curveVertical” | String | “linear” |
source  | the mark representing the source node | Mark | |
| target | the mark representing the target node | Mark | |
| sourceAnchor | the anchor of the source mark this link is attached to | Array | [“center”, “middle”] |
| targetAnchor | the anchor of the target mark this link is attached to | Array | [“center”, “middle”] |
| sourceOffset | the offset between this link and the source mark’s anchor | Array | [0, 0] |
| targetOffset | the offset between this link and the target mark’s anchor | Array | [0, 0] |
Properties inherited from Path
| property | explanation | type | default value |
|---|---|---|---|
| bounds | the bounding rectangle of the path | Rectangle | |
| x | the x coordinate of the center of the arc | Number | 0 |
| y | the y coordinate of the center of the arc | Number | 0 |
| vertices | the vertices along the path | Array | |
| segments | the segments on the path | Array | |
| firstVertex | returns the first vertex of the path | Vertex | |
| firstSegment | returns the first segment of the path | Segment | |
| fillColor | the fill color of the path if it is closed | Color | undefined |
| strokeColor | the stroke color of the path | Color | “#ccc” |
| strokeDash | the dashes and gaps for the path stroke | String | “none” |
| strokeWidth | the stroke width of the path in pixels | Number | 1 |
| opacity | the opacity value of the path (between 0 and 1) | Number | 1 |
| vxShape | the shape of the vertices on this path possible values: “rect”, “circle” | String | undefined |
| vxWidth | the width of the vertices on this path | Number | 0 |
| vxHeight | the height of the vertices on this path | Number | 0 |
| vxRadius | the radius of the vertices on this path if the shape is “circle” | Number | 0 |
| vxFillColor | the fill color of the vertices on this path | Color | “#555” |
| vxStrokeColor | the stroke color of the vertices on this path | Color | “#aaa” |
| vxStrokeWidth | the stroke width of the vertices on this path in pixels | Number | 0 |
| vxOpacity | the opacity of the vertices on this path | Number | 1 |
Properties inherited from Mark
| property | explanation | type | default value |
|---|---|---|---|
| id | the unique id of the path | String | |
| type | the type of the path | String | “circle” |
| dataScope | the data scope of the path | DataScope | undefined |
Methods
| method | explanation | return type |
|---|---|---|
| getPointAt(frac) | get the coordinates of a point at the specified location on the link frac (Number): between 0 (start of link) and 1 (end of link) | Point |
Methods inherited from Path
| method | explanation | return type |
|---|---|---|
| getSVGPathData() | returns a string to be used as the d parameter in an SVG path element | String |
Methods inherited from Mark
| method | explanation | return type |
|---|---|---|
| contains(x, y) | whether this mark contains a point x (Number): x coordinate of the point y (Number): y coordinate of the point | Boolean |
| getScene() | returns the scene in which this mark resides | Scene |
| duplicate() | returns a copy of this mark | ArcPath |