charturbo - v0.1.0
    Preparing search index...

    Interface ChordChartOptions

    interface ChordChartOptions {
        arcWidth?: number;
        clockwise?: boolean;
        colors?: (ColorInput | undefined)[];
        description?: string;
        directed?: boolean;
        format?: ChartValueFormat;
        labelRotate?: boolean;
        labels?: boolean;
        legend?: boolean | ChartLegendOptions;
        padAngle?: number;
        padding?: ChartPaddingOptions;
        palette?: ColorInput[];
        ribbonColor?: "source" | "target" | "neutral" | "gradient";
        ribbonOpacity?: number;
        sortChords?: ChordSortOrder;
        sortGroups?: ChordSortOrder;
        sortSubgroups?: ChordSortOrder;
        startAngle?: number;
        title?: string;
        valueLabel?: string;
    }
    Index
    arcWidth? clockwise? colors? description? directed? format? labelRotate? labels? legend? padAngle? padding? palette? ribbonColor? ribbonOpacity? sortChords? sortGroups? sortSubgroups? startAngle? title? valueLabel?
    arcWidth?: number

    Group arc width in CSS px (default 14)

    clockwise?: boolean

    Groups run clockwise (default true)

    colors?: (ColorInput | undefined)[]

    Own color per group (default: the node colors, then the palette)

    description?: string

    Accessible name of the canvas

    directed?: boolean

    One ribbon per direction (d3 chordDirected, arrow tips at the target; default false)

    format?: ChartValueFormat

    Value text of tooltip and a11y (spec, Intl options or function; default: locale number)

    labelRotate?: boolean

    Names read along the radius instead of level (default false)

    labels?: boolean

    Group names outside the ring (default true)

    legend?: boolean | ChartLegendOptions

    Group legend: hover emphasizes a group's ribbons, click hides it (re-laid out)

    padAngle?: number

    Gap between groups in degrees (default 3)

    padding?: ChartPaddingOptions
    palette?: ColorInput[]

    Palette of the groups without their own color (default: the theme palette)

    ribbonColor?: "source" | "target" | "neutral" | "gradient"

    Ribbon color: source group (default), target group, a source-to-target gradient, or neutral

    ribbonOpacity?: number

    Ribbon opacity 0-1 (default 0.6)

    sortChords?: ChordSortOrder

    Draw order of the ribbons by their two values' sum (default: d3 order)

    sortGroups?: ChordSortOrder

    Group order by total (default: input order)

    sortSubgroups?: ChordSortOrder

    Order of each group's ribbons by value (default: input order)

    startAngle?: number

    Where the first group starts, degrees clockwise from 12 o'clock (default 0)

    title?: string
    valueLabel?: string

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

    Settings
    Member Visibility

    On This Page
    Properties