react-highcharts
Highcharts component for react.
Demo
You can find the full code for the examples here
To run the demo:
- Clone the repo
- run:
npm install
npm run demo
- Point your browser at http://localhost:8080
Installation
If you are using React@0.14
just do this:
npm install react-highcharts --save
For React@0.13
use:
npm install react-highcharts@^3.0.0 --save
Usage
Basic Usage
Check out this recipe
to see how to install Highcharts
with npm
.
var React = require('react');
var ReactHighcharts = require('react-highcharts');
var config = {
};
React.render(<ReactHighcharts config = {config}></ReactHighcharts>, document.body);
Bundled Usage (includes Highcharts)
var React = require('react');
var ReactHighcharts = require('react-highcharts/bundle/highcharts');
var config = {
};
React.render(<ReactHighcharts config = {config}></ReactHighcharts>, document.body);
Accessing Highcharts API After Render
For access to methods & properties from the Highcharts library you can use ReactHighcharts.Highcharts
. For example, the Highcharts options are available via ReactHighcharts.Highcharts.getOptions()
.
Highcharts provides an API for manipulating a chart after the initial render. See the Methods and Properties in the documentation. Here's how you access it:
class MyComponent extends React.Component {
componentDidMount() {
let chart = this.refs.chart.getChart();
chart.series[0].addPoint({x: 10, y: 12});
}
render() {
return <ReactHighcharts config={config} ref="chart"></ReactHighcharts>;
}
}
Limiting Highchart Rerenders
Rerendering a highcharts graph is expensive. You can pass in a isPureConfig
option to the ReactHighcharts
component, which will keep the highcharts graph from being updated so long as the provided config
is referentially equal to its previous value.
Rendering on the server with node
See this recipe
Using highmaps
Require Highmaps first, and then require('react-highcharts/highmaps');
Or use bundled version: require('react-highcharts/bundle/highmaps');
Using highstock
Require Highstock first, and then require('react-highcharts/highstock');
Or use bundled version: require('react-highcharts/bundle/highstock');
Using highcharts modules/add-ons like exporting, data, etc.
Everything related to modules was moved out of react-highcharts
.
Now every highcharts module is published as a separate npm package.
You can find the full list list here
For Contributors
Update Highcharts Version
-
Install new highcharts version.
npm unistall highcharts --save-dev
npm install highcharts --save-dev
-
Increment the react-highcharts
version such that a patch, minor release, or major release of
Higcharts is reflected in a corresponding version increase for react-highcharts
.
Running tests
Run npm tests