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

A treemap displays hierarchical data using nested rectangles. The data can be laid out in varying ways depending on options.

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

Copyright © 2022, Highsoft AS. All rights reserved.

Highcharts v10.3.2 - Generated from branch master (commit 8ebdfd9fd9), on Mon Nov 28 2022 13:09:02 GMT+0100 (Central European Standard Time)