Skip to content

Higher Order Components provideAxis

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

provideAxis

Note A component wrapped with this HOC must be rendered with an axisId prop - referring to the id of the axis you wish to interact with.

This HOC injects a single prop

getAxis

This is a function, that returns an object

this.props.getAxis();
// Which returns an object with props
Object Property Description
object The Highcharts axis instance
id The axis ID string
type The axis type string (xAxis, yAxis, zAxis)
update The update function
remove The remove function
addPlotBand The addPlotBand function
removePlotBand The removePlotBand function
addPlotLine The addPlotLine function
removePlotLine The removePlotLine function
getExtremes The getExtremes function
setExtremes The setExtremes function
setTitle The setTitle function

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