Radar HTTP API

POST /charts/radar

The Radarcomponent is available in the nivo HTTP rendering API. The API generates a SVG and return a path to this SVG which can then be easily embedded.

The api accepts almost the same properties as the regular component, in json, however it's not interactive and you cannot use code in properties (functions).

Please note that the demo API server is installed on heroku using a free plan, so it might be unavailable from times to times.

Click the generate button in order to generate the chart.
You can customize settings by using dedicated controls.
generate
Response n/a
no response available
Base
Datum[]required

Chart data.

stringrequired

Key to use to index the data.

string[]required

Keys to use to determine each serie.

number | 'auto'optionaldefault:'auto'
auto

Maximum value.

string | (value: number) => stringoptional
open editor

Optional formatter for values.

stringoptionaldefault:'linearClosed'
catmullRomClosed

Curve interpolation.

numberrequired
px

Chart width.

numberrequired
px

Chart height.

objectoptional
px
px
px
px

Chart margin.

Style
Themeoptional

Define style for common elements such as labels, axes…

OrdinalColorScaleConfigoptionaldefault:{"scheme":"nivo"}
Categorical: Nivo

Define chart's colors.

numberoptionaldefault:0.25

Shape fill opacity.

CssMixBlendModeoptionaldefault:'normal'

Define CSS mix-blend-mode for layers.

supportsvgapi
numberoptionaldefault:2
px

Shape border width.

string | object | Functionoptionaldefault:{"from":"color"}
inheritthemecustom
inherited property
color
modifiers
No modifier.

Method to compute border color.

object[]optional

Define patterns and gradients.

supportsvgapi
object[]optional

Define rules to apply patterns and gradients

supportsvgapi
Grid
numberoptionaldefault:5

Number of levels to display for grid

stringoptionaldefault:'circular'
circular

Determine shape of the grid.

Functionoptional

Grid label.

supportsvgapi
numberoptionaldefault:16
px

Label offset from outer radius.

Dots
booleanoptionaldefault:true
   

Enable/disable dots.

Functionoptional

Overrides default dot circle.

supportsvgapi
numberoptionaldefault:6
px

Size of the dots.

string | object | Functionoptionaldefault:{"from":"color"}
inheritthemecustom
inherited property
color
modifiers
No modifier.

Method to compute dots color.

numberoptionaldefault:0
px

Width of the dots border.

string | object | Functionoptionaldefault:{"from":"color"}
inheritthemecustom
theme property
background

Method to compute dots border color.

booleanoptionaldefault:false
   

Enable/disable dots label.

string | ((point: PointData) => string | number)optionaldefault:'formattedValue'

Dot label.

supportsvgapi
numberoptionaldefault:-12
px

Label Y offset from dot shape.

Customization
(RadarLayerId | FunctionComponent<RadarCustomLayerProps>)[]optionaldefault:['grid', 'layers', 'slices', 'dots', 'legends']

Defines the order of layers and add custom layers.

supportsvgapi
Interactivity
booleanoptionaldefault:true

Enable/disable interactivity.

supportsvgapi
FunctionComponent<RadarSliceTooltipProps>optional

Override default slice tooltip.

supportsvgapi
(node, event) => voidoptional

onClick handler, it receives target node data and mouse event.

supportsvgapi
Motion
booleanoptionaldefault:true

Enable/disable transitions.

supportsvgapi
string | objectoptionaldefault:'gentle'

Motion config for react-spring, either a preset or a custom configuration.

supportsvgapi