@html-graph/html-graph 8.21.1 → 8.23.0

package/dist/html-graph.d.ts

@@ -452,7 +452,7 @@ export declare interface EdgeShape {
     render(params: EdgeRenderParams): void;
 }
 
-declare type EdgeShapeConfig = BezierEdgeShapeConfig | StraightEdgeShapeConfig | HorizontalEdgeShapeConfig | VerticalEdgeShapeConfig | DirectEdgeShapeConfig | EdgeShapeFactory;
+declare type EdgeShapeConfig = BezierEdgeShapeConfig | StraightEdgeShapeConfig | HorizontalEdgeShapeConfig | VerticalEdgeShapeConfig | DirectEdgeShapeConfig | OrthogonalEdgeShapeConfig | EdgeShapeFactory;
 
 declare type EdgeShapeFactory = (edgeId: Identifier) => EdgeShape;
 
@@ -663,6 +663,10 @@ declare class GraphStore {
     private removeEdgeInternal;
 }
 
+/**
+ * @deprecated
+ * use OrthogonalEdgeShape instead
+ */
 export declare interface HorizontalEdgeParams {
     readonly color?: string | undefined;
     readonly width?: number | undefined;
@@ -676,6 +680,10 @@ export declare interface HorizontalEdgeParams {
     readonly detourDistance?: number | undefined;
 }
 
+/**
+ * @deprecated
+ * use OrthogonalEdgeShape instead
+ */
 export declare class HorizontalEdgeShape implements StructuredEdgeShape {
     readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
@@ -698,6 +706,10 @@ export declare class HorizontalEdgeShape implements StructuredEdgeShape {
     render(params: EdgeRenderParams): void;
 }
 
+/**
+ * @deprecated
+ * use type: "orthogonal" instead
+ */
 declare type HorizontalEdgeShapeConfig = {
     readonly type: "horizontal";
 } & HorizontalEdgeParams;
@@ -835,6 +847,45 @@ export declare interface NextLayerNodesResolverParams {
 
 export declare type NodeElement = HTMLElement | SVGSVGElement;
 
+export declare interface OrthogonalEdgeParams {
+    readonly color?: string | undefined;
+    readonly width?: number | undefined;
+    readonly arrowLength?: number | undefined;
+    readonly arrowRenderer?: ArrowRendererConfig | undefined;
+    readonly arrowOffset?: number | undefined;
+    readonly hasSourceArrow?: boolean | undefined;
+    readonly hasTargetArrow?: boolean | undefined;
+    readonly cycleSquareSide?: number | undefined;
+    readonly roundness?: number | undefined;
+    readonly detourDistance?: number | undefined;
+}
+
+export declare class OrthogonalEdgeShape implements StructuredEdgeShape {
+    readonly svg: SVGSVGElement;
+    readonly group: SVGGElement;
+    readonly line: SVGPathElement;
+    readonly sourceArrow: SVGPathElement | null;
+    readonly targetArrow: SVGPathElement | null;
+    readonly onAfterRender: EventHandler<StructuredEdgeRenderModel>;
+    private readonly arrowLength;
+    private readonly arrowOffset;
+    private readonly roundness;
+    private readonly cycleSquareSide;
+    private readonly detourDistance;
+    private readonly hasSourceArrow;
+    private readonly hasTargetArrow;
+    private readonly pathShape;
+    private readonly createCyclePath;
+    private readonly createDetourPath;
+    private readonly createLinePath;
+    constructor(params?: OrthogonalEdgeParams);
+    render(params: EdgeRenderParams): void;
+}
+
+declare type OrthogonalEdgeShapeConfig = {
+    readonly type: "orthogonal";
+} & OrthogonalEdgeParams;
+
 export declare interface PatchMatrixRequest {
     readonly scale?: number | undefined;
     readonly x?: number | undefined;
@@ -1087,6 +1138,10 @@ export declare interface UserSelectableNodesConfig {
     readonly movementThreshold?: number | undefined;
 }
 
+/**
+ * @deprecated
+ * use OrthogonalEdgeShape instead
+ */
 export declare interface VerticalEdgeParams {
     readonly color?: string | undefined;
     readonly width?: number | undefined;
@@ -1100,6 +1155,10 @@ export declare interface VerticalEdgeParams {
     readonly detourDistance?: number | undefined;
 }
 
+/**
+ * @deprecated
+ * use OrthogonalEdgeShape instead
+ */
 export declare class VerticalEdgeShape implements StructuredEdgeShape {
     readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
@@ -1122,6 +1181,10 @@ export declare class VerticalEdgeShape implements StructuredEdgeShape {
     render(params: EdgeRenderParams): void;
 }
 
+/**
+ * @deprecated
+ * use type: "orthogonal" instead
+ */
 declare type VerticalEdgeShapeConfig = {
     readonly type: "vertical";
 } & VerticalEdgeParams;