MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface ChartJsSankeyValue

    One flow of a chartjs-chart-sankey dataset.

    Unlike the treemap plugin, the sankey controller leaves dataset.data exactly as the caller wrote it — measured, the {from, to, flow} rows come back verbatim after chart.update(). So the reading is the rows, and the nodes the controller derives are never read: MAIDR derives its own from the same edges, and a second list would be a second source of truth.

    A row with no flow is not a case to handle — the plugin itself throws laying it out, before MAIDR sees the chart. Zero and negative flows draw fine and are read.

    interface ChartJsSankeyValue {
        from: string | number;
        to: string | number;
        flow: number;
    }
    Index

    Properties

    Properties

    from: string | number

    The node the flow leaves.

    to: string | number

    The node it arrives at.

    flow: number

    How much flows.