JS API Reference

Welcome to the Highcharts Maps JS (highmaps) 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.heatmap

A heatmap is a graphical representation of data where the individual values contained in a matrix are represented as colors.

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

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

Copyright © 2025, Highsoft AS. All rights reserved.

Highcharts Maps v12.3.0 - Generated from branch master (commit ade4907f7b), on Sat Jun 21 2025 08:09:51 GMT+0200 (Central European Summer Time)