Documentation / @ripl/charts / ChartLineAnnotation
Interface: ChartLineAnnotation ​
Defined in: charts/src/components/annotation.ts:32
A reference line drawn across the plot at a fixed value on one axis.
Properties ​
| Property | Type | Description | Defined in |
|---|---|---|---|
axis | AnnotationAxis | The axis the ChartLineAnnotation.value is measured on. | charts/src/components/annotation.ts:36 |
color? | string | Line color. Defaults to a neutral annotation color. | charts/src/components/annotation.ts:42 |
label? | string | Optional label rendered beside the line. | charts/src/components/annotation.ts:40 |
lineDash? | number[] | Canvas dash pattern. Defaults to a dashed line. | charts/src/components/annotation.ts:46 |
lineWidth? | number | Line width in pixels. Defaults to 1. | charts/src/components/annotation.ts:44 |
type? | "line" | Discriminator. Optional; a line is the default annotation kind. | charts/src/components/annotation.ts:34 |
value | number | The axis value at which the line is drawn. | charts/src/components/annotation.ts:38 |