@html-graph/html-graph 8.0.0 → 8.2.0

package/dist/html-graph.d.ts

@@ -18,7 +18,7 @@ export declare type AddNodePorts = Iterable<MarkNodePortRequest>;
 
 export declare interface AddNodeRequest {
     readonly id?: Identifier | undefined;
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly x?: number | null | undefined;
     readonly y?: number | null | undefined;
     readonly ports?: AddNodePorts | undefined;
@@ -28,7 +28,7 @@ export declare interface AddNodeRequest {
 
 declare interface AddNodeRequest_2 {
     readonly id: Identifier;
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly x: number | null;
     readonly y: number | null;
     readonly centerFn: CenterFn;
@@ -38,7 +38,7 @@ declare interface AddNodeRequest_2 {
 declare interface AddPortRequest {
     readonly id: Identifier;
     readonly nodeId: Identifier;
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly direction: number;
 }
 
@@ -46,6 +46,26 @@ export declare interface AnimatedLayoutAlgorithm {
     calculateNextCoordinates(params: AnimatedLayoutAlgorithmParams): ReadonlyMap<Identifier, Point>;
 }
 
+export declare type AnimatedLayoutAlgorithmConfig = {
+    readonly type: "custom";
+    readonly instance: AnimatedLayoutAlgorithm;
+} | {
+    readonly type?: "forceDirected";
+    readonly maxTimeDeltaSec?: number;
+    readonly nodeCharge?: number;
+    readonly nodeMass?: number;
+    readonly edgeEquilibriumLength?: number;
+    readonly edgeStiffness?: number;
+    readonly seed?: string;
+    readonly convergenceVelocity?: number;
+    readonly maxForce?: number;
+    readonly nodeForceCoefficient?: number;
+    readonly barnesHut?: {
+        readonly theta?: number;
+        readonly areaRadiusThreshold?: number;
+    };
+};
+
 export declare interface AnimatedLayoutAlgorithmParams {
     readonly graph: Graph;
     readonly dt: number;
@@ -53,25 +73,8 @@ export declare interface AnimatedLayoutAlgorithmParams {
 }
 
 export declare interface AnimatedLayoutConfig {
-    readonly algorithm?: {
-        readonly type: "custom";
-        readonly instance: AnimatedLayoutAlgorithm;
-    } | {
-        readonly type?: "forceDirected";
-        readonly maxTimeDeltaSec?: number;
-        readonly nodeCharge?: number;
-        readonly nodeMass?: number;
-        readonly edgeEquilibriumLength?: number;
-        readonly edgeStiffness?: number;
-        readonly seed?: string;
-        readonly convergenceVelocity?: number;
-        readonly maxForce?: number;
-        readonly nodeForceCoefficient?: number;
-        readonly barnesHut?: {
-            readonly theta?: number;
-            readonly areaRadiusThreshold?: number;
-        };
-    } | undefined;
+    readonly algorithm?: AnimatedLayoutAlgorithmConfig | undefined;
+    readonly staticNodeResolver?: ((nodeId: Identifier) => boolean) | undefined;
 }
 
 export declare type ArrowRenderer = (params: ArrowRenderingParams) => string;
@@ -554,13 +557,13 @@ export declare class Graph {
     constructor(graphStore: GraphStore);
     hasNode(nodeId: Identifier): boolean;
     getNode(nodeId: Identifier): GraphNode;
-    findNodeIdByElement(element: HTMLElement): Identifier | undefined;
+    findNodeIdByElement(element: Element): Identifier | undefined;
     getAllNodeIds(): readonly Identifier[];
     hasPort(portId: Identifier): boolean;
     getPort(portId: Identifier): GraphPort;
     getAllPortIds(): readonly Identifier[];
     getNodePortIds(nodeId: Identifier): readonly Identifier[];
-    findPortIdsByElement(element: HTMLElement): readonly Identifier[];
+    findPortIdsByElement(element: Element): readonly Identifier[];
     getAllEdgeIds(): readonly Identifier[];
     hasEdge(edgeId: Identifier): boolean;
     getEdge(edgeId: Identifier): GraphEdge;
@@ -582,7 +585,7 @@ export declare interface GraphEdge {
 }
 
 export declare interface GraphNode {
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly x: number | null;
     readonly y: number | null;
     readonly centerFn: CenterFn;
@@ -590,7 +593,7 @@ export declare interface GraphNode {
 }
 
 export declare interface GraphPort {
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly direction: number;
     readonly nodeId: Identifier;
 }
@@ -635,7 +638,7 @@ declare class GraphStore {
     getNode(nodeId: Identifier): StoreNode;
     addNode(request: AddNodeRequest_2): void;
     getAllNodeIds(): readonly Identifier[];
-    findNodeIdByElement(element: HTMLElement): Identifier | undefined;
+    findNodeIdByElement(element: Element): Identifier | undefined;
     updateNode(nodeId: Identifier, request: UpdateNodeRequest_2): void;
     removeNode(nodeId: Identifier): void;
     hasPort(portId: Identifier): boolean;
@@ -643,7 +646,7 @@ declare class GraphStore {
     addPort(request: AddPortRequest): void;
     updatePort(portId: Identifier, request: UpdatePortRequest_2): void;
     getAllPortIds(): readonly Identifier[];
-    findPortIdsByElement(element: HTMLElement): readonly Identifier[];
+    findPortIdsByElement(element: Element): readonly Identifier[];
     getNodePortIds(nodeId: Identifier): readonly Identifier[];
     removePort(portId: Identifier): void;
     hasEdge(edgeId: Identifier): boolean;
@@ -785,17 +788,18 @@ export declare type LayoutApplyOn = {
 export declare interface LayoutConfig {
     readonly algorithm?: LayoutAlgorithmConfig | undefined;
     readonly applyOn?: LayoutApplyOn | undefined;
+    readonly staticNodeResolver?: (nodeId: Identifier) => boolean;
 }
 
 export declare type MarkNodePortRequest = {
     readonly id?: Identifier | undefined;
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly direction?: number | undefined;
 };
 
 export declare interface MarkPortRequest {
     readonly id?: Identifier | undefined;
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly nodeId: Identifier;
     readonly direction?: number | undefined;
 }
@@ -815,6 +819,8 @@ export declare class MidpointEdgeShape implements StructuredEdgeShape {
 
 export declare type MouseEventVerifier = (event: MouseEvent) => boolean;
 
+export declare type NodeElement = HTMLElement | SVGSVGElement;
+
 export declare interface PatchMatrixRequest {
     readonly scale?: number | undefined;
     readonly x?: number | undefined;
@@ -832,6 +838,8 @@ export declare interface Point {
     readonly y: number;
 }
 
+export declare type PortElement = HTMLElement | SVGElement;
+
 declare type Priority = ConstantPriority | IncrementalPriority | CustomPriority;
 
 export declare type PriorityFn = () => number;
@@ -858,18 +866,18 @@ declare interface StoreEdge {
 }
 
 declare interface StoreNode {
-    readonly element: HTMLElement;
+    readonly element: NodeElement;
     readonly payload: {
         x: number | null;
         y: number | null;
         centerFn: CenterFn;
         priority: number;
     };
-    readonly ports: Map<Identifier, HTMLElement>;
+    readonly ports: Map<Identifier, PortElement>;
 }
 
 declare interface StorePort {
-    readonly element: HTMLElement;
+    readonly element: PortElement;
     readonly payload: {
         direction: number;
     };