JS API Reference

Welcome to the Highstock JS Options Reference

These pages outline the chart configuration options, and the methods and properties of Highcharts objects.

Feel free to search this API through the search bar or the navigation tree in the sidebar.

series.candlestick.data

An array of data points for the series. For the candlestick series type, points can be given in the following ways:

  1. An array of arrays with 5 or 4 values. In this case, the values correspond to x,open,high,low,close. If the first value is a string, it is applied as the name of the point, and the x value is inferred. The x value can also be omitted, in which case the inner arrays should be of length 4. Then the x value is automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given in the series options.

    data: [
        [0, 7, 2, 0, 4],
        [1, 1, 4, 2, 8],
        [2, 3, 3, 9, 3]
    ]
  2. An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.

    data: [{
        x: 1,
        open: 9,
        high: 2,
        low: 4,
        close: 6,
        name: "Point2",
        color: "#00FF00"
    }, {
        x: 1,
        open: 1,
        high: 4,
        low: 7,
        close: 7,
        name: "Point1",
        color: "#FF00FF"
    }]