@html-graph/html-graph 2.4.0 → 3.0.0

package/README.md

@@ -49,7 +49,10 @@ function createNode({ name, x, y, frontPortId, backPortId }) {
   };
 }
 
+const element = document.getElementById("canvas");
+
 const canvas = new CanvasBuilder()
+  .setElement(element)
   .setDefaults({
     edges: {
       shape: {
@@ -59,17 +62,9 @@ const canvas = new CanvasBuilder()
   })
   .enableUserDraggableNodes()
   .enableUserTransformableViewport()
-  .enableVirtualScroll({
-    nodeContainingRadius: {
-      horizontal: 25,
-      vertical: 25,
-    },
-  })
-  .enableResizeReactiveNodes()
   .build();
 
 canvas
-  .attach(document.getElementById("canvas"))
   .addNode(
     createNode({
       name: "Node 1",

package/dist/html-graph.d.ts

@@ -97,6 +97,7 @@ declare type BezierEdgeShapeConfig = {
 } & BezierEdgeParams;
 
 export declare class Canvas {
+    readonly element: HTMLElement;
     private readonly controller;
     private readonly nodeIdGenerator;
     private readonly portIdGenerator;
@@ -110,16 +111,7 @@ export declare class Canvas {
      * provides api for accessing viewport state
      */
     readonly viewport: Viewport;
-    constructor(controller: CanvasController, options: CanvasDefaults);
-    /**
-     * attaches canvas to given element
-     * detaches element first when canvas is attached
-     */
-    attach(element: HTMLElement): Canvas;
-    /**
-     * detaches canvas from element when attached
-     */
-    detach(): Canvas;
+    constructor(element: HTMLElement, controller: CanvasController, options: CanvasDefaults);
     /**
      * adds node to graph
      */
@@ -180,6 +172,7 @@ export declare class Canvas {
 }
 
 export declare class CanvasBuilder {
+    private element;
     private canvasDefaults;
     private dragOptions;
     private transformOptions;
@@ -188,15 +181,11 @@ export declare class CanvasBuilder {
     private hasTransformableViewport;
     private hasResizeReactiveNodes;
     private boxRenderingTrigger;
+    setElement(element: HTMLElement): CanvasBuilder;
     /**
      * specifies default values for graph entities
      */
     setDefaults(defaults: CanvasDefaults): CanvasBuilder;
-    /**
-     * @deprecated
-     * use setDefaults instead
-     */
-    setOptions(options: CanvasDefaults): CanvasBuilder;
     /**
      * enables nodes draggable by user
      */
@@ -224,8 +213,6 @@ export declare class CanvasBuilder {
 declare interface CanvasController {
     readonly graph: Graph;
     readonly viewport: Viewport;
-    attach(element: HTMLElement): void;
-    detach(): void;
     addNode(node: AddNodeRequest_3): void;
     updateNode(nodeId: unknown, request: UpdateNodeRequest_3): void;
     removeNode(nodeId: unknown): void;
@@ -241,7 +228,7 @@ declare interface CanvasController {
     destroy(): void;
 }
 
-declare interface CanvasDefaults {
+export declare interface CanvasDefaults {
     /**
      * nodes related behavior
      */
@@ -279,8 +266,6 @@ declare interface CanvasDefaults {
         readonly priority?: Priority;
     };
 }
-export { CanvasDefaults }
-export { CanvasDefaults as CoreOptions }
 
 export declare type CenterFn = (width: number, height: number) => Point;
 
@@ -355,40 +340,15 @@ export declare class EventSubject<T> implements EventEmitter<T>, EventHandler<T>
 export declare class Graph {
     private readonly graphStore;
     readonly onAfterNodeAdded: EventHandler<unknown>;
-    /**
-     * @deprecated
-     * use onAfterNodeUpdated instead
-     */
-    readonly onAfterNodeCoordinatesUpdated: EventHandler<unknown>;
     readonly onAfterNodeUpdated: EventHandler<unknown>;
     readonly onAfterNodePriorityUpdated: EventHandler<unknown>;
     readonly onBeforeNodeRemoved: EventHandler<unknown>;
     readonly onAfterPortMarked: EventHandler<unknown>;
-    /**
-     * @deprecated
-     * use onAfterPortMarked instead
-     */
-    readonly onAfterPortAdded: EventHandler<unknown>;
     readonly onAfterPortUpdated: EventHandler<unknown>;
-    /**
-     * @deprecated
-     * use onAfterPortUpdated instead
-     */
-    readonly onAfterPortDirectionUpdated: EventHandler<unknown>;
     readonly onBeforePortUnmarked: EventHandler<unknown>;
-    /**
-     * @deprecated
-     * use onBeforePortUnmarked instead
-     */
-    readonly onBeforePortRemoved: EventHandler<unknown>;
     readonly onAfterEdgeAdded: EventHandler<unknown>;
     readonly onAfterEdgeShapeUpdated: EventHandler<unknown>;
     readonly onAfterEdgeUpdated: EventHandler<unknown>;
-    /**
-     * @deprecated
-     * use onAfterEdgeUpdated instead
-     */
-    readonly onAfterEdgeAdjacentPortsUpdated: EventHandler<unknown>;
     readonly onAfterEdgePriorityUpdated: EventHandler<unknown>;
     readonly onBeforeEdgeRemoved: EventHandler<unknown>;
     readonly onBeforeClear: EventHandler<void>;
@@ -398,11 +358,6 @@ export declare class Graph {
     getPort(portId: unknown): GraphPort | null;
     getAllPortIds(): readonly unknown[];
     getNodePortIds(nodeId: unknown): readonly unknown[] | null;
-    /**
-     * @deprecated
-     * use graph.getPort()?.nodeId ?? null instead
-     */
-    getPortNodeId(portId: unknown): unknown | null;
     getAllEdgeIds(): readonly unknown[];
     getEdge(edgeId: unknown): GraphEdge | null;
     getPortIncomingEdgeIds(portId: unknown): readonly unknown[] | null;