This library is deprecated. Please see
DEPRECATED.md.
Radar charts provide a cute method for displaying many variables simultaneously. It allows for rapid at-a-glance comparisons across a bunch of dimensions. These graphics can effectively be used either with several data rows on a single chart (as below) or as a small multiple. For more information, check out the Wiki, it's got some really neat examples.
Imagine you have a trio of models of cars that you are trying to compare. You're being data driven so you've collected a number of measurements based on a variety of values. You know basic facts about your variables, eg the interior rating a car can have is 7 and the minimum 1. You can use all this information to produce the above chart! Viola! Informed consumer.
Just like every other chart and series RadarChart expects an array of data, each row or object corresponds to a line or polygon (depending on how you have your chart styled). A key caveat for this chart type is that react-vis can not simply infer the variables from each data object that you wish to plot, so we need you to tell us! So enters the domains prop, an array of object specifying the order and behavior of each of the variables. So you have to tell react-vis a little more to get started, but you get a lot more expressiveness. Let's consider some code. You might provide the following object as props to the radar chart:
const RADAR_PROPS = {
data: [{
neatExplosions: 7,
wow: 10,
dog: 8,
sickMoves: 9,
nice: 7
}],
domains: [
{name: 'nice', domain: [0, 100]},
{name: 'explosions', domain: [6.9, 7.1], getValue: d => d.neatExplosions},
{name: 'wow', domain: [0, 11]},
{name: 'sickMoves', domain: [0, 20]}
],
height: 300,
width: 400
};In such a case, there would be ONE polygon rendered for four variables (nice/explosions/wow/sickMoves), because those values are listed in the domains prop. The radar chart accepts children if you wish to provide additional components, such as CircularGridLines.
Type: arrayOf(Objects)
Type: arrayOf(Objects)
The domains allow the user to specify the nature of the variables being plotted. This information is captured in an object formatted like:
PropTypes.shape({
name: PropTypes.string.isRequired,
getValue: PropTypes.func,
domain: PropTypes.arrayOf([PropTypes.number]).isRequired,
tickFormat: PropTypes.func
})Let's looks at each member of the object
- name: generates a member of a labelSeries that shows at the end of the corresponding axis
- getValue: an accessor function that grabs a value from the row being accessed, if this is not provided a default one that uses the name property is used.
- domain: a pair of numbers that are interpolated between. Setting these values correctly is essential for making your graphic legible! Because it is often the case that there will only be one or two data rows in a radar chart, react-vis requires the user to specify the exact domain for each variable. Without which we would be unable to plot the variables well.
- tickFormat: allows the user to provide a formatting function for prettifying the way that axis interpolates between the domain values.
Type: number
Width of the component.
Type: number
Height of the component.
Type: Object
Default: {left: 40, right: 10, top: 10, bottom: 40}
Margin around the chart.
Type: object
An object that contains CSS properties with which the axis component can be entirely re-styled.
As the RadarChart is composite of several composite elements, it is possible to provide style objects for any and all parts of the tree. See style
Most generally, there are three top level components axes, labels, and polygons. These in turn lead to their corresponding to style objects. As an example, here is the default style object for the RadarChart:
<RadarChart data={mydata} style={{
axes: {
line: {},
ticks: {},
text: {}
},
labels: {
fontSize: 10
},
polygons: {
strokeWidth: 0.5,
strokeOpacity: 1,
fillOpacity: 0.1
}
}}/>Type: boolean|Object
Please refer to Animation doc for more information.
Type: boolean
defaults to true Whether or not to hide the inner most tick values of the radar chart. This attempts to ensure that the ticks do not run over each other.
Type: string
Provide an additional class name for the series.
Type: string
Specify the type of color scale to be used on the radar chart, please refer to Scales and data for more information.
Type: 'function'
Specify the tick format for all axes. Will be over-ridden by tickFormats specified on single domains.
Type: number
The angle of the first axis in radians. Defaults to PI / 2.
Type: boolean
By default, the axes are rendered beneath the data (polygons) on the radar chart. Setting this to true will reverse the rendering, drawing the axes on top. This can be useful if you have a lot of data or your polygons have high opacity.
Type: function(d, {event})
mouseover event handler for the elements corresponding separate data points, where each data point is a point on the radar chart. First argument received, d, is the relevant data point, including the domain, name, and value of the data point. The second argument is the event property.
Type: function(d, {event})
mouseout event handler for the elements corresponding separate data points. First argument received is, d, the relevant data point, and second an object with the only event property.
Type: function(d, {event})
mouseover event handler for the elements corresponding separate data points. First argument received is, d, the relevant data point, and second an object with the only event property.
Type: function(d, {event})
mouseout event handler for the elements corresponding separate data points. First argument received is, d, the relevant data point, and second an object with the only event property.