# 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.geoheatmap

A `geoheatmap` series is a variety of heatmap series, composed into the map projection, where the units are expressed in the latitude and longitude, and 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 `geoheatmap` series are defined in plotOptions.geoheatmap.
3. Options for one single series are given in the series instance array.

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

TypeScript:

- type option should always be set, otherwise a broad set of unsupported options is allowed.
- 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 === geoheatmap) {
        // code specific to the geoheatmap series
    }