charturbo - v0.1.0
    Preparing search index...

    Interface TreeChartOptions

    interface TreeChartOptions {
        colorBy?: "group" | "single";
        colors?: ColorInput[];
        curvature?: number;
        description?: string;
        edgeShape?: "curve" | "polyline";
        expandAndCollapse?: boolean;
        format?: ChartValueFormat;
        initialTreeDepth?: number;
        labels?: boolean;
        layout?: "orthogonal" | "radial";
        lineWidth?: number;
        orient?: "TB" | "LR" | "RL" | "BT";
        padding?: ChartPaddingOptions;
        rootLabel?: string;
        symbol?:
            | "none"
            | "rect"
            | "circle"
            | "triangle"
            | "diamond"
            | "emptyCircle";
        symbolSize?: number;
        title?: string;
        valueLabel?: string;
    }

    Hierarchy

    • Pick<
          HierarchyChartOptions,
          | "title"
          | "description"
          | "colors"
          | "format"
          | "labels"
          | "padding"
          | "valueLabel"
          | "rootLabel",
      >
      • TreeChartOptions
    Index
    colorBy? colors? curvature? description? edgeShape? expandAndCollapse? format? initialTreeDepth? labels? layout? lineWidth? orient? padding? rootLabel? symbol? symbolSize? title? valueLabel?
    colorBy?: "group" | "single"

    'single' (default): one color; 'group': palette by top-level branch

    colors?: ColorInput[]

    Categorical palette in fixed order (default: the theme palette)

    curvature?: number

    Bezier control offset 0-1 (default 0.5)

    description?: string

    Accessible name of the canvas

    edgeShape?: "curve" | "polyline"

    'curve' (cubic bezier, default) or 'polyline' (elbow; the radial layout always curves)

    expandAndCollapse?: boolean

    Click / Enter / Space expand and collapse parents (default: true)

    format?: ChartValueFormat

    Value text of labels, tooltip, center and a11y (spec like '$,.0f', Intl options, or a function)

    initialTreeDepth?: number

    Levels expanded at first (root = 0; default 2; -1 = all); collapsed per node wins

    labels?: boolean

    DOM labels where they fit (default: true)

    layout?: "orthogonal" | "radial"

    'orthogonal' (default) or 'radial' (root in the center, leaves on the rim)

    lineWidth?: number

    Edge width in CSS px (default 1.5)

    orient?: "TB" | "LR" | "RL" | "BT"

    Orthogonal direction root → leaves: left-right (default), right-left, top-bottom, bottom-top

    padding?: ChartPaddingOptions

    Plot margins (CSS px)

    rootLabel?: string

    Name of the synthetic root above several roots (default: 'All' in the chart language)

    symbol?: "none" | "rect" | "circle" | "triangle" | "diamond" | "emptyCircle"

    Node symbol (default 'emptyCircle': hollow; collapsed parents are filled)

    symbolSize?: number

    Symbol diameter in CSS px (default 7)

    title?: string
    valueLabel?: string

    Tooltip / table name of the values (default: 'Value' in the chart language)

    Settings
    Member Visibility

    On This Page
    Properties