Link
extends Path
The Link mark represents a link in a node-link visualization. Link marks are typically used together with node marks when repeating a network or tree dataset.
Properties#
| property | explanation | type | default value |
|---|
source  | the mark representing the source node | Mark | |
sourceAnchor  | the anchor of the source mark this link is attached to | Array | [“center”, “middle”] |
sourceOffset  | the offset between this link and the source mark’s anchor | Array | [0, 0] |
target  | the mark representing the target node | Mark | |
targetAnchor  | the anchor of the target mark this link is attached to | Array | [“center”, “middle”] |
targetOffset  | the offset between this link and the target mark’s anchor | Array | [0, 0] |
Properties inherited from Path#
| property | explanation | type | default value |
|---|
firstSegment  | returns the first segment of the path | Segment | |
firstVertex  | returns the first vertex of the path | Vertex | |
segments  | the segments on the path | Array of Segment | |
vertices  | the vertices along the path | Array of Vertex | |
| vxFillColor | the fill color of the vertices on this path | Color | “#555555” |
| vxHeight | the height of the vertices on this path | Number | 0 |
| vxOpacity | the opacity of the vertices on this path | Number | 1 |
| vxRadius | the radius of the vertices on this path if the shape is “circle” | Number | 0 |
| vxShape | the shape of the vertices on this path possible values: “rect”, “circle” | String | undefined |
| vxStrokeColor | the stroke color of the vertices on this path | Color | “#aaaaaa” |
| vxStrokeWidth | the stroke width of the vertices on this path in pixels | Number | 0 |
| vxWidth | the width of the vertices on this path | Number | 0 |
x  | the x coordinate of the center of the link bounds | Number | |
y  | the y coordinate of the center of the link bounds | Number | |
Properties inherited from Mark#
| property | explanation | type | default value |
|---|
bounds  | the bounding rectangle of the mark | Rectangle | |
| dataScope | the data scope of the mark | DataScope | undefined |
| fillColor | the fill color of the mark | Color | “none” |
id  | the unique id of the mark | String | |
| opacity | the opacity value of the mark (between 0 and 1) | Number | 1 |
| strokeColor | the stroke color of the mark | Color | “#ccc” |
| strokeDash | the dashes and gaps for the mark stroke | String | “none” |
| strokeWidth | the stroke width of the mark in pixels | Number | 1 |
type  | the type of the mark | String | “link” |
| visibility | whether the mark is visible (“visible” or “hidden”) | String | “visible” |
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 |