IChartPlotLine
interface
Chart
A single threshold line drawn at a fixed axis value, either horizontally (Y-axis) or vertically (X-axis). Applicable to cartesian-family charts only — not for polar, radar or gauge.
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.
- axis'x' | 'y'
- Axis the line is perpendicular to. "y" draws a horizontal line at a Y value; "x" draws a vertical line at an X value. Default "y".
- valuerequirednumber | string
- Position on the axis in axis units. String when axis="x" and categories are strings.
- colorTIntent | string
- Stroke colour. Accepts a TIntent token name or any CSS colour string. Default resolves to the danger intent bg token.
- widthnumber
- Stroke width in SVG user units. Default 1.5.
- dash'solid' | 'dashed' | 'dotted'
- Dash pattern of the line. Default "dashed".
- labelstring
- Optional label placed at the end of the line.
- labelAlign'left' | 'right'
- Horizontal alignment of the label for Y-axis lines. "right" (default) places the label at the right edge; "left" at the left edge.
- layer'below' | 'above'
- Z-order relative to chart data. "below" — drawn behind series; "above" (default) — drawn on top of data so the line remains visible.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Drawing a danger threshold line