highcharts 11.4.6 → 11.4.7

package/options/tiledwebmap.d.ts

@@ -9,8 +9,6 @@ declare module "../highcharts" {
      * (Highmaps) A tiledwebmap series allows user to display dynamically joined
      * individual images (tiles) and join them together to create a map.
      *
-     * 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
@@ -21,6 +19,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTiledwebmapOptions {
         /**

package/options/tiledwebmap.src.d.ts

@@ -9,8 +9,6 @@ declare module "../highcharts.src" {
      * (Highmaps) A tiledwebmap series allows user to display dynamically joined
      * individual images (tiles) and join them together to create a map.
      *
-     * 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
@@ -21,6 +19,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTiledwebmapOptions {
         /**

package/options/tilemap.d.ts

@@ -368,8 +368,6 @@ declare module "../highcharts" {
      * (Highcharts, Highmaps) A tilemap series is a type of heatmap where the
      * tile shapes are configurable.
      *
-     * 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
@@ -379,6 +377,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTilemapOptions {
         /**

package/options/tilemap.src.d.ts

@@ -368,8 +368,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highmaps) A tilemap series is a type of heatmap where the
      * tile shapes are configurable.
      *
-     * 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
@@ -379,6 +377,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTilemapOptions {
         /**

package/options/treegraph.d.ts

@@ -411,8 +411,6 @@ declare module "../highcharts" {
      *
      * TODO change back the demo path
      *
-     * 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
@@ -423,6 +421,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTreegraphOptions {
         /**
@@ -942,8 +949,6 @@ declare module "../highcharts" {
      * (Highcharts) A `treegraph` series. If the type option is not specified,
      * it is inherited from chart.type.
      *
-     * 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
@@ -955,6 +960,15 @@ declare module "../highcharts" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesTreegraphOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesTreegraphOptions {
      * customProperty: string; }

package/options/treegraph.src.d.ts

@@ -411,8 +411,6 @@ declare module "../highcharts.src" {
      *
      * TODO change back the demo path
      *
-     * 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
@@ -423,6 +421,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTreegraphOptions {
         /**
@@ -942,8 +949,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `treegraph` series. If the type option is not specified,
      * it is inherited from chart.type.
      *
-     * 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
@@ -955,6 +960,15 @@ declare module "../highcharts.src" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesTreegraphOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesTreegraphOptions {
      * customProperty: string; }

package/options/treemap.d.ts

@@ -428,8 +428,6 @@ declare module "../highcharts" {
      * rectangles. The data can be laid out in varying ways depending on
      * options.
      *
-     * 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
@@ -439,6 +437,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTreemapOptions {
         /**
@@ -1008,8 +1015,6 @@ declare module "../highcharts" {
      * (Highcharts) A `treemap` series. If the type option is not specified, it
      * is inherited from chart.type.
      *
-     * 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
@@ -1020,6 +1025,15 @@ declare module "../highcharts" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesTreemapOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesTreemapOptions {
      * customProperty: string; }

package/options/treemap.src.d.ts

@@ -428,8 +428,6 @@ declare module "../highcharts.src" {
      * rectangles. The data can be laid out in varying ways depending on
      * options.
      *
-     * 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
@@ -439,6 +437,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTreemapOptions {
         /**
@@ -1008,8 +1015,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `treemap` series. If the type option is not specified, it
      * is inherited from chart.type.
      *
-     * 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
@@ -1020,6 +1025,15 @@ declare module "../highcharts.src" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesTreemapOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesTreemapOptions {
      * customProperty: string; }

package/options/trendline.d.ts

@@ -75,8 +75,6 @@ declare module "../highcharts" {
      * selected data using a method called the Sum Of Least Squares. This series
      * requires the `linkedTo` option to be set.
      *
-     * 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
@@ -87,6 +85,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTrendlineOptions {
         /**

package/options/trendline.src.d.ts

@@ -75,8 +75,6 @@ declare module "../highcharts.src" {
      * selected data using a method called the Sum Of Least Squares. This series
      * requires the `linkedTo` option to be set.
      *
-     * 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
@@ -87,6 +85,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotTrendlineOptions {
         /**

package/options/trix.d.ts

@@ -413,8 +413,6 @@ declare module "../highcharts" {
      * (Highstock) A `TRIX` series. If the type option is not specified, it is
      * inherited from chart.type.
      *
-     * 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
@@ -425,6 +423,15 @@ declare module "../highcharts" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesTrixOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesTrixOptions {
      * customProperty: string; }

package/options/trix.src.d.ts

@@ -413,8 +413,6 @@ declare module "../highcharts.src" {
      * (Highstock) A `TRIX` series. If the type option is not specified, it is
      * inherited from chart.type.
      *
-     * 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
@@ -425,6 +423,15 @@ declare module "../highcharts.src" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesTrixOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesTrixOptions {
      * customProperty: string; }

package/options/variablepie.d.ts

@@ -55,8 +55,6 @@ declare module "../highcharts" {
      * slice where the size (arc) of the slice relates to the Y value and the
      * radius of pie slice relates to the Z 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
@@ -67,6 +65,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotVariablepieOptions {
         /**
@@ -485,8 +492,6 @@ declare module "../highcharts" {
      * (Highcharts) A `variablepie` series. If the type option is not specified,
      * it is inherited from chart.type.
      *
-     * 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
@@ -498,6 +503,15 @@ declare module "../highcharts" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesVariablepieOptions` via an interface to
      * allow custom properties: ``` declare interface SeriesVariablepieOptions {
      * customProperty: string; }

package/options/variablepie.src.d.ts

@@ -55,8 +55,6 @@ declare module "../highcharts.src" {
      * slice where the size (arc) of the slice relates to the Y value and the
      * radius of pie slice relates to the Z 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
@@ -67,6 +65,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotVariablepieOptions {
         /**
@@ -485,8 +492,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `variablepie` series. If the type option is not specified,
      * it is inherited from chart.type.
      *
-     * 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
@@ -498,6 +503,15 @@ declare module "../highcharts.src" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesVariablepieOptions` via an interface to
      * allow custom properties: ``` declare interface SeriesVariablepieOptions {
      * customProperty: string; }

package/options/variwide.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts" {
      * (Highcharts) A variwide chart (related to marimekko chart) is a column
      * chart with a variable width expressing a third dimension.
      *
-     * 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
@@ -85,6 +83,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotVariwideOptions {
         /**
@@ -683,8 +690,6 @@ declare module "../highcharts" {
      * (Highcharts) A `variwide` series. If the type option is not specified, it
      * is inherited from chart.type.
      *
-     * 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
@@ -695,6 +700,15 @@ declare module "../highcharts" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesVariwideOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesVariwideOptions {
      * customProperty: string; }

package/options/variwide.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A variwide chart (related to marimekko chart) is a column
      * chart with a variable width expressing a third dimension.
      *
-     * 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
@@ -85,6 +83,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotVariwideOptions {
         /**
@@ -683,8 +690,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `variwide` series. If the type option is not specified, it
      * is inherited from chart.type.
      *
-     * 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
@@ -695,6 +700,15 @@ declare module "../highcharts.src" {
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
      *
+     * **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. (see online
+     * documentation for example)
+     *
      * You have to extend the `SeriesVariwideOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesVariwideOptions {
      * customProperty: string; }

package/options/vbp.d.ts

@@ -75,8 +75,6 @@ declare module "../highcharts" {
      *
      * This series requires `linkedTo` option to be set.
      *
-     * 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
@@ -86,6 +84,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotVbpOptions {
         /**

package/options/vbp.src.d.ts

@@ -75,8 +75,6 @@ declare module "../highcharts.src" {
      *
      * This series requires `linkedTo` option to be set.
      *
-     * 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
@@ -86,6 +84,15 @@ declare module "../highcharts.src" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotVbpOptions {
         /**

package/options/vector.d.ts

@@ -150,8 +150,6 @@ declare module "../highcharts" {
      * each point has an X and Y position, a length and a direction. Vectors are
      * drawn as arrows.
      *
-     * 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
@@ -161,6 +159,15 @@ declare module "../highcharts" {
      *
      * 3. Options for one single series are given in the series instance array.
      * (see online documentation for example)
+     *
+     * **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. (see online
+     * documentation for example)
      */
     interface PlotVectorOptions {
         /**