IChartMapRoute
interface
Chart
Internal route descriptor produced by the map geometry engine for flight-routes mode. Holds the pre-computed SVG Bezier path, stroke colour, endpoint circles, and country codes.
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.
- indexrequirednumber
- Zero-based index in the series data array.
- drequiredstring
- SVG quadratic Bezier path string: M x1,y1 Q cx,cy x2,y2.
- strokerequiredstring
- Resolved CSS stroke colour.
- strokeWidthrequirednumber
- Stroke width in SVG pixels.
- fromPointrequired[number, number]
- Centroid [x, y] of the origin country.
- toPointrequired[number, number]
- Centroid [x, y] of the destination country.
- fromrequiredstring
- Origin country ISO-3166-1 alpha-2 code.
- torequiredstring
- Destination country ISO-3166-1 alpha-2 code.
- valuerequirednumber | undefined
- Optional flow value driving stroke width.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Accessing pre-computed route descriptors