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.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

kind
required
IChartAnnotation['kind']
Annotation kind — mirrors the kind declared on IChartAnnotation.
stroke
required
string
Resolved CSS colour string for the annotation stroke and fill.
strokeWidth
required
number
Resolved stroke width in SVG units.
ax
required
number
Anchor pixel X coordinate (tail of arrow / anchor of label / centre of circle / left edge of bracket).
ay
required
number
Anchor pixel Y coordinate.
bx
required
number
End pixel X coordinate (head of arrow / right edge of bracket). Equals ax when unused.
by
required
number
End pixel Y coordinate. Equals ay when unused.
arrowPoints
string
Arrowhead polygon points attribute — populated for kind === arrow.
text
string
Text content to display alongside the annotation.
dx
required
number
Resolved horizontal text offset in SVG units.
dy
required
number
Resolved vertical text offset in SVG units.
radius
required
number
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

typescript