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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- trackPathrequiredstring
- SVG d attribute for the full empty track arc.
- valuePathrequiredstring
- SVG d attribute for the filled value arc (empty when value === min).
- valueAnglerequirednumber
- Radian angle where the value arc ends. Useful for needles.
- startAnglerequirednumber
- Radian angle where the gauge arc starts.
- endAnglerequirednumber
- Radian angle where the gauge arc ends.
- outerRadiusrequirednumber
- Outer arc radius in SVG pixels.
- innerRadiusrequirednumber
- Inner arc radius in SVG pixels (outerRadius - thickness).
- centerXrequirednumber
- SVG pixel coordinate of the arc centre (X).
- centerYrequirednumber
- SVG pixel coordinate of the arc centre (Y).
- ratiorequirednumber
- Normalised value in [0..1].
- clampedValuerequirednumber
- 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