HTMLGraph logo HTMLGraph

Horizontal Edge Shape

The Horizontal 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: "horizontal",
      },
    },
  })
  .build();

  
Horizontal Edge

In addition to type: "horizontal", the following options are available:

NameTypeDescriptionRequiredDefault
colorstringColor of the line and arrowsno"#777777"
widthnumberLine widthno1
arrowRendererArrowRendererArrow shapeno{}
arrowLengthnumberFull length of the arrowno20
arrowOffsetnumberOffset from the arrow to the edge bendno15
hasSourceArrowbooleanDraw an arrow near the source portnofalse
hasTargetArrowbooleanDraw an arrow near the target portnofalse
cycleSquareSidenumberPort cycle square side sizeno30
roundnessnumberRoundness of the line anglesno10
detourDistancenumberNode cycle detour distanceno100

Alternatively, you can create a Horizontal shape by passing a factory function into the configuration.

    
import { HorizontalEdgeShape } from "@html-graph/html-graph";

const element = document.getElementById('canvas');

const canvas = new CanvasBuilder(element)
  .setDefaults({
    edges: {
      shape: (edgeId) => new HorizontalEdgeShape({ hasTargetArrow: true })
    },
  })
  .build();

  

All parameters are the same as specified in the table.

You can also apply the Horizontal shape to a specific edge using the addEdge and updateEdge methods.

    
import { HorizontalEdgeShape } from "@html-graph/html-graph";

canvas.addEdge({
  from: "port-1",
  to: "port-2",
  shape: new HorizontalEdgeShape(),
});

  
    
canvas.updateEdge("edge-1", {
  from: "port-3",
  to: "port-4",
  shape: new HorizontalEdgeShape(),
});