JS API Reference

Welcome to the Highcharts Stock JS (highstock) 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.

plotOptions.hlc

An HLC chart is a style of financial chart used to describe price movements over time. It displays high, low and close values per data point.

Configuration options for the series are given in three levels:

  1. Options for all series in a chart are defined in the plotOptions.series object.
  2. Options for all hlc series are defined in plotOptions.hlc.
  3. Options for one single series are given in the series instance array.
Highcharts.chart('container', {
    plotOptions: {
        series: {
            // general options for all series
        },
        hlc: {
            // shared options for all hlc series
        }
    },
    series: [{
        // specific options for this series instance
        type: 'hlc'
    }]
});

TypeScript:

  • the type option must always be set.
  • when accessing an array of series, the combined set of all series types is represented by Highcharts.SeriesOptionsType . Narrowing down to the specific type can be done by checking the type property.
if (chart.options.series?.[0]?.type === hlc) {
    // code specific to the hlc series
}

Copyright © 2024, Highsoft AS. All rights reserved.

Highcharts Stock v11.4.8 - Generated from branch master (commit 5468b76e66), on Thu Aug 29 2024 13:56:46 GMT+0200 (Central European Summer Time)