IChartAnnotationGeo
interface
Chart
Resolved SVG geometry for one chart annotation. Produced by computeAnnotationGeometry in chart.composable.ts and consumed directly by OrigamChartCartesian for rendering. Fields are gated per kind.
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.
- kindrequiredIChartAnnotation['kind']
- Annotation kind — mirrors the kind declared on IChartAnnotation.
- strokerequiredstring
- Resolved CSS colour string for the annotation stroke and fill.
- strokeWidthrequirednumber
- Resolved stroke width in SVG units.
- axrequirednumber
- Anchor pixel X coordinate (tail of arrow / anchor of label / centre of circle / left edge of bracket).
- ayrequirednumber
- Anchor pixel Y coordinate.
- bxrequirednumber
- End pixel X coordinate (head of arrow / right edge of bracket). Equals ax when unused.
- byrequirednumber
- End pixel Y coordinate. Equals ay when unused.
- arrowPointsstring
- Arrowhead polygon points attribute — populated for kind === arrow.
- textstring
- Text content to display alongside the annotation.
- dxrequirednumber
- Resolved horizontal text offset in SVG units.
- dyrequirednumber
- Resolved vertical text offset in SVG units.
- radiusrequirednumber
- Circle radius in SVG units — populated for kind === circle.
- callout{ x: number, y: number, width: number, height: number }
- Callout rounded-rect geometry — populated for kind === label.
- leaderEnd{ x: number, y: number }
- Bottom-centre of the callout box where the leader line terminates — populated for kind === label.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
IChartAnnotationGeo is an internal type — consumed by the chart renderer