IUseChartGaugeOptions

interface
Composable Options

Strict options consumed by useChartGauge. All getters are thunks so the composable can be reactively driven by props, a store, or computed sources without re-instantiation.

TypeScript

Definition

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

typescript

API

Properties

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

value
required
() => number
Getter returning the current gauge value (un-clamped). The composable clamps to [min..max] internally.
min
required
() => number
Getter returning the lower bound of the gauge range.
max
required
() => number
Getter returning the upper bound of the gauge range.
width
required
() => number
Getter returning the SVG viewBox width in pixels.
height
required
() => number
Getter returning the SVG viewBox height in pixels.
padding
required
() => { top: number, right: number, bottom: number, left: number }
Getter returning the SVG inner padding that frees room for endpoint labels.
thickness
() => number
Optional getter overriding the arc stroke thickness in SVG pixels.
startAngle
() => number
Optional getter overriding the arc start angle in radians. Default is -3pi/4.
endAngle
() => number
Optional getter overriding the arc end angle in radians. Default is +3pi/4.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Driving useChartGauge from component props

typescript