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

Gauges are circular plots displaying one or more values with a dial pointing to values along the perimeter.

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

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

Copyright © 2024, Highsoft AS. All rights reserved.

Highcharts v11.4.8 - Generated from branch master (commit 5468b76e66), on Thu Aug 29 2024 13:57:11 GMT+0200 (Central European Summer Time)