Skip to content

Higher Order Components provideSeries

Will Hawker edited this page May 30, 2018 · 2 revisions

provideSeries

Note A component wrapped with this HOC must be rendered with a seriesId prop - referring to the id of the series you wish to interact with.

This HOC injects a single prop

getSeries

This is a function, that returns an object

this.props.getSeries();
// Which returns an object with props
Object Property Description
object The Highcharts series instance
id The series ID string
type The series type string
update The update function
remove The remove function
setData The addPlotBand function
setVisible The removePlotBand function

The functions are bound to the series instance, to maintain default Highcharts behaviour