@html-graph/html-graph 3.2.0 → 3.3.0

package/dist/html-graph.d.ts

@@ -124,12 +124,15 @@ export declare class Canvas {
     private readonly onBeforeEdgeRemoved;
     private readonly onBeforeClear;
     private readonly onBeforeDestroyEmitter;
+    /**
+     * emits event just before destruction of canvas
+     */
     readonly onBeforeDestroy: EventHandler<void>;
     constructor(
     /**
      * @deprecated access element directly instead
      */
-    element: HTMLElement, graphStore: GraphStore, viewportStore: ViewportStore, htmlView: HtmlView, options: CanvasDefaults);
+    element: HTMLElement, graphStore: GraphStore, viewportStore: ViewportStore, htmlView: HtmlView, defaults: CanvasDefaults);
     /**
      * adds new node
      */
@@ -198,12 +201,15 @@ export declare class CanvasBuilder {
     private dragOptions;
     private transformOptions;
     private backgroundOptions;
+    private connectablePortsOptions;
     private virtualScrollOptions;
     private hasDraggableNode;
     private hasTransformableViewport;
     private hasResizeReactiveNodes;
     private hasBackground;
+    private hasUserConnectablePorts;
     private boxRenderingTrigger;
+    private readonly window;
     setElement(element: HTMLElement): CanvasBuilder;
     /**
      * specifies default values for graph entities
@@ -225,8 +231,19 @@ export declare class CanvasBuilder {
      * sets emitter for rendering graph inside bounded area
      */
     enableBoxAreaRendering(trigger: EventSubject<RenderingBox>): CanvasBuilder;
+    /**
+     * enables built-in virtual scroll behavior, when only nodes and edges close
+     * to viewport are rendered
+     */
     enableVirtualScroll(options: VirtualScrollOptions): CanvasBuilder;
+    /**
+     * enables built-in background rendering
+     */
     enableBackground(options?: BackgroundOptions): CanvasBuilder;
+    /**
+     * enables edge creation by dragging one port to another
+     */
+    enableUserConnectablePorts(options?: ConnectablePortsOptions): CanvasBuilder;
     /**
      * builds final canvas
      */
@@ -279,6 +296,19 @@ export declare interface CanvasDefaults {
 
 export declare type CenterFn = (width: number, height: number) => Point;
 
+export declare interface ConnectablePortsOptions {
+    readonly connectionTypeResolver?: ConnectionTypeResolver;
+    readonly connectionPreprocessor?: ConnectionPreprocessor;
+    readonly mouseDownEventVerifier?: MouseEventVerifier;
+    readonly events?: {
+        readonly onAfterEdgeCreated?: (edgeId: unknown) => void;
+    };
+}
+
+export declare type ConnectionPreprocessor = (request: AddEdgeRequest) => AddEdgeRequest | null;
+
+export declare type ConnectionTypeResolver = (portId: unknown) => "direct" | "reverse" | null;
+
 declare type ConstantPriority = number;
 
 declare type CustomPriority = PriorityFn;
@@ -292,8 +322,8 @@ export declare interface DragOptions {
     readonly moveOnTop?: boolean;
     readonly mouse?: {
         readonly dragCursor?: string | null;
-        readonly mouseDownEventVerifier?: (event: MouseEvent) => boolean;
-        readonly mouseUpEventVerifier?: (event: MouseEvent) => boolean;
+        readonly mouseDownEventVerifier?: MouseEventVerifier;
+        readonly mouseUpEventVerifier?: MouseEventVerifier;
     };
     readonly events?: {
         readonly onNodeDrag?: (payload: NodeDragPayload) => void;
@@ -560,6 +590,8 @@ export declare interface MarkPortRequest {
     readonly direction?: number;
 }
 
+export declare type MouseEventVerifier = (event: MouseEvent) => boolean;
+
 export declare interface NodeDragPayload {
     readonly nodeId: unknown;
     readonly element: HTMLElement;
@@ -673,8 +705,8 @@ export declare interface TransformOptions {
     };
     readonly shift?: {
         readonly cursor?: string | null;
-        readonly mouseDownEventVerifier?: (event: MouseEvent) => boolean;
-        readonly mouseUpEventVerifier?: (event: MouseEvent) => boolean;
+        readonly mouseDownEventVerifier?: MouseEventVerifier;
+        readonly mouseUpEventVerifier?: MouseEventVerifier;
     };
     readonly transformPreprocessor?: TransformPreprocessorOption | TransformPreprocessorOption[];
     readonly events?: {
@@ -797,10 +829,10 @@ declare type VerticalEdgeShapeConfig = {
  * Responsibility: Provides access to viewport state for end user
  */
 export declare class Viewport {
-    private readonly transformer;
+    private readonly viewportStore;
     readonly onBeforeUpdated: EventHandler<void>;
     readonly onAfterUpdated: EventHandler<void>;
-    constructor(transformer: ViewportStore);
+    constructor(viewportStore: ViewportStore);
     getViewportMatrix(): TransformState;
     getContentMatrix(): TransformState;
 }