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

A polygon series can be used to draw any freeform shape in the cartesian coordinate system. A fill is applied with the color option, and stroke is applied through lineWidth and lineColor options.

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

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

Copyright © 2024, Highsoft AS. All rights reserved.

Highcharts v12.1.1 - Generated from branch master (commit 590c1a9a2d), on Fri Dec 20 2024 08:17:42 GMT+0100 (Central European Standard Time)