@html-graph/html-graph 3.3.0 → 3.4.0

package/dist/html-graph.d.ts

@@ -42,7 +42,7 @@ declare interface AddPortRequest {
     readonly direction: number;
 }
 
-declare interface BackgroundOptions {
+export declare interface BackgroundConfig {
     readonly tileDimensions?: {
         readonly width?: number;
         readonly height?: number;
@@ -198,11 +198,11 @@ export declare class Canvas {
 export declare class CanvasBuilder {
     private element;
     private canvasDefaults;
-    private dragOptions;
-    private transformOptions;
-    private backgroundOptions;
-    private connectablePortsOptions;
-    private virtualScrollOptions;
+    private dragConfig;
+    private transformConfig;
+    private backgroundConfig;
+    private connectablePortsConfig;
+    private virtualScrollConfig;
     private hasDraggableNode;
     private hasTransformableViewport;
     private hasResizeReactiveNodes;
@@ -210,6 +210,11 @@ export declare class CanvasBuilder {
     private hasUserConnectablePorts;
     private boxRenderingTrigger;
     private readonly window;
+    constructor(element?: HTMLElement);
+    /**
+     * @deprecated
+     * use `new CanvasBuilder(element);` instead
+     */
     setElement(element: HTMLElement): CanvasBuilder;
     /**
      * specifies default values for graph entities
@@ -218,11 +223,11 @@ export declare class CanvasBuilder {
     /**
      * enables nodes draggable by user
      */
-    enableUserDraggableNodes(options?: DragOptions): CanvasBuilder;
+    enableUserDraggableNodes(options?: DraggableNodesConfig): CanvasBuilder;
     /**
      * enables viewport transformable by user
      */
-    enableUserTransformableViewport(options?: TransformOptions): CanvasBuilder;
+    enableUserTransformableViewport(config?: ViewportTransformConfig): CanvasBuilder;
     /**
      * enables automatic edges update on node resize
      */
@@ -235,15 +240,15 @@ export declare class CanvasBuilder {
      * enables built-in virtual scroll behavior, when only nodes and edges close
      * to viewport are rendered
      */
-    enableVirtualScroll(options: VirtualScrollOptions): CanvasBuilder;
+    enableVirtualScroll(config: VirtualScrollConfig): CanvasBuilder;
     /**
      * enables built-in background rendering
      */
-    enableBackground(options?: BackgroundOptions): CanvasBuilder;
+    enableBackground(config?: BackgroundConfig): CanvasBuilder;
     /**
      * enables edge creation by dragging one port to another
      */
-    enableUserConnectablePorts(options?: ConnectablePortsOptions): CanvasBuilder;
+    enableUserConnectablePorts(config?: ConnectablePortsConfig): CanvasBuilder;
     /**
      * builds final canvas
      */
@@ -296,7 +301,7 @@ export declare interface CanvasDefaults {
 
 export declare type CenterFn = (width: number, height: number) => Point;
 
-export declare interface ConnectablePortsOptions {
+declare interface ConnectablePortsConfig {
     readonly connectionTypeResolver?: ConnectionTypeResolver;
     readonly connectionPreprocessor?: ConnectionPreprocessor;
     readonly mouseDownEventVerifier?: MouseEventVerifier;
@@ -304,6 +309,8 @@ export declare interface ConnectablePortsOptions {
         readonly onAfterEdgeCreated?: (edgeId: unknown) => void;
     };
 }
+export { ConnectablePortsConfig }
+export { ConnectablePortsConfig as ConnectablePortsOptions }
 
 export declare type ConnectionPreprocessor = (request: AddEdgeRequest) => AddEdgeRequest | null;
 
@@ -318,7 +325,7 @@ declare interface DotsRenderer {
     readonly color?: string;
 }
 
-export declare interface DragOptions {
+declare interface DraggableNodesConfig {
     readonly moveOnTop?: boolean;
     readonly mouse?: {
         readonly dragCursor?: string | null;
@@ -331,6 +338,8 @@ export declare interface DragOptions {
         readonly onNodeDragFinished?: (payload: NodeDragPayload) => void;
     };
 }
+export { DraggableNodesConfig as DragOptions }
+export { DraggableNodesConfig }
 
 declare interface EdgePayload {
     readonly from: unknown;
@@ -697,37 +706,13 @@ declare type StraightEdgeShapeConfig = {
     readonly type: "straight";
 } & StraightEdgeParams;
 
-export declare interface TransformOptions {
-    readonly scale?: {
-        readonly mouseWheelSensitivity?: number;
-        readonly mouseWheelEventVerifier?: (event: WheelEvent) => boolean;
-        readonly wheelFinishTimeout?: number;
-    };
-    readonly shift?: {
-        readonly cursor?: string | null;
-        readonly mouseDownEventVerifier?: MouseEventVerifier;
-        readonly mouseUpEventVerifier?: MouseEventVerifier;
-    };
-    readonly transformPreprocessor?: TransformPreprocessorOption | TransformPreprocessorOption[];
-    readonly events?: {
-        readonly onTransformStarted?: () => void;
-        readonly onTransformFinished?: () => void;
-        readonly onBeforeTransformChange?: () => void;
-        readonly onTransformChange?: () => void;
-        readonly onResizeTransformStarted?: () => void;
-        readonly onResizeTransformFinished?: () => void;
-    };
-}
-
 export declare interface TransformPayload {
     readonly scale: number;
     readonly x: number;
     readonly y: number;
 }
 
-export declare type TransformPreprocessorFn = (params: TransformPreprocessorParams) => TransformPayload;
-
-declare type TransformPreprocessorOption = {
+declare type TransformPreprocessorConfig = {
     readonly type: "scale-limit";
     readonly minContentScale?: number;
     readonly maxContentScale?: number;
@@ -739,6 +724,8 @@ declare type TransformPreprocessorOption = {
     readonly maxY?: number;
 } | TransformPreprocessorFn;
 
+export declare type TransformPreprocessorFn = (params: TransformPreprocessorParams) => TransformPayload;
+
 export declare interface TransformPreprocessorParams {
     readonly prevTransform: TransformPayload;
     readonly nextTransform: TransformPayload;
@@ -854,7 +841,31 @@ declare class ViewportStore {
     patchContentMatrix(matrix: PatchTransformRequest): void;
 }
 
-declare interface VirtualScrollOptions {
+declare interface ViewportTransformConfig {
+    readonly scale?: {
+        readonly mouseWheelSensitivity?: number;
+        readonly mouseWheelEventVerifier?: (event: WheelEvent) => boolean;
+        readonly wheelFinishTimeout?: number;
+    };
+    readonly shift?: {
+        readonly cursor?: string | null;
+        readonly mouseDownEventVerifier?: MouseEventVerifier;
+        readonly mouseUpEventVerifier?: MouseEventVerifier;
+    };
+    readonly transformPreprocessor?: TransformPreprocessorConfig | TransformPreprocessorConfig[];
+    readonly events?: {
+        readonly onTransformStarted?: () => void;
+        readonly onTransformFinished?: () => void;
+        readonly onBeforeTransformChange?: () => void;
+        readonly onTransformChange?: () => void;
+        readonly onResizeTransformStarted?: () => void;
+        readonly onResizeTransformFinished?: () => void;
+    };
+}
+export { ViewportTransformConfig as TransformOptions }
+export { ViewportTransformConfig }
+
+export declare interface VirtualScrollConfig {
     readonly nodeContainingRadius: {
         readonly vertical: number;
         readonly horizontal: number;