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

    Interface WaterfallPoint

    One step of a waterfall chart.

    A waterfall answers "how did we get from here to there", so a step carries two numbers that a bar chart would conflate: the contribution it made (delta) and the running total it produced (end). The bar is drawn floating between start and end, which is why neither alone describes it — the height is the contribution and the position is the total.

    start and end are absolute positions on the value axis, so a producer that only knows offsets has to accumulate them before emitting, the same way ErrorBarPoint fixes absolute bounds.

    interface WaterfallPoint {
        x: string | number;
        start: number;
        end: number;
        delta: number;
        kind: WaterfallKind;
    }
    Index

    Properties

    Properties

    x: string | number

    The step's label along the category axis.

    start: number

    Running total before this step.

    end: number

    Running total after this step.

    delta: number

    The signed contribution, end - start.

    Carried rather than derived because a producer may round the two totals for display, and a delta recomputed from rounded ends is not the number the chart's own label shows.

    Whether the step adds, subtracts, or restates the total.