JS API Reference

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

A Sunburst displays hierarchical data, where a level in the hierarchy is represented by a circle. The center represents the root node of the tree. The visualization bears a resemblance to both treemap and pie charts.

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

Copyright © 2023, Highsoft AS. All rights reserved.

Highcharts v10.3.3 - Generated from branch master (commit 2bc6062f48), on Fri Jan 20 2023 09:23:00 GMT+0100 (Central European Standard Time)