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.item

An item chart is an infographic chart where a number of items are laid out in either a rectangular or circular pattern. It can be used to visualize counts within a group, or for the circular pattern, typically a parliament.

The circular layout has much in common with a pie chart. Many of the item series options, like center, size and data label positioning, are inherited from the pie series and don't apply for rectangular layouts.

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 item series are defined in plotOptions.item.
Options for one single series are given in the series instance array.

Highcharts.chart('container', {
    plotOptions: {
        series: {
            // general options for all series
        },
        item: {
            // shared options for all item series
        }
    },
    series: [{
        // specific options for this series instance
        type: 'item'
    }]
});

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 === item) {
    // code specific to the item series
}

JS API Reference

Configuration options

Members and properties

Welcome to the Highcharts JS (highcharts) Options Reference

plotOptions.item