@flowgram-vue/free-auto-layout-plugin 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,377 @@
+import { Graph } from '@dagrejs/graphlib';
+export { Graph as DagreGraph } from '@dagrejs/graphlib';
+import * as _flowgram_vue_core from '@flowgram-vue/core';
+import { WorkflowNodeEntity, WorkflowLineEntity } from '@flowgram-vue/free-layout-core';
+
+declare function layout(g: any, opts: any): void;
+declare function buildLayoutGraph(inputGraph: any): Graph;
+declare function updateInputGraph(inputGraph: any, layoutGraph: any): void;
+declare function makeSpaceForEdgeLabels(g: any): void;
+declare function removeSelfEdges(g: any): void;
+declare function injectEdgeLabelProxies(g: any): void;
+declare function assignRankMinMax(g: any): void;
+declare function removeEdgeLabelProxies(g: any): void;
+declare function insertSelfEdges(g: any): void;
+declare function positionSelfEdges(g: any): void;
+declare function removeBorderNodes(g: any): void;
+declare function fixupEdgeLabelCoords(g: any): void;
+declare function translateGraph(g: any): void;
+declare function assignNodeIntersects(g: any): void;
+declare function reversePointsForReversedEdges(g: any): void;
+
+declare namespace acyclic {
+    export { run$2 as run };
+    export { undo$2 as undo };
+}
+
+declare function run$2(g: any): void;
+declare function undo$2(g: any): void;
+
+declare namespace nestingGraph {
+    export { run$1 as run };
+    export { cleanup };
+}
+
+declare function run$1(g: any): void;
+declare function cleanup(g: any): void;
+
+declare function rank(g: any): void;
+
+declare namespace util {
+    export { addBorderNode };
+    export { addDummyNode };
+    export { applyWithChunking };
+    export { asNonCompoundGraph };
+    export { buildLayerMatrix };
+    export { intersectRect };
+    export { mapValues };
+    export { maxRank };
+    export { normalizeRanks };
+    export { notime };
+    export { partition };
+    export { pick };
+    export { predecessorWeights };
+    export { range };
+    export { removeEmptyRanks };
+    export { simplify };
+    export { successorWeights };
+    export { time };
+    export { uniqueId };
+    export { zipObject };
+}
+declare function addBorderNode(g: any, prefix: any, rank: any, order: any, ...args: any[]): string;
+declare function addDummyNode(g: any, type: any, attrs: any, name: any): string;
+declare function applyWithChunking(fn: any, argsArray: any): any;
+declare function asNonCompoundGraph(g: any): Graph;
+declare function buildLayerMatrix(g: any): never[][];
+declare function intersectRect(rect: any, point: any): {
+    x: any;
+    y: any;
+};
+declare function mapValues(obj: any, funcOrProp: any): {};
+declare function maxRank(g: any): any;
+declare function normalizeRanks(g: any): void;
+declare function notime(name: any, fn: any): any;
+declare function partition(collection: any, fn: any): {
+    lhs: never[];
+    rhs: never[];
+};
+declare function pick(source: any, keys: any): {};
+declare function predecessorWeights(g: any): any;
+declare function range(start: any, limit: any, step?: number): any[];
+declare function removeEmptyRanks(g: any): void;
+declare function simplify(g: any): Graph;
+declare function successorWeights(g: any): any;
+declare function time(name: any, fn: any): any;
+declare function uniqueId(prefix: any): string;
+declare function zipObject(props: any, values: any): any;
+
+declare namespace normalize {
+    export { run };
+    export { undo$1 as undo };
+}
+
+declare function run(g: any): void;
+declare function undo$1(g: any): void;
+
+declare function parentDummyChains(g: any): void;
+
+declare function addBorderSegments(g: any): void;
+
+declare function order(g: any, opts: any): void;
+
+declare namespace coordinateSystem {
+    export { adjust };
+    export { undo };
+}
+
+declare function adjust(g: any): void;
+declare function undo(g: any): void;
+
+declare function position(g: any): void;
+
+declare namespace dagreLib {
+    export { layout };
+    export { buildLayoutGraph };
+    export { updateInputGraph };
+    export { makeSpaceForEdgeLabels };
+    export { removeSelfEdges };
+    export { acyclic };
+    export { nestingGraph };
+    export { rank };
+    export { util };
+    export { injectEdgeLabelProxies };
+    export { removeEmptyRanks };
+    export { normalizeRanks };
+    export { assignRankMinMax };
+    export { removeEdgeLabelProxies };
+    export { normalize };
+    export { parentDummyChains };
+    export { addBorderSegments };
+    export { order };
+    export { insertSelfEdges };
+    export { coordinateSystem };
+    export { position };
+    export { positionSelfEdges };
+    export { removeBorderNodes };
+    export { fixupEdgeLabelCoords };
+    export { translateGraph };
+    export { assignNodeIntersects };
+    export { reversePointsForReversedEdges };
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface ILayoutStore {
+    container: LayoutNode;
+    options: LayoutOptions;
+    get initialized(): boolean;
+    getNode(id?: string): LayoutNode | undefined;
+    getNodeByIndex(index: string): LayoutNode | undefined;
+    getEdge(id: string): LayoutEdge | undefined;
+    nodes: LayoutNode[];
+    edges: LayoutEdge[];
+    create(params: LayoutParams, options: LayoutOptions): void;
+}
+interface ILayout {
+    init(params: LayoutParams, options: LayoutOptions): void;
+    layout(): void;
+    position(): Promise<void>;
+}
+interface LayoutSize {
+    width: number;
+    height: number;
+}
+interface LayoutNode {
+    id: string;
+    /** 节点索引 */
+    index: string;
+    /** 节点实体 */
+    entity: WorkflowNodeEntity;
+    /** 层级 */
+    rank: number;
+    /** 顺序 */
+    order: number;
+    /** 位置 */
+    position: {
+        x: number;
+        y: number;
+    };
+    /** 偏移量 */
+    offset: {
+        x: number;
+        y: number;
+    };
+    /** 边距 */
+    padding: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+    /** 宽高 */
+    size: LayoutSize;
+    /** 子节点 */
+    layoutNodes: LayoutNode[];
+    /** 子线条 */
+    layoutEdges: LayoutEdge[];
+    /** 被跟随节点 */
+    followedBy?: string[];
+    /** 跟随节点 */
+    followTo?: string;
+}
+interface LayoutEdge {
+    id: string;
+    /** 线条实体 */
+    entity: WorkflowLineEntity;
+    /** 起点 */
+    from: string;
+    /** 终点 */
+    to: string;
+    /** 起点索引 */
+    fromIndex: string;
+    /** 终点索引 */
+    toIndex: string;
+    /** 线条名称 */
+    name: string;
+}
+interface LayoutParams {
+    container: LayoutNode;
+    layoutNodes: LayoutNode[];
+    layoutEdges: LayoutEdge[];
+}
+interface LayoutOptions {
+    /** Custom layout configuration to override default dagre settings. */
+    layoutConfig?: Partial<LayoutConfig>;
+    /** The container node entity used as the root for the layout. */
+    containerNode?: WorkflowNodeEntity;
+    /** Custom function to determine follow-node relationships between layout nodes. */
+    getFollowNode?: GetFollowNode;
+    /** Whether to animate node movements during layout positioning. */
+    enableAnimation?: boolean;
+    /** Duration of the position animation in milliseconds. Only effective when `enableAnimation` is true. */
+    animationDuration?: number;
+    /** When true, skips the fit-view step after layout is applied. */
+    disableFitView?: boolean;
+    /**
+     * When true, aligns nodes by their top edge instead of their center point.
+     * Defaults to false (center-aligned). Set to true to place all nodes' top edges on the same horizontal line.
+     */
+    alignTopEdge?: boolean;
+    /** Filter function to exclude specific nodes from the layout. Return false to skip a node. */
+    filterNode?: (params: {
+        node: WorkflowNodeEntity;
+        parent?: WorkflowNodeEntity;
+    }) => boolean;
+    /** Filter function to exclude specific edges from the layout. Return false to skip an edge. */
+    filterLine?: (params: {
+        line: WorkflowLineEntity;
+    }) => boolean;
+}
+interface LayoutConfig {
+    /** Direction for rank nodes. Can be TB, BT, LR, or RL, where T = top, B = bottom, L = left, and R = right. */
+    rankdir: 'TB' | 'BT' | 'LR' | 'RL';
+    /** Alignment for rank nodes. Can be UL, UR, DL, or DR, where U = up, D = down, L = left, and R = right. */
+    align: 'UL' | 'UR' | 'DL' | 'DR' | undefined;
+    /** Number of pixels that separate nodes horizontally in the layout. */
+    nodesep: number;
+    /** Number of pixels that separate edges horizontally in the layout. */
+    edgesep: number;
+    /** Number of pixels that separate edges horizontally in the layout. */
+    ranksep: number;
+    /** Number of pixels to use as a margin around the left and right of the graph. */
+    marginx: number;
+    /** Number of pixels to use as a margin around the top and bottom of the graph. */
+    marginy: number;
+    /** If set to greedy, uses a greedy heuristic for finding a feedback arc set for a graph. A feedback arc set is a set of edges that can be removed to make a graph acyclic. */
+    acyclicer: 'greedy' | undefined;
+    /** Type of algorithm to assigns a rank to each node in the input graph. Possible values: network-simplex, tight-tree or longest-path */
+    ranker: 'network-simplex' | 'tight-tree' | 'longest-path';
+}
+type GetFollowNode = (node: LayoutNode, context: {
+    store: ILayoutStore;
+    /** 业务自定义参数 */
+    [key: string]: any;
+}) => {
+    followTo?: string;
+} | undefined;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface AutoLayoutOptions {
+    layoutConfig?: Partial<LayoutConfig>;
+}
+
+/**
+ * Auto layout plugin - 自动布局插件
+ * https://flowgram.ai/guide/plugin/free-auto-layout-plugin.html
+ */
+declare const createFreeAutoLayoutPlugin: _flowgram_vue_core.PluginCreator<AutoLayoutOptions>;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare class Layout implements ILayout {
+    private readonly _store;
+    private readonly _layout;
+    private readonly _position;
+    constructor(config: LayoutConfig);
+    init(params: LayoutParams, options: LayoutOptions): void;
+    layout(): void;
+    position(): Promise<void>;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare class LayoutStore implements ILayoutStore {
+    readonly config: LayoutConfig;
+    private indexMap;
+    private init;
+    private store;
+    options: LayoutOptions;
+    container: LayoutNode;
+    constructor(config: LayoutConfig);
+    get initialized(): boolean;
+    getNode(id?: string): LayoutNode | undefined;
+    getNodeByIndex(index: string): LayoutNode | undefined;
+    getEdge(id: string): LayoutEdge | undefined;
+    get nodes(): LayoutNode[];
+    get edges(): LayoutEdge[];
+    create(params: LayoutParams, options: LayoutOptions): void;
+    /** 创建布局数据 */
+    private createStore;
+    /** 创建虚拟线条数据 */
+    private createVirtualEdges;
+    /** 创建节点索引映射 */
+    private createIndexMap;
+    /** 节点排序 */
+    private sortNodes;
+    /** 记录运行选项 */
+    private setOptions;
+    /** 设置跟随节点配置 */
+    private setFollowNode;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare const DefaultLayoutConfig: LayoutConfig;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare class AutoLayoutService {
+    private playground;
+    private readonly document;
+    private layoutConfig;
+    init(options: AutoLayoutOptions): void;
+    layout(options?: Partial<LayoutOptions>): Promise<void>;
+    private fitView;
+    private layoutNode;
+    private createLayoutNodes;
+    /** 创建节点布局数据 */
+    private createLayoutNode;
+    private createLayoutEdges;
+    /** 创建线条布局数据 */
+    private createLayoutEdge;
+    private getNodesAllLines;
+    private getLayoutNodeRect;
+    private layoutNodeRect;
+}
+
+export { AutoLayoutService, DefaultLayoutConfig, type GetFollowNode, Layout, type LayoutEdge, type LayoutNode, type LayoutOptions, LayoutStore, createFreeAutoLayoutPlugin, dagreLib };