charts/io.github.hdcharts.gauge

Package-level declarations

Types

GaugeLabelsStyle

@Immutable

data class GaugeLabelsStyle(val visible: Boolean, val color: Color, val size: TextUnit)

Configuration for the range labels under the start and the end of the arc.

GaugeRangeStyle

@Immutable

data class GaugeRangeStyle(val min: Double, val max: Double)

The values a gauge maps onto its arc: min at the start and max at the end. Values outside the range stop at the nearest end.

GaugeTrackStyle

@Immutable

data class GaugeTrackStyle(val visible: Boolean, val color: Color)

Track configuration for a gauge: the full arc drawn behind each value.

RingGaugeChartDefaults

object RingGaugeChartDefaults

An object that provides default styles for a Ring Gauge Chart.

RingGaugeChartStyle

@Stable

class RingGaugeChartStyle(modifier: Modifier, val chartContainerStyle: ChartContainerStyle, val range: GaugeRangeStyle, val rings: RingGaugeRingsStyle, val track: GaugeTrackStyle, val labels: GaugeLabelsStyle, val legend: LegendStyle)

The style for a Ring Gauge Chart, grouped into cohesive sub-styles.

RingGaugeRingsStyle

@Immutable

data class RingGaugeRingsStyle(val alpha: Float, val baseColor: Color, val colors: ImmutableList<Color>, val width: Dp, val spacing: Dp)

Ring configuration for a RingGaugeChartStyle.

SegmentedRingGaugeCenterLabelsStyle

@Immutable

data class SegmentedRingGaugeCenterLabelsStyle(val value: TextStyle, val supporting: TextStyle, val spacing: Dp)

Text styles for the value and optional supporting text inside the ring.

SegmentedRingGaugeChartDefaults

object SegmentedRingGaugeChartDefaults

Factories for SegmentedRingGaugeChartStyle and its grouped style blocks.

SegmentedRingGaugeChartStyle

@Stable

class SegmentedRingGaugeChartStyle(modifier: Modifier, val chartContainerStyle: ChartContainerStyle, val segments: SegmentedRingGaugeSegmentsStyle, val track: SegmentedRingGaugeTrackStyle, val centerLabels: SegmentedRingGaugeCenterLabelsStyle, val legend: LegendStyle)

The presentation of a SegmentedRingGaugeChart, grouped into cohesive sub-styles.

SegmentedRingGaugeDirection

enum SegmentedRingGaugeDirection : Enum<SegmentedRingGaugeDirection>

The direction in which segments expand from SegmentedRingGaugeSegmentsStyle.startPosition.

SegmentedRingGaugeSegmentsStyle

@Immutable

data class SegmentedRingGaugeSegmentsStyle(val alpha: Float, val baseColor: Color, val colors: ImmutableList<Color>, val width: Dp, val spacing: Dp, val cornerRadius: Dp, val startPosition: SegmentedRingGaugeStartPosition, val direction: SegmentedRingGaugeDirection)

The colored portions of a segmented ring gauge.

SegmentedRingGaugeStartPosition

enum SegmentedRingGaugeStartPosition : Enum<SegmentedRingGaugeStartPosition>

A named boundary before the first segment of a segmented ring gauge.

SegmentedRingGaugeTrackStyle

@Immutable

data class SegmentedRingGaugeTrackStyle(val color: Color)

The unfilled capacity behind the colored segments.

Functions

RingGaugeChart

@Composable

fun RingGaugeChart(data: ChartData, modifier: Modifier = Modifier, style: RingGaugeChartStyle = RingGaugeChartDefaults.style(), title: String? = null, selectedValueFormatter: ChartValueFormatter = RingGaugeChartDefaults.selectedValueFormatter, axisValueFormatter: ChartValueFormatter = RingGaugeChartDefaults.axisValueFormatter, selection: ChartSelection = rememberChartSelection(), interactionEnabled: Boolean = true, animateOnStart: Boolean = true, subtitle: String? = null)

A composable function that displays a Ring Gauge Chart.

SegmentedRingGaugeChart

@Composable

fun SegmentedRingGaugeChart(data: ChartData, capacity: Double, modifier: Modifier = Modifier, style: SegmentedRingGaugeChartStyle = SegmentedRingGaugeChartDefaults.style(), title: String? = null, centerLabel: String? = null, centerSupportingLabel: String? = null, centerValueFormatter: ChartValueFormatter = SegmentedRingGaugeChartDefaults.centerValueFormatter, selectedValueFormatter: ChartValueFormatter = SegmentedRingGaugeChartDefaults.selectedValueFormatter, selection: ChartSelection = rememberChartSelection(), interactionEnabled: Boolean = true, animateOnStart: Boolean = true, subtitle: String? = null)

Draws one circular capacity ring whose filled amount is divided into colored segments.