@html-graph/html-graph 8.24.0 → 9.1.0

package/dist/html-graph.d.ts

@@ -57,7 +57,7 @@ export declare type AnimatedLayoutAlgorithmConfig = {
     readonly edgeEquilibriumLength?: number;
     readonly edgeStiffness?: number;
     readonly seed?: string;
-    readonly convergenceVelocity?: number;
+    readonly stopVelocity?: number;
     readonly maxForce?: number;
     readonly nodeForceCoefficient?: number;
     readonly barnesHut?: {
@@ -127,7 +127,6 @@ export declare interface BezierEdgeParams {
 
 export declare class BezierEdgeShape implements StructuredEdgeShape {
     readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
     readonly line: SVGPathElement;
     readonly sourceArrow: SVGPathElement | null;
@@ -153,8 +152,6 @@ declare type BezierEdgeShapeConfig = {
     readonly type?: "bezier" | undefined;
 } & BezierEdgeParams;
 
-export declare const boxPortOffsetFn: PortOffsetFn;
-
 export declare class Canvas {
     readonly graph: Graph;
     readonly viewport: Viewport;
@@ -232,49 +229,19 @@ export declare class CanvasBuilderError extends Error {
 }
 
 export declare interface CanvasDefaults {
-    /**
-     * nodes related behavior
-     */
     readonly nodes?: {
-        /**
-         * specifies how to determine center of node
-         * center of nodes specified in addNode method by x and y
-         */
         readonly centerFn?: CenterFn;
-        /**
-         * specifies default z-index value
-         */
         readonly priority?: Priority;
     };
-    /**
-     * ports related behavior
-     */
     readonly ports?: {
-        /**
-         * specifies default direction of port
-         */
         readonly direction?: number;
     };
-    /**
-     *edges related behavior
-     */
     readonly edges?: {
-        /**
-         * specifies default controller
-         */
         readonly shape?: EdgeShapeConfig;
-        /**
-         * specifies default z-index value
-         */
         readonly priority?: Priority;
     };
     readonly focus?: {
         readonly contentPadding?: number;
-        /**
-         * @deprecated
-         * use contentPadding instead
-         */
-        readonly contentOffset?: number;
         readonly minContentScale?: number;
         readonly animationDuration?: number;
     };
@@ -292,13 +259,15 @@ export declare interface CenterConfig {
 export declare type CenterFn = (width: number, height: number) => Point;
 
 export declare interface ConnectablePortsConfig {
-    readonly edgeShape?: EdgeShapeConfig;
-    readonly connectionTypeResolver?: ConnectionTypeResolver;
-    readonly connectionAllowedVerifier?: ConnectionAllowedVerifier;
-    readonly connectionPreprocessor?: ConnectionPreprocessor;
-    readonly mouseDownEventVerifier?: MouseEventVerifier;
-    readonly mouseUpEventVerifier?: MouseEventVerifier;
-    readonly dragPortDirection?: DraggingPortDirectionConfig;
+    readonly edgeShape?: EdgeShapeConfig | undefined;
+    readonly connectionTypeResolver?: ConnectionTypeResolver | undefined;
+    readonly connectionAllowedVerifier?: ConnectionAllowedVerifier | undefined;
+    readonly connectionPreprocessor?: ConnectionPreprocessor | undefined;
+    readonly mouseDownEventVerifier?: MouseEventVerifier | undefined;
+    readonly mouseUpEventVerifier?: MouseEventVerifier | undefined;
+    readonly dragPortDirection?: DraggingPortDirectionConfig | undefined;
+    readonly grabbedPortIdResolver?: PortIdResolver | undefined;
+    readonly releasedPortIdResolver?: PortIdResolver | undefined;
     readonly events?: {
         readonly onAfterEdgeCreated?: (edgeId: Identifier) => void;
         readonly onEdgeCreationInterrupted?: (params: EdgeCreationInProgressParams) => void;
@@ -319,13 +288,7 @@ export declare enum ConnectionCategory {
     PortCycle = "port-cycle"
 }
 
-export declare type ConnectionPreprocessor = (request: AddEdgeRequest) => AddEdgeRequest | ConnectionPreprocessorNullResponse;
-
-/**
- * @deprecated
- * connection preprocessor should not return null
- */
-declare type ConnectionPreprocessorNullResponse = null;
+export declare type ConnectionPreprocessor = (request: AddEdgeRequest) => AddEdgeRequest;
 
 export declare type ConnectionTypeResolver = (portId: Identifier) => "direct" | "reverse" | null;
 
@@ -355,7 +318,6 @@ export declare interface DirectEdgeParams {
 
 export declare class DirectEdgeShape implements StructuredEdgeShape {
     readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
     readonly line: SVGPathElement;
     readonly sourceArrow: SVGPathElement | null;
@@ -383,13 +345,15 @@ declare interface DotsRenderer {
 }
 
 export declare interface DraggableEdgesConfig {
-    readonly connectionPreprocessor?: ConnectionPreprocessor;
-    readonly connectionAllowedVerifier?: ConnectionAllowedVerifier;
-    readonly mouseDownEventVerifier?: MouseEventVerifier;
-    readonly mouseUpEventVerifier?: MouseEventVerifier;
-    readonly draggingEdgeResolver?: DraggingEdgeResolver;
-    readonly draggingEdgeShape?: EdgeShapeConfig;
-    readonly dragPortDirection?: DraggingPortDirectionConfig;
+    readonly connectionPreprocessor?: ConnectionPreprocessor | undefined;
+    readonly connectionAllowedVerifier?: ConnectionAllowedVerifier | undefined;
+    readonly mouseDownEventVerifier?: MouseEventVerifier | undefined;
+    readonly mouseUpEventVerifier?: MouseEventVerifier | undefined;
+    readonly draggingEdgeResolver?: DraggingEdgeResolver | undefined;
+    readonly draggingEdgeShape?: EdgeShapeConfig | undefined;
+    readonly dragPortDirection?: DraggingPortDirectionConfig | undefined;
+    readonly grabbedPortIdResolver?: PortIdResolver | undefined;
+    readonly releasedPortIdResolver?: PortIdResolver | undefined;
     readonly events?: {
         readonly onAfterEdgeReattached?: (edgeId: Identifier) => void;
         readonly onEdgeReattachInterrupted?: (edge: GraphEdge & {
@@ -418,12 +382,7 @@ export declare interface DraggableNodesConfig {
 
 export declare type DraggingEdgeResolver = (portId: Identifier) => Identifier | null;
 
-export declare type DraggingPortDirectionConfig = number | undefined
-/**
-* @deprecated
-* use "nearest-connectable-port" instead
-*/
-| "closest-connectable-port" | "nearest-connectable-port";
+export declare type DraggingPortDirectionConfig = number | "inherit" | "nearest-connectable-port";
 
 export declare interface EdgeCreationInProgressParams {
     readonly staticPortId: Identifier;
@@ -450,16 +409,11 @@ export declare interface EdgeRenderPort {
 }
 
 export declare interface EdgeShape {
-    /**
-     * @deprecated
-     * use element instead
-     */
-    readonly svg: SVGSVGElement;
     readonly element: SVGSVGElement;
     render(params: EdgeRenderParams): void;
 }
 
-declare type EdgeShapeConfig = BezierEdgeShapeConfig | StraightEdgeShapeConfig | HorizontalEdgeShapeConfig | VerticalEdgeShapeConfig | DirectEdgeShapeConfig | OrthogonalEdgeShapeConfig | EdgeShapeFactory;
+declare type EdgeShapeConfig = BezierEdgeShapeConfig | StraightEdgeShapeConfig | DirectEdgeShapeConfig | OrthogonalEdgeShapeConfig | EdgeShapeFactory;
 
 declare type EdgeShapeFactory = (edgeId: Identifier) => EdgeShape;
 
@@ -481,11 +435,6 @@ export declare class EventSubject<T> implements EventEmitter<T>, EventHandler<T>
 
 export declare type FocusConfig = {
     readonly contentPadding?: number | undefined;
-    /**
-     * @deprecated
-     * use contentPadding instead
-     */
-    readonly contentOffset?: number | undefined;
     readonly nodes?: Iterable<Identifier> | undefined;
     readonly minContentScale?: number | undefined;
     readonly animationDuration?: number | undefined;
@@ -670,58 +619,6 @@ declare class GraphStore {
     private removeEdgeInternal;
 }
 
-/**
- * @deprecated
- * use OrthogonalEdgeShape instead
- */
-export declare interface HorizontalEdgeParams {
-    readonly color?: string | undefined;
-    readonly width?: number | undefined;
-    readonly arrowLength?: number | undefined;
-    readonly arrowRenderer?: ArrowRendererConfig | undefined;
-    readonly arrowOffset?: number | undefined;
-    readonly hasSourceArrow?: boolean | undefined;
-    readonly hasTargetArrow?: boolean | undefined;
-    readonly cycleSquareSide?: number | undefined;
-    readonly roundness?: number | undefined;
-    readonly detourDistance?: number | undefined;
-}
-
-/**
- * @deprecated
- * use OrthogonalEdgeShape instead
- */
-export declare class HorizontalEdgeShape implements StructuredEdgeShape {
-    readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
-    readonly group: SVGGElement;
-    readonly line: SVGPathElement;
-    readonly sourceArrow: SVGPathElement | null;
-    readonly targetArrow: SVGPathElement | null;
-    readonly onAfterRender: EventHandler<StructuredEdgeRenderModel>;
-    private readonly arrowLength;
-    private readonly arrowOffset;
-    private readonly roundness;
-    private readonly cycleSquareSide;
-    private readonly detourDistance;
-    private readonly hasSourceArrow;
-    private readonly hasTargetArrow;
-    private readonly pathShape;
-    private readonly createCyclePath;
-    private readonly createDetourPath;
-    private readonly createLinePath;
-    constructor(params?: HorizontalEdgeParams);
-    render(params: EdgeRenderParams): void;
-}
-
-/**
- * @deprecated
- * use type: "orthogonal" instead
- */
-declare type HorizontalEdgeShapeConfig = {
-    readonly type: "horizontal";
-} & HorizontalEdgeParams;
-
 declare interface HtmlView {
     attachNode(nodeId: Identifier): void;
     detachNode(nodeId: Identifier): void;
@@ -751,16 +648,11 @@ export declare interface InteractiveEdgeParams {
 export declare class InteractiveEdgeShape implements StructuredEdgeShape {
     private readonly baseEdge;
     readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
     readonly line: SVGPathElement;
     readonly sourceArrow: SVGPathElement | null;
     readonly targetArrow: SVGPathElement | null;
-    /**
-     * @deprecated
-     * use shape.svg instead
-     */
-    readonly handle: SVGGElement;
+    private readonly handle;
     readonly onAfterRender: EventHandler<StructuredEdgeRenderModel>;
     private readonly interactiveLine;
     private readonly interactiveSourceArrow;
@@ -785,7 +677,7 @@ declare type LayoutAlgorithmConfig = {
     readonly nodeMass?: number | undefined;
     readonly edgeEquilibriumLength?: number | undefined;
     readonly edgeStiffness?: number | undefined;
-    readonly convergenceVelocity?: number | undefined;
+    readonly stopVelocity?: number | undefined;
     readonly maxForce?: number | undefined;
     readonly nodeForceCoefficient?: number | undefined;
     readonly barnesHut?: {
@@ -805,7 +697,7 @@ export declare interface LayoutAlgorithmParams {
     readonly viewport: Viewport;
 }
 
-export declare type LayoutApplyOn = TopologyChangeMacrotask | TopologyChangeMicrotask | "topologyChangeMicrotask" | EventSubject<void>;
+export declare type LayoutApplyOn = "topologyChangeMicrotask" | EventSubject<void>;
 
 export declare interface LayoutConfig {
     readonly algorithm?: LayoutAlgorithmConfig | undefined;
@@ -839,7 +731,6 @@ export declare class MidpointEdgeShape implements StructuredEdgeShape {
     readonly targetArrow: SVGPathElement | null;
     readonly onAfterRender: EventHandler<StructuredEdgeRenderModel>;
     readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
     constructor(baseShape: StructuredEdgeShape, midpointElement: SVGElement);
     render(params: EdgeRenderParams): void;
 }
@@ -872,7 +763,6 @@ export declare interface OrthogonalEdgeParams {
 
 export declare class OrthogonalEdgeShape implements StructuredEdgeShape {
     readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
     readonly line: SVGPathElement;
     readonly sourceArrow: SVGPathElement | null;
@@ -916,6 +806,8 @@ export declare interface Point {
 
 export declare type PortElement = HTMLElement | SVGElement;
 
+export declare type PortIdResolver = (portIds: readonly Identifier[]) => Identifier | null;
+
 export declare type PortOffset = number | PortOffsetFn | "box";
 
 export declare type PortOffsetFn = (params: PortOffsetFnParams) => number;
@@ -992,7 +884,6 @@ export declare interface StraightEdgeParams {
 
 export declare class StraightEdgeShape implements StructuredEdgeShape {
     readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
     readonly group: SVGGElement;
     readonly line: SVGPathElement;
     readonly sourceArrow: SVGPathElement | null;
@@ -1032,18 +923,6 @@ export declare interface StructuredEdgeShape extends EdgeShape {
     readonly onAfterRender: EventHandler<StructuredEdgeRenderModel>;
 }
 
-/**
- * @deprecated
- * use "topologyChangeMicrotask" instead
- */
-declare type TopologyChangeMacrotask = {
-    type: "topologyChangeMacrotask";
-};
-
-declare type TopologyChangeMicrotask = {
-    type: "topologyChangeMicrotask";
-};
-
 export declare type TransformDeclaration = {
     readonly a?: number | undefined;
     readonly b?: number | undefined;
@@ -1081,17 +960,17 @@ export declare type TransformPreprocessorFn = (params: TransformPreprocessorPara
 export declare interface TransformPreprocessorParams {
     readonly prevTransform: TransformState;
     readonly nextTransform: TransformState;
-    readonly canvasWidth: number;
-    readonly canvasHeight: number;
+    readonly viewport: {
+        readonly width: number;
+        readonly height: number;
+    };
 }
 
-declare interface TransformState {
+export declare interface TransformState {
     readonly scale: number;
     readonly x: number;
     readonly y: number;
 }
-export { TransformState as TransformPayload }
-export { TransformState }
 
 export declare interface UpdateEdgeRequest {
     readonly from?: Identifier | undefined;
@@ -1150,58 +1029,6 @@ export declare interface UserSelectableNodesConfig {
     readonly movementThreshold?: number | undefined;
 }
 
-/**
- * @deprecated
- * use OrthogonalEdgeShape instead
- */
-export declare interface VerticalEdgeParams {
-    readonly color?: string | undefined;
-    readonly width?: number | undefined;
-    readonly arrowLength?: number | undefined;
-    readonly arrowOffset?: number | undefined;
-    readonly arrowRenderer?: ArrowRendererConfig | undefined;
-    readonly hasSourceArrow?: boolean | undefined;
-    readonly hasTargetArrow?: boolean | undefined;
-    readonly cycleSquareSide?: number | undefined;
-    readonly roundness?: number | undefined;
-    readonly detourDistance?: number | undefined;
-}
-
-/**
- * @deprecated
- * use OrthogonalEdgeShape instead
- */
-export declare class VerticalEdgeShape implements StructuredEdgeShape {
-    readonly element: SVGSVGElement;
-    readonly svg: SVGSVGElement;
-    readonly group: SVGGElement;
-    readonly line: SVGPathElement;
-    readonly sourceArrow: SVGPathElement | null;
-    readonly targetArrow: SVGPathElement | null;
-    readonly onAfterRender: EventHandler<StructuredEdgeRenderModel>;
-    private readonly arrowLength;
-    private readonly arrowOffset;
-    private readonly roundness;
-    private readonly cycleSquareSide;
-    private readonly detourDistance;
-    private readonly hasSourceArrow;
-    private readonly hasTargetArrow;
-    private readonly pathShape;
-    private readonly createCyclePath;
-    private readonly createDetourPath;
-    private readonly createLinePath;
-    constructor(params?: VerticalEdgeParams);
-    render(params: EdgeRenderParams): void;
-}
-
-/**
- * @deprecated
- * use type: "orthogonal" instead
- */
-declare type VerticalEdgeShapeConfig = {
-    readonly type: "vertical";
-} & VerticalEdgeParams;
-
 export declare class Viewport {
     private readonly viewportStore;
     readonly onBeforeUpdated: EventHandler<void>;
@@ -1267,7 +1094,7 @@ export declare interface ViewportTransformConfig {
         readonly mouseWheelEventVerifier?: (event: WheelEvent) => boolean;
         readonly wheelFinishTimeout?: number;
     };
-    readonly shift?: {
+    readonly pan?: {
         readonly cursor?: string | null;
         readonly mouseDownEventVerifier?: MouseEventVerifier;
         readonly mouseUpEventVerifier?: MouseEventVerifier;