charts/io.github.hdcharts.waterfall

Package-level declarations

Types

data class WaterfallBarsStyle(val positiveColor: Color, val negativeColor: Color, val totalColor: Color, val maxBarWidth: Dp, val space: Dp)

Bar colors and dimensions. maxBarWidth caps each bar's width; bars shrink to fit the chart. space is the requested gap, capped at half a category slot in narrow containers.

WaterfallChartDefaults

object WaterfallChartDefaults

Theme-aware defaults for waterfall charts.

WaterfallChartStyle

@Immutable

class WaterfallChartStyle(val chartContainerStyle: ChartContainerStyle, val bars: WaterfallBarsStyle, val connectors: AxisLinesStyle, val axes: AxesStyle, val range: BarRangeStyle, val selection: BarSelectionStyle, val legend: LegendStyle)

Presentation for WaterfallChart, using the shared axes, selection indicator, range and legend.

WaterfallData

@Immutable

data class WaterfallData(val entries: ImmutableList<WaterfallEntry>)

Ordered changes and computed totals. At least one entry is required by WaterfallChart. Changes and every intermediate balance must be finite. A total carries no supplied value, so it cannot add the same amount twice. Consecutive totals display the same balance.

WaterfallEntry

@Immutable

sealed interface WaterfallEntry

One labeled step in a WaterfallChart. The running balance starts at zero.

Functions

WaterfallChart

@Composable

fun WaterfallChart(data: WaterfallData, modifier: Modifier = Modifier, style: WaterfallChartStyle = WaterfallChartDefaults.style(), title: String? = null, selection: ChartSelection = rememberChartSelection(), interactionEnabled: Boolean = true, animateOnStart: Boolean = true, valueFormatter: ChartValueFormatter = WaterfallChartDefaults.valueFormatter, axisValueFormatter: ChartValueFormatter = WaterfallChartDefaults.axisValueFormatter)

Draws floating change bars joined at their running balances, and total bars from zero.