JS API Reference

Welcome to the Highmaps JS 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.


The map series is used for basic choropleth maps, where each map area has a color based on its value.

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