Documentation / @ripl/charts / GaugeChartOptions
Interface: GaugeChartOptions
Defined in: charts/src/charts/gauge.ts:52
Options for configuring a GaugeChart.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
color? | string | Colour of the value arc. | - | charts/src/charts/gauge.ts:62 |
formatTickLabel? | (value) => string | Format function for tick labels | - | charts/src/charts/gauge.ts:72 |
formatValue? | (value) => string | Format function for the central value display. | - | charts/src/charts/gauge.ts:66 |
label? | string | Optional descriptive text shown below the value. | - | charts/src/charts/gauge.ts:60 |
max? | number | Upper bound of the gauge scale. Defaults to 100. | - | charts/src/charts/gauge.ts:58 |
min? | number | Lower bound of the gauge scale. Defaults to 0. | - | charts/src/charts/gauge.ts:56 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
showTickLabels? | boolean | Whether to show value labels at each tick. Defaults to true. | - | charts/src/charts/gauge.ts:70 |
tickCount? | number | Number of tick marks along the gauge arc. Defaults to 5. Set to 0 to hide. | - | charts/src/charts/gauge.ts:68 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
trackColor? | string | Colour of the background track arc. | - | charts/src/charts/gauge.ts:64 |
value | number | The value displayed by the gauge (clamped to min–max). | - | charts/src/charts/gauge.ts:54 |