@benportner/js_family_tree
    Preparing search index...

    Interface FamilyTreeOptions

    Options for configuring the FamilyTree. Combines layout and rendering options, plus additional controls.

    interface FamilyTreeOptions {
        coord: Coord<ClickableNode, any>;
        decross: Decross<ClickableNode, any>;
        layering: Layering<ClickableNode, any>;
        nodeSize: NodeSize<ClickableNode, any>;
        orientation: Orientation;
        showAll: boolean;
        transitionDuration: number;
        linkCSSClassFunction(link: LayoutedLink): string;
        linkPathFunction(link: CoordLink, orientation: Orientation): string;
        nodeClickFunction(node: LayoutedNode, ft: FamilyTree): void;
        nodeCSSClassFunction(node: LayoutedNode): string;
        nodeLabelFunction(node: LayoutedNode, missingData?: string): string[];
        nodeSizeFunction(node: LayoutedNode): number;
        nodeTooltipFunction(
            node: LayoutedNode,
            missingData?: string,
        ): undefined | string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    coord decross layering nodeSize orientation showAll transitionDuration

    Methods

    linkCSSClassFunction linkPathFunction nodeClickFunction nodeCSSClassFunction nodeLabelFunction nodeSizeFunction nodeTooltipFunction

    Properties

    coord: Coord<ClickableNode, any>

    Coordinate assignment algorithm for node placement.

    decross: Decross<ClickableNode, any>

    Decrossing algorithm to reduce edge crossings.

    layering: Layering<ClickableNode, any>

    Layering algorithm for the layout.

    nodeSize: NodeSize<ClickableNode, any>

    Function to determine the size of each node.

    orientation: Orientation

    Orientation of the layout (horizontal or vertical).

    showAll: boolean

    If true, all nodes are set to visible on initialization.

    transitionDuration: number

    Duration of transitions in milliseconds.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods