mblakele / react-highcharts

react-highcharts

react-highcharts

Highcharts component for react.

Demo

• see example of using react-highcharts
• see example of using react-highcharts/more
• see example of using react-highcharts/highstock
• see example of using react-highcharts/highmaps

You can find the full code for the examples here

To run the demo:

1. Clone the repo
2. run:

   npm install
   npm run demo
   

3. 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

var React = require('react');
var Highcharts = require('react-highcharts'); // Expects that Highcharts was loaded in the code. 

var config = {
  /* HighchartsConfig */
};
React.render(<Highcharts config = {config}></Highcharts>, document.body);

Bundled Usage (includes Highcharts)

var React = require('react');
var Highcharts = require('react-highcharts/bundle/highcharts'); // Highcharts is bundled 

var config = {
  /* HighchartsConfig */
};
React.render(<Highcharts config = {config}></Highcharts>, document.body);

Accessing Highcharts API After Render

For access to methods & properties from the Highcharts library you can use Highcharts.Highcharts. For example, the Highcharts options are available via Highcharts.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 <Highcharts config={config} ref="chart"></Highcharts>;
  }
}

Limiting Highchart Rerenders

Rerendering a highcharts graph is expensive. You can pass in a isPureConfig option to the Highcharts component, which will keep the highcharts graph from being updated so long as the provided config is referentially equal to its previous value.

Using highmaps

Require Highmaps first, and then require('react-highcharts/highmaps'); Or use bundled version: require('react-highcharts/bundle/highmaps');

• see the demo

Using highstock

Require Highstock first, and then require('react-highcharts/highstock'); Or use bundled version: require('react-highcharts/bundle/highstock');

• see the demo

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

• see the demo

For Contributors

Update Highcharts Version

1. Install new highcharts version.

   npm unistall highcharts-release --save-dev
   npm install highcharts-release --save-dev
   

2. 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