Configuration options

For initial declarative chart setup. Download as ZIP or JSON.

Highcharts.setOptions({

});

Highcharts.chart({

sunburst: {

accessibility: { ... }

allowDrillToNode: false

allowPointSelect: null

allowTraversingTree: false

animation: null

animationLimit: null

borderColor: #ffffff

borderWidth: 1

breadcrumbs: { ... }

center: ["50%", "50%"]

className: null

clip: true

color: #cccccc

colorAxis: 0

colorByPoint: null

colorIndex: null

colorKey: y

colors: null

connectEnds: null

connectNulls: false

crisp: true

cropThreshold: 300

cursor: null

custom: null

dashStyle: Solid

data: { ... }

dataLabels: { ... }

description: null

dragDrop: { ... }

enableMouseTracking: true

events: { ... }

fillColor: undefined

findNearestPointBy: x

getExtremesFromAll: false

id: null

includeInDataExport: null

index: null

keys: null

label: { ... }

legendIndex: null

levelIsConstant: true

levels: { ... }

levelSize: { ... }

linecap: round

lineWidth: 2

linkedTo: null

marker: { ... }

name: null

negativeColor: null

onPoint: { ... }

opacity: 1

point: { ... }

pointDescriptionFormatter: null

pointInterval: 1

pointIntervalUnit: null

pointPlacement: null

pointStart: 0

relativeXValue: false

rootId: undefined

selected: false

shadow: false

showCheckbox: null

showInLegend: null

size: null

skipKeyboardNavigation: null

slicedOffset: 10

softThreshold: true

stacking: null

startAngle: 0

states: { ... }

step: null

stickyTracking: null

thickness: undefined

threshold: 0

traverseUpButton: { ... }

turboThreshold: 1000

type: null

visible: true

xAxis: 0

yAxis: 0

zIndex: null

zoneAxis: y

zones: { ... }

}

});

Members and properties

For modifying the chart at runtime. See the class 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.

series.sunburst

A sunburst series. If the type option is not specified, it is inherited from chart.type.

In TypeScript the type option must always be set.

Configuration options for the series are given in three levels:

Options for all series in a chart are defined in the plotOptions.series object.
Options for all sunburst series are defined in plotOptions.sunburst.
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'
    }]
});