@html-graph/html-graph 3.7.0 → 3.9.0

package/dist/html-graph.d.ts

@@ -65,9 +65,6 @@ export declare interface BezierEdgeParams {
     readonly detourDirection?: number | undefined;
 }
 
-/**
- * Responsibility: Providing edge shape connecting ports with bezier line
- */
 export declare class BezierEdgeShape implements StructuredEdgeShape {
     readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
@@ -95,9 +92,6 @@ declare type BezierEdgeShapeConfig = {
     readonly type?: "bezier" | undefined;
 } & BezierEdgeParams;
 
-/**
- * Responsibility: provides graph rendering API for end user
- */
 export declare class Canvas {
     /**
      * @deprecated access element directly instead
@@ -106,6 +100,7 @@ export declare class Canvas {
     private readonly graphStore;
     private readonly viewportStore;
     private readonly htmlView;
+    private readonly defaults;
     /**
      * provides api for accessing model of rendered graph
      */
@@ -114,7 +109,6 @@ export declare class Canvas {
      * provides api for accessing viewport state
      */
     readonly viewport: Viewport;
-    private readonly defaults;
     private readonly nodeIdGenerator;
     private readonly portIdGenerator;
     private readonly edgeIdGenerator;
@@ -139,7 +133,7 @@ export declare class Canvas {
     /**
      * @deprecated access element directly instead
      */
-    element: HTMLElement, graphStore: GraphStore, viewportStore: ViewportStore, htmlView: HtmlView, defaults: CanvasDefaults);
+    element: HTMLElement, graphStore: GraphStore, viewportStore: ViewportStore, htmlView: HtmlView, defaults: Defaults);
     /**
      * adds new node
      */
@@ -199,9 +193,6 @@ export declare class Canvas {
     destroy(): void;
 }
 
-/**
- * Responsibility: Constructs canvas based on specified configuration
- */
 export declare class CanvasBuilder {
     private element;
     private canvasDefaults;
@@ -333,6 +324,51 @@ export declare type CreatePathFn = (sourceDirection: Point, targetDirection: Poi
 
 declare type CustomPriority = PriorityFn;
 
+declare interface Defaults {
+    readonly nodes: {
+        readonly centerFn: CenterFn;
+        readonly priorityFn: PriorityFn;
+    };
+    readonly ports: {
+        readonly direction: number;
+    };
+    readonly edges: {
+        readonly shapeFactory: EdgeShapeFactory;
+        readonly priorityFn: PriorityFn;
+    };
+}
+
+export declare interface DirectEdgeParams {
+    readonly color?: string | undefined;
+    readonly width?: number | undefined;
+    readonly arrowLength?: number | undefined;
+    readonly arrowWidth?: number | undefined;
+    readonly hasSourceArrow?: boolean | undefined;
+    readonly hasTargetArrow?: boolean | undefined;
+    readonly sourceOffset?: number | undefined;
+    readonly targetOffset?: number | undefined;
+}
+
+export declare class DirectEdgeShape implements StructuredEdgeShape {
+    readonly svg: SVGSVGElement;
+    readonly group: SVGGElement;
+    readonly line: SVGPathElement;
+    readonly sourceArrow: SVGPathElement | null;
+    readonly targetArrow: SVGPathElement | null;
+    private readonly color;
+    private readonly width;
+    private readonly arrowLength;
+    private readonly arrowWidth;
+    private readonly sourceOffset;
+    private readonly targetOffset;
+    constructor(params?: DirectEdgeParams);
+    render(params: EdgeRenderParams): void;
+}
+
+declare type DirectEdgeShapeConfig = {
+    readonly type: "direct";
+} & DirectEdgeParams;
+
 declare interface DotsRenderer {
     readonly radius?: number;
     readonly color?: string;
@@ -340,6 +376,7 @@ declare interface DotsRenderer {
 
 declare interface DraggableNodesConfig {
     readonly moveOnTop?: boolean;
+    readonly moveEdgesOnTop?: boolean;
     readonly mouse?: {
         readonly dragCursor?: string | null;
         readonly mouseDownEventVerifier?: MouseEventVerifier;
@@ -376,36 +413,24 @@ export declare interface EdgeRenderPort {
     readonly nodeId: unknown;
 }
 
-/**
- * Responsibility: Rendering edge via SVG
- */
 export declare interface EdgeShape {
     readonly svg: SVGSVGElement;
     render(params: EdgeRenderParams): void;
 }
 
-declare type EdgeShapeConfig = BezierEdgeShapeConfig | StraightEdgeShapeConfig | HorizontalEdgeShapeConfig | VerticalEdgeShapeConfig | EdgeShapeFactory;
+declare type EdgeShapeConfig = BezierEdgeShapeConfig | StraightEdgeShapeConfig | HorizontalEdgeShapeConfig | VerticalEdgeShapeConfig | DirectEdgeShapeConfig | EdgeShapeFactory;
 
 declare type EdgeShapeFactory = (edgeId: unknown) => EdgeShape;
 
-/**
- * Responsibility: Provides a way to trigger events
- */
 export declare interface EventEmitter<T> {
     emit(payload: T): void;
 }
 
-/**
- * Responsibility: Provides a way to handle events
- */
 export declare interface EventHandler<T> {
     subscribe(callback: (payload: T) => void): void;
     unsubscribe(callback: (payload: T) => void): void;
 }
 
-/**
- * Responsibility: Connects events and event handlers
- */
 export declare class EventSubject<T> implements EventEmitter<T>, EventHandler<T> {
     private readonly callbacks;
     subscribe(callback: (payload: T) => void): void;
@@ -413,9 +438,6 @@ export declare class EventSubject<T> implements EventEmitter<T>, EventHandler<T>
     emit(payload: T): void;
 }
 
-/**
- * Responsibility: Provides access to graph model for end user
- */
 export declare class Graph {
     private readonly graphStore;
     readonly onAfterNodeAdded: EventHandler<unknown>;
@@ -433,6 +455,7 @@ export declare class Graph {
     readonly onBeforeClear: EventHandler<void>;
     constructor(graphStore: GraphStore);
     getNode(nodeId: unknown): GraphNode | null;
+    getElementNodeId(element: HTMLElement): unknown | null;
     getAllNodeIds(): readonly unknown[];
     getPort(portId: unknown): GraphPort | null;
     getAllPortIds(): readonly unknown[];
@@ -470,13 +493,11 @@ export declare interface GraphPort {
     readonly nodeId: unknown;
 }
 
-/**
- * Responsibility: Store state of graph
- */
 declare class GraphStore {
     private readonly nodes;
     private readonly ports;
     private readonly edges;
+    private readonly nodesElementsMap;
     private readonly incomingEdges;
     private readonly outcomingEdges;
     private readonly cycleEdges;
@@ -511,6 +532,7 @@ declare class GraphStore {
     addNode(request: AddNodeRequest_2): void;
     getAllNodeIds(): readonly unknown[];
     getNode(nodeId: unknown): NodePayload | undefined;
+    getElementNodeId(element: HTMLElement): unknown | undefined;
     updateNode(nodeId: unknown, request: UpdateNodeRequest_2): void;
     removeNode(nodeId: unknown): void;
     addPort(request: AddPortRequest): void;
@@ -552,10 +574,6 @@ export declare interface HorizontalEdgeParams {
     readonly detourDirection?: number | undefined;
 }
 
-/**
- * Responsibility: Providing edge shape connecting ports with horizontal angled
- * line
- */
 export declare class HorizontalEdgeShape implements StructuredEdgeShape {
     readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
@@ -583,17 +601,10 @@ declare type HorizontalEdgeShapeConfig = {
     readonly type: "horizontal";
 } & HorizontalEdgeParams;
 
-/**
- * Responsibility: Library specific error to throw when unexpected action
- * occured
- */
 export declare class HtmlGraphError extends Error {
     readonly name = "HtmlGraphError";
 }
 
-/**
- * Responsibility: Provides access to DOM modifications
- */
 declare interface HtmlView {
     attachNode(nodeId: unknown): void;
     detachNode(nodeId: unknown): void;
@@ -615,13 +626,12 @@ export declare class InteractiveEdgeError extends Error {
 }
 
 export declare interface InteractiveEdgeParams {
+    /**
+     * TODO: rename to 'radius'
+     */
     readonly width?: number;
 }
 
-/**
- * Responsibility: Providing handle for attaching interactive behavior to an
- * edge
- */
 export declare class InteractiveEdgeShape implements StructuredEdgeShape {
     private readonly structuredEdge;
     readonly svg: SVGSVGElement;
@@ -649,9 +659,6 @@ export declare interface LineEdgeParams {
     readonly createLinePath: CreatePathFn;
 }
 
-/**
- * Responsibility: Providing low level core for single line structured edges
- */
 export declare class LineEdgeShape implements StructuredEdgeShape {
     private readonly params;
     readonly svg: SVGSVGElement;
@@ -706,9 +713,6 @@ declare interface PatchTransformRequest {
     readonly y?: number;
 }
 
-/**
- * Responsibility: Specifies point coordinates
- */
 export declare interface Point {
     readonly x: number;
     readonly y: number;
@@ -722,9 +726,6 @@ declare interface PortPayload {
 
 declare type Priority = ConstantPriority | IncrementalPriority | CustomPriority;
 
-/**
- * Responsibility: Specifies how to determine Z-index of an entity in DOM
- */
 export declare type PriorityFn = () => number;
 
 export declare interface RenderingBox {
@@ -760,9 +761,6 @@ export declare interface StraightEdgeParams {
     readonly detourDirection?: number | undefined;
 }
 
-/**
- * Responsibility: Providing edge shape connecting ports with straight line
- */
 export declare class StraightEdgeShape implements StructuredEdgeShape {
     readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
@@ -790,9 +788,6 @@ declare type StraightEdgeShapeConfig = {
     readonly type: "straight";
 } & StraightEdgeParams;
 
-/**
- * Responsibility: Specifying EdgeShape with a standard visual structure
- */
 export declare interface StructuredEdgeShape extends EdgeShape {
     readonly group: SVGGElement;
     readonly line: SVGPathElement;
@@ -883,10 +878,6 @@ export declare interface VerticalEdgeParams {
     readonly detourDirection?: number | undefined;
 }
 
-/**
- * Responsibility: Providing edge shape connecting ports with vertical angled
- * line
- */
 export declare class VerticalEdgeShape implements StructuredEdgeShape {
     readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
@@ -914,9 +905,6 @@ declare type VerticalEdgeShapeConfig = {
     readonly type: "vertical";
 } & VerticalEdgeParams;
 
-/**
- * Responsibility: Provides access to viewport state for end user
- */
 export declare class Viewport {
     private readonly viewportStore;
     readonly onBeforeUpdated: EventHandler<void>;
@@ -926,9 +914,6 @@ export declare class Viewport {
     getContentMatrix(): TransformState;
 }
 
-/**
- * Responsibility: Stores viewport transformation state
- */
 declare class ViewportStore {
     private viewportMatrix;
     private contentMatrix;