IChartGaugeGeometry

interface
Chart

Output of useChartGauge — geometry descriptors for the arc track, the indicator arc, and the label anchor points. All fields are pre-formatted so the SFC renders without computing anything itself.

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.

trackPath
required
string
SVG d attribute for the full empty track arc.
valuePath
required
string
SVG d attribute for the filled value arc (empty when value === min).
valueAngle
required
number
Radian angle where the value arc ends. Useful for needles.
startAngle
required
number
Radian angle where the gauge arc starts.
endAngle
required
number
Radian angle where the gauge arc ends.
outerRadius
required
number
Outer arc radius in SVG pixels.
innerRadius
required
number
Inner arc radius in SVG pixels (outerRadius - thickness).
centerX
required
number
SVG pixel coordinate of the arc centre (X).
centerY
required
number
SVG pixel coordinate of the arc centre (Y).
ratio
required
number
Normalised value in [0..1].
clampedValue
required
number
Clamped value in [min..max].

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Consuming geometry in a custom gauge slot

vue