charts/io.github.hdcharts.charts.model

Package-level declarations

Types

ChartData

@Immutable

data class ChartData(val categories: ImmutableList<String>, val series: ImmutableList<ChartSeries>)

Immutable, indexed data shared by aligned-series charts.

ChartSelection

@Stable

class ChartSelection(initialIndex: Int? = null, onSelectionChanged: (Int?) -> Unit? = null)

Hoisted selection state for charts that support selecting a single data point (e.g. a pie slice).

ChartSeries

@Immutable

data class ChartSeries(val name: String? = null, val values: ImmutableList<Double>)

A single named series of values within a ChartData.

ChartValueFormatter

fun interface ChartValueFormatter

Formats a raw chart value for display.

ChartValueFormatters

object ChartValueFormatters

Standard ChartValueFormatter factories.

PieSlice

@Immutable

data class PieSlice(val label: String, val value: Double, val color: Color? = null)

A single slice of a pie chart.

SelectionLifetime

sealed interface SelectionLifetime

Background lifecycle policy for a ChartSelection.

Functions

chartDataOf

fun chartDataOf(categories: List<String> = emptyList(), vararg series: ChartSeries): ChartData

Builds a ChartData from shared categories and one or more series.

rememberChartSelection

@Composable

fun rememberChartSelection(initialIndex: Int? = null, onSelectionChanged: (Int?) -> Unit? = null): ChartSelection

Creates a ChartSelection remembered for the current composition.

rememberSelectionLifecycle

@Composable

fun rememberSelectionLifecycle(selection: ChartSelection, data: Any?, itemCount: Int = Int.MAX_VALUE, lifetime: SelectionLifetime = SelectionLifetime.Persistent, autoDeselectTrigger: Any? = selection.version)

Drives the background lifecycle of a ChartSelection:

staticChartSelection

fun staticChartSelection(index: Int): ChartSelection

Creates a new, unremembered ChartSelection initialized to index, e.g. for screenshots and documentation images. The returned state is still mutable; this factory does not lock selection or disable interaction or animation.

toChartData

fun List<Pair<String, List<Double>>>.toChartData(categories: List<String> = emptyList()): ChartData

Builds multi-series ChartData from a list of named series.

fun List<Double>.toChartData(categories: List<String> = emptyList(), seriesName: String? = null): ChartData

Converts a list of values into single-series ChartData.