charturbo - v0.1.0
    Preparing search index...

    Interface HierarchyChartOptions

    interface HierarchyChartOptions {
        animation?: ChartAnimationInput;
        colorBy?: "value" | "group" | "auto";
        colormap?: "sequential" | "viridis" | "magma";
        colors?: ColorInput[];
        decal?: ChartDecalInput;
        description?: string;
        format?: ChartValueFormat;
        label?: RichLabelOptions<HierarchyLabelContext>;
        labels?: boolean;
        legend?: boolean | ChartLegendOptions;
        maxDepth?: number;
        padding?: ChartPaddingOptions;
        rootLabel?: string;
        title?: string;
        valueLabel?: string;
    }

    Hierarchy (View Summary)

    Index
    animation? colorBy? colormap? colors? decal? description? format? label? labels? legend? maxDepth? padding? rootLabel? title? valueLabel?
    animation?: ChartAnimationInput

    Enter / update animation of this chart (default: the SDK setting, setAnimation); { transition: true } morphs treemap <-> sunburst by node path

    colorBy?: "value" | "group" | "auto"

    'group': palette by top-level group, groups beyond the palette fold into a neutral "Other" color; 'value': sequential colormap of the value per depth; 'auto' (default): group when the top-level groups fit the palette, else value

    colormap?: "sequential" | "viridis" | "magma"

    Colormap of colorBy: 'value' (default 'sequential')

    colors?: ColorInput[]

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

    decal?: ChartDecalInput

    Pattern fills over the marks (accessibility, ECharts aria.decal): true gives each top-level group its own automatic pattern; options apply over the automatic patterns (default off). Nodes override with their own decal; treemap parent headers and the sunburst center stay plain

    description?: string

    Accessible name of the canvas

    format?: ChartValueFormat

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

    label?: RichLabelOptions<HierarchyLabelContext>

    Text of the labels the engine places (rich text {style|text} runs, see chart-rich-text.ts; treemap labels clip to their cell; header strips show the first line). Default: the name (treemap: + value when it fits)

    labels?: boolean

    DOM labels where they fit (default: true)

    legend?: boolean | ChartLegendOptions

    Top-level group legend (default: shown in group color mode with 2+ groups); hover emphasizes a group

    maxDepth?: number

    Levels shown below the current root (default: all)

    padding?: ChartPaddingOptions

    Plot margins (CSS px)

    rootLabel?: string

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

    title?: string
    valueLabel?: string

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

    Settings
    Member Visibility

    On This Page
    Properties