Skip to main content

Interface: WaterfallChartOptions

Defined in: src/mobjects/graphing/WaterfallChart.ts:29

Options for creating a WaterfallChart.

Properties​

axisColor?​

optional axisColor: string

Defined in: src/mobjects/graphing/WaterfallChart.ts:63

Color for the axes and labels. Default: WHITE

barGap?​

optional barGap: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:49

Gap between adjacent bars. Default: 0.4

barStrokeWidth?​

optional barStrokeWidth: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:53

Stroke width of the bar outline. Default: 1.5

barWidth?​

optional barWidth: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:47

Width of each bar. Default: 0.6

connectorWidth?​

optional connectorWidth: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:51

Stroke width of the connector lines. Default: 1.5

decreaseColor?​

optional decreaseColor: string

Defined in: src/mobjects/graphing/WaterfallChart.ts:37

Color for negative contributions. Default: RED.

fillOpacity?​

optional fillOpacity: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:55

Fill opacity of the bars. Default: 0.9

height?​

optional height: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:59

Visual height of the chart area. Default: 5

includeYLabels?​

optional includeYLabels: boolean

Defined in: src/mobjects/graphing/WaterfallChart.ts:67

Whether to include y-axis number labels. Default: true

includeYTicks?​

optional includeYTicks: boolean

Defined in: src/mobjects/graphing/WaterfallChart.ts:65

Whether to include y-axis tick marks. Default: true

increaseColor?​

optional increaseColor: string

Defined in: src/mobjects/graphing/WaterfallChart.ts:35

Color for positive contributions. Default: GREEN.

labelFontSize?​

optional labelFontSize: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:71

Font size for the bar labels. Default: 18

labels?​

optional labels: string[]

Defined in: src/mobjects/graphing/WaterfallChart.ts:33

Labels for each bar. Default: []

showConnectors?​

optional showConnectors: boolean

Defined in: src/mobjects/graphing/WaterfallChart.ts:41

Whether to draw connector lines between bars. Default: true

showLabels?​

optional showLabels: boolean

Defined in: src/mobjects/graphing/WaterfallChart.ts:69

Whether to draw the per-bar labels. Default: true

showTotal?​

optional showTotal: boolean

Defined in: src/mobjects/graphing/WaterfallChart.ts:43

Whether to append a total bar spanning 0 to the sum. Default: false

totalColor?​

optional totalColor: string

Defined in: src/mobjects/graphing/WaterfallChart.ts:39

Color for the total bar. Default: BLUE.

totalLabel?​

optional totalLabel: string

Defined in: src/mobjects/graphing/WaterfallChart.ts:45

Label for the appended total bar. Default: 'Total'

values​

values: number[]

Defined in: src/mobjects/graphing/WaterfallChart.ts:31

Sequential contributions (deltas), left to right.

width?​

optional width: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:61

Visual width of the chart area. Default: 8

yLabelFontSize?​

optional yLabelFontSize: number

Defined in: src/mobjects/graphing/WaterfallChart.ts:73

Font size for the y-axis labels. Default: 20

yRange?​

optional yRange: [number, number, number]

Defined in: src/mobjects/graphing/WaterfallChart.ts:57

Y-axis range as [min, max, step]. Default: auto-scaled from the running totals.