@jsfkit/types
    Preparing search index...

    Type Alias ChartTransformWaterfall

    ChartTransformWaterfall: ChartTransformBase & {
        as: { end: string; start: string };
        categoryField: string;
        field: string;
        groupBy?: string[];
        subtotals?: integer[];
        type: "waterfall";
    }

    Computes running start and end values for waterfall charts.

    Type Declaration

    • as: { end: string; start: string }

      Names of the generated fields.

      • end: string

        The field that receives where each column ends.

      • start: string

        The field that receives where each column starts.

    • categoryField: string

      The field holding each column's category.

    • field: string

      The field holding each column's change. A subtotal or total column shows its own value from zero, whatever the running total before it.

    • OptionalgroupBy?: string[]

      Fields to accumulate separately, for example ['series'] for a running total per series. When absent, all records form one running total.

    • Optionalsubtotals?: integer[]

      Zero-based indexes of the records that are subtotals or totals. When absent, there are none.

    • type: "waterfall"

      Computes running totals for a waterfall.