@html-graph/html-graph 3.17.0 → 3.19.0

package/README.md

@@ -8,10 +8,6 @@
   <img width="100%" src="https://raw.githubusercontent.com/html-graph/html-graph/master/media/full-demo.gif"/>
 </a>
 
-Instead of connecting nodes directly, this library utilizes the concept of ports,
-which provide greater flexibility in managing edges. A port is an entity on a
-node to which edges can be attached.
-
 Visit the <a target="_blank" href="https://html-graph.github.io">DOCUMENTATION</a> for more details.
 
 ## Getting started:

package/dist/html-graph.d.ts

@@ -126,6 +126,7 @@ export declare class Canvas {
     private readonly onBeforeEdgeRemoved;
     private readonly onBeforeClear;
     private readonly onBeforeDestroyEmitter;
+    private destroyed;
     /**
      * emits event just before destruction of canvas
      */
@@ -205,7 +206,7 @@ export declare class CanvasBuilder {
     private virtualScrollConfig;
     private hasDraggableNode;
     private hasTransformableViewport;
-    private hasResizeReactiveNodes;
+    private hasNodeResizeReactiveEdges;
     private hasBackground;
     private hasUserConnectablePorts;
     private hasUserDraggableEdges;
@@ -230,9 +231,14 @@ export declare class CanvasBuilder {
      */
     enableUserTransformableViewport(config?: ViewportTransformConfig): CanvasBuilder;
     /**
-     * enables automatic edges update on node resize
+     * @deprecated
+     * use enableNodeResizeReactiveEdges instead
      */
     enableResizeReactiveNodes(): CanvasBuilder;
+    /**
+     * enables automatic edges update on node resize
+     */
+    enableNodeResizeReactiveEdges(): CanvasBuilder;
     /**
      * @deprecated
      * do not use
@@ -408,6 +414,7 @@ declare interface DraggableNodesConfig {
         readonly mouseDownEventVerifier?: MouseEventVerifier;
         readonly mouseUpEventVerifier?: MouseEventVerifier;
     };
+    readonly gridSize?: number | null;
     readonly events?: {
         readonly onNodeDrag?: (payload: NodeDragPayload) => void;
         readonly onBeforeNodeDrag?: (payload: NodeDragPayload) => boolean;
@@ -769,6 +776,9 @@ export { MidpointEdgeShape }
 
 export declare type MouseEventVerifier = (event: MouseEvent) => boolean;
 
+/**
+ * TODO: replace with node ID
+ */
 export declare interface NodeDragPayload {
     readonly nodeId: unknown;
     readonly element: HTMLElement;
@@ -1000,6 +1010,10 @@ declare type VerticalEdgeShapeConfig = {
 
 export declare class Viewport {
     private readonly viewportStore;
+    /**
+     * @deprecated
+     * do not use
+     */
     readonly onBeforeUpdated: EventHandler<void>;
     readonly onAfterUpdated: EventHandler<void>;
     constructor(viewportStore: ViewportStore);
@@ -1013,6 +1027,10 @@ declare class ViewportStore {
     private readonly afterUpdateEmitter;
     readonly onAfterUpdated: EventHandler<void>;
     private readonly beforeUpdateEmitter;
+    /**
+     * @deprecated
+     * do not use
+     */
     readonly onBeforeUpdated: EventHandler<void>;
     constructor();
     getViewportMatrix(): TransformState;