JS API Reference

Welcome to the Gantt 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.gantt

A gantt series.

In TypeScript the type option must always be set.

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 gantt series are defined in plotOptions.gantt.
  3. Options for one single series are given in the series instance array.
Highcharts.chart('container', {
    plotOptions: {
        series: {
            // general options for all series
        },
        gantt: {
            // shared options for all gantt series
        }
    },
    series: [{
        // specific options for this series instance
        type: 'gantt'
    }]
});