pivotick - v2.0.1
    Preparing search index...

    Interface EgoTreeLayoutOptions

    interface EgoTreeLayoutOptions {
        horizontal?: boolean;
        levelSpacing?: number;
        radial?: boolean;
        radialGap: number;
        rootId: string;
        rootIdAlgorithmFinder: TreeLayoutAlgorithm;
        siblingSpacing?: number;
        spacing?: "auto" | "manual";
        strength?: number;
        type: "egoTree";
    }

    Hierarchy

    • Omit<TreeLayoutOptions, "rootId" | "type" | "parentKey" | "depthKey">
      • EgoTreeLayoutOptions
    Index

    Properties

    horizontal?: boolean

    Should the nodes be placed horizontally rather than vertically

    false
    
    levelSpacing?: number

    Multiplies the distance between consecutive levels — the depth axis of the tree, or the gap between rings in radial mode. At 1 the tree is scaled to fill the canvas.

    1
    
    radial?: boolean

    Should the nodes be placed radially instead of vertically

    false
    
    radialGap: number

    The grap between each layers used in the radial mode

    750
    
    rootId: string
    rootIdAlgorithmFinder: TreeLayoutAlgorithm

    The algorithm to use to find the root of the tree

    'MaxReachability'
    
    siblingSpacing?: number

    Multiplies the distance between nodes within a level — the breadth axis. Ignored in radial mode, where a level always spans the full circle.

    1
    
    spacing?: "auto" | "manual"

    Whether the two spacing multipliers tune themselves from the size of the nodes and the shape of the tree, or stay exactly where they are put.

    'auto' is the default — except for a tree that sets levelSpacing or siblingSpacing explicitly, which is taken as having made up its mind. Turning either multiplier by hand afterwards also leaves auto, permanently.

    'auto'
    
    strength?: number

    The strength of the force keeping the nodes placed to form a tree in place

    0.1
    
    type: "egoTree"