Direct Edge Shape
The Direct edge shape can be configured by calling the setDefaults method on CanvasBuilder.
const element = document.getElementById('canvas');
const canvas = new CanvasBuilder(element)
.setDefaults({
edges: {
shape: {
type: "direct",
},
},
})
.build();
In addition to type: "direct", the following options are available:
| Name | Type | Description | Required | Default |
|---|---|---|---|---|
| color | string | Color of the line and arrows | no | "#777777" |
| width | number | Line width | no | 1 |
| arrowRenderer | ArrowRenderer | Arrow shape | no | {} |
| arrowLength | number | Full length of the arrow | no | 20 |
| sourceOffset | number | Empty space distance from source port to an edge | no | 0 |
| targetOffset | number | Empty space distance from target port to an edge | no | 0 |
| hasSourceArrow | boolean | Draw an arrow near the source port | no | false |
| hasTargetArrow | boolean | Draw an arrow near the target port | no | false |
Alternatively, you can create a Direct shape by passing a factory function into the configuration.
import { DirectEdgeShape } from "@html-graph/html-graph";
const element = document.getElementById('canvas');
const canvas = new CanvasBuilder(element)
.setDefaults({
edges: {
shape: (edgeId) => new DirectEdgeShape({ hasTargetArrow: true })
},
})
.build();
All parameters are the same as specified in the table.
You can also apply the Direct shape to a specific edge using the addEdge and updateEdge methods.
import { DirectEdgeShape } from "@html-graph/html-graph";
canvas.addEdge({
from: "port-1",
to: "port-2",
shape: new DirectEdgeShape(),
});
canvas.updateEdge("edge-1", {
from: "port-3",
to: "port-4",
shape: new DirectEdgeShape(),
});