IChartMapProps
interface
Chart
Props for <OrigamChartMap>. Supports two modes: choropleth (country shapes coloured by interpolated value) and flight-routes (curved arcs between pairs of country centroids). Extends IChartBaseProps.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- modeTChartMapMode
- Rendering mode. Default 'choropleth'.
- colorRange[TIntent | string, TIntent | string]
- Colour gradient endpoints for choropleth mode. First colour = min value; second colour = max value. Default ['info', 'danger'].
- defaultCountryFillTIntent | string
- Fill colour for countries that have no value in the dataset. Default 'rgba(0,0,0,0.08)'.
- borderColorTIntent | string
- Stroke colour applied to all country path outlines. Default 'rgba(0,0,0,0.2)'.
- lineColorTIntent | string
- Default stroke colour for flight-route arcs. Overridden per route via IChartMapRouteDatum.color. Default 'primary'.
- nodeRadiusnumber
- Radius in SVG pixels of the endpoint circles on each route. Default 4.
- routeCurvaturenumber
- Bezier control-point offset as a fraction of the chord length [0..1]. 0 = straight line; 0.3 = gentle arc (default).
- yAxisFormat(value: number) => string
- Y-axis value formatter used in tooltips and the choropleth legend.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
World choropleth by population density