charts/io.github.hdcharts.waterfall/WaterfallData

WaterfallData

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

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.

Constructors

WaterfallData

constructor(entries: ImmutableList<WaterfallEntry>)

constructor(entries: List<WaterfallEntry>)

Copies entries into an immutable list, including results of domain-model mapping with map.

Properties

entries

val entries: ImmutableList<WaterfallEntry>

Functions

runningTotalAt

fun runningTotalAt(index: Int): Double

Returns the computed balance after the source entry at index, for use with ChartSelection. Uses Double addition in entry order, as the chart does. index must be within entries.