Documentation / @ripl/charts / GaugeChartOptions
Interface: GaugeChartOptions ​
Defined in: charts/src/charts/gauge.ts:63
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:128 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:122 |
color? | string | Color of the value arc. | - | charts/src/charts/gauge.ts:73 |
description? | string | Accessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text. | BaseChartOptions.description | charts/src/core/chart.ts:132 |
format? | ValueFormatInput | How the central value display is formatted: a built-in format type, Intl number-format options, or a custom function. | - | charts/src/charts/gauge.ts:77 |
label? | string | Optional descriptive text shown below the value. | - | charts/src/charts/gauge.ts:71 |
max? | number | Upper bound of the gauge scale. Defaults to 100. | - | charts/src/charts/gauge.ts:69 |
min? | number | Lower bound of the gauge scale. Defaults to 0. | - | charts/src/charts/gauge.ts:67 |
padding? | PaddingInput | Space reserved around the chart, in pixels. A single number applies to all four edges; a [top, right, bottom, left] tuple or a partial { top, right, bottom, left } object sets individual edges, leaving unspecified edges at the default. Defaults to 16. | BaseChartOptions.padding | charts/src/core/chart.ts:124 |
theme? | string | Theme | Theme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme). | BaseChartOptions.theme | charts/src/core/chart.ts:130 |
tickFormat? | ValueFormatInput | How tick labels are formatted. Defaults to GaugeChartOptions.format. | - | charts/src/charts/gauge.ts:83 |
tickLabels? | boolean | Show a value label at each tick. Defaults to true. | - | charts/src/charts/gauge.ts:81 |
ticks? | number | Number of tick marks along the gauge arc. Defaults to 5. Set to 0 to hide the ticks. | - | charts/src/charts/gauge.ts:79 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:126 |
trackColor? | string | Color of the background track arc. | - | charts/src/charts/gauge.ts:75 |
value | number | The value displayed by the gauge (clamped to min–max). | - | charts/src/charts/gauge.ts:65 |