IChartGaugeProps

interface
Chart

Props for <OrigamChartGauge> — solid gauge (radial progress indicator). Renders a 270-degree track with a filled arc indicating the current value, an optional centre label, and optional min / max endpoint labels. Only the first datum of the first series is consumed.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

gaugeMin
number
0
Lower bound of the gauge range. Default 0.
gaugeMax
number
100
Upper bound of the gauge range. Default 100.
gaugeUnit
string
''
Optional unit appended to the centre label (e.g. '%', ' km/h'). Default ''.
gaugeThickness
number
18
Arc thickness in SVG pixels. Default 18.
gaugeStartAngle
number
Arc start angle in radians. Defaults to -3pi/4 (bottom-left of a 270deg arc).
gaugeEndAngle
number
Arc end angle in radians. Defaults to +3pi/4 (bottom-right).
gaugeShowEndpoints
boolean
true
Whether to render gaugeMin / gaugeMax labels at the arc endpoints. Default true.
gaugeShowValue
boolean
true
Whether to render the centre value label. Default true.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Solid gauge showing a percentage KPI

vue