backpack-compose/net.skyscanner.backpack.compose.barchart/BpkBarChartModel

BpkBarChartModel

data class BpkBarChartModel(val caption: String, val items: List<BpkBarChartModel.Item>, val legend: BpkBarChartModel.Legend? = null)

Represents the view model used to provide data to the bar chart.

Parameters

caption

a chart caption.

items

list of bar items to render.

legend

an optional legend.

Constructors

BpkBarChartModel

constructor(caption: String, items: List<BpkBarChartModel.Item>, legend: BpkBarChartModel.Legend? = null)

Types

Item

@Immutable

data class Item(val key: Any, val title: String, val subtitle: String, val group: String, val contentDescription: String, val values: BpkBarChartModel.Values? = null)

Represents a single bar in the chart.

Legend

data class Legend(val selectedTitle: String, val activeTitle: String, val inactiveTitle: String)

Represents a legend for the chart. Two types of legends are available, active and inactive. Those relate to the inactive prop of the bar. Inactive bars will have the same style as the inactive legend and active bars the same style as the active legend.

Values

data class Values(val text: String, @FloatRange(from = 0.0, to = 1.0) val percent: Float)

Represents a set of values of a single bar in chart

Properties

caption

val caption: String

items

val items: List<BpkBarChartModel.Item>

legend

val legend: BpkBarChartModel.Legend? = null