Waterfall series options

WaterfallSeriesOptions, WaterfallStepKind: generated from the source of active-charts.

Exported by @workspace/active-charts. Generated from the package source; part of the index of every export.

Types#

interface WaterfallSeriesOptions extends BarSizingOptions {
  type: 'waterfall';
  xKey: string;
  yKey: string;
  id?: string;
  name?: string;
  visible?: boolean;
  showInLegend?: boolean;
  yAxisId?: string;
  highlightStyle?: HighlightStyleOptions;
  kindKey?: string;
  positive?: {fill?: string; stroke?: string};
  negative?: {fill?: string; stroke?: string};
  total?: {fill?: string; stroke?: string};
  connectorLine?: boolean;
  connectorStroke?: string;
  cornerRadius?: number;
  label?: LabelOptions;
  animation?: boolean | SeriesAnimationOptions;
}

WaterfallStepKind

The kind of a waterfall row (T9), read from the field kindKey names.

'change': a step; it moves the balance by the row's value.
'subtotal': the net movement since the previous subtotal or total (or since the start); it floats from that balance to the current one.
'total': the current balance, standing on zero.

A subtotal and a total never move the balance; both become the point the next subtotal floats from. Row position never decides a kind.

type WaterfallStepKind = 'change' | 'subtotal' | 'total';