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

navigator.yAxis.plotBands

An array of colored bands stretching across the plot area marking an interval on the axis.

In styled mode, the plot bands are styled by the .highcharts-plot-band class in addition to the className option.

When doing Chart.update() or Axis.update(), the plot bands are updated by index or id. The following merging rules apply:

  • If plotBands are not defined in the new options, all existing plot bands are kept.
  • If plotBands are defined without ids, the existing plot bands are updated by index. If the new array has fewer plot bands, the remaining existing plot bands are removed. If the new array has more plot bands, the extra ones are added. An empty array removes all existing plot bands.
  • If plotBands are defined with ids, the existing plot bands are matched by id, and remaining unmatched existing plot bands are removed.