@maxgraph/core/lib/esm/view/layout/RadialTreeLayout.d.ts

maxGraph is a fully client side JavaScript diagramming library that uses SVG and HTML for rendering.

import { CompactTreeLayout, _mxCompactTreeLayoutNode } from './CompactTreeLayout.js';
import type Cell from '../cell/Cell.js';
import type { AbstractGraph } from '../AbstractGraph.js';
/**
 * Extends {@link CompactTreeLayout} to implement a radial tree algorithm. This
 * layout is suitable for graphs that have no cycles (trees). Vertices that are
 * not connected to the tree will be ignored by this layout.
 *
 * ```javascript
 * const layout = new RadialTreeLayout(graph);
 * layout.execute(graph.getDefaultParent());
 * ```
 *
 * @category Layout
 */
declare class RadialTreeLayout extends CompactTreeLayout {
    constructor(graph: AbstractGraph);
    centerX: number | null;
    centerY: number | null;
    /**
     * The initial offset to compute the angle position.
     * @default 0.5
     */
    angleOffset: number;
    /**
     * The X co-ordinate of the root cell
     * @default 0
     */
    rootx: number;
    /**
     * The Y co-ordinate of the root cell
     * @default 0
     */
    rooty: number;
    /**
     * Holds the levelDistance.
     * @default 120
     */
    levelDistance: number;
    /**
     * Holds the nodeDistance.
     * @default 10
     */
    nodeDistance: number;
    /**
     * Specifies if the radios should be computed automatically
     * @default false
     */
    autoRadius: boolean;
    /**
     * Specifies if edges should be sorted according to the order of their
     * opposite terminal cell in the model.
     * @default false
     */
    sortEdges: boolean;
    /**
     * Array of leftmost x coordinate of each row
     */
    rowMinX: {
        [key: number]: number;
    };
    /**
     * Array of rightmost x coordinate of each row
     */
    rowMaxX: {
        [key: number]: number;
    };
    /**
     * Array of x coordinate of leftmost vertex of each row
     */
    rowMinCenX: {
        [key: number]: number;
    };
    /**
     * Array of x coordinate of rightmost vertex of each row
     */
    rowMaxCenX: {
        [key: number]: number;
    };
    /**
     * Array of y deltas of each row behind root vertex, also the radius in the tree
     */
    rowRadi: {
        [key: number]: number;
    };
    /**
     * Array of vertices on each row
     */
    row: _mxCompactTreeLayoutNode[][];
    /**
     * Returns a boolean indicating if the given {@link Cell} should be ignored as a vertex.
     *
     * @param vertex {@link Cell} whose ignored state should be returned.
     * @return true if the cell has no connections.
     */
    isVertexIgnored(vertex: Cell): boolean;
    /**
     * Implements {@link GraphLayout#execute}.
     *
     * If the parent has any connected edges, then it is used as the root of
     * the tree. Else, {@link AbstractGraph.findTreeRoots} will be used to find a suitable
     * root node within the set of children of the given parent.
     *
     * @param parent    {@link Cell} whose children should be laid out.
     * @param root      Optional {@link Cell} that will be used as the root of the tree.
     */
    execute(parent: Cell, root?: Cell | null): void;
    /**
     * Recursive function to calculate the dimensions of each row
     *
     * @param row      Array of internal nodes, the children of which are to be processed.
     * @param rowNum   Integer indicating which row is being processed.
     */
    calcRowDims(row: _mxCompactTreeLayoutNode[], rowNum: number): void;
}
export default RadialTreeLayout;