highcharts 11.4.6 → 11.4.8

package/options/line.d.ts

@@ -413,8 +413,6 @@ declare module "../highcharts" {
      * (Highcharts, Highstock) A `line` 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 `SeriesLineOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesLineOptions {
      * customProperty: string; }

package/options/line.src.d.ts

@@ -413,8 +413,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) A `line` 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 `SeriesLineOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesLineOptions {
      * customProperty: string; }

package/options/linearregression.d.ts

@@ -291,8 +291,6 @@ declare module "../highcharts" {
      * (Highstock) Linear regression indicator. 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
@@ -303,6 +301,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 PlotLinearregressionOptions {
         /**
@@ -867,8 +874,6 @@ declare module "../highcharts" {
      * (Highstock) A linear regression 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
@@ -880,6 +885,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 `SeriesLinearregressionOptions` via an interface
      * to allow custom properties: ``` declare interface
      * SeriesLinearregressionOptions { customProperty: string; }

package/options/linearregression.src.d.ts

@@ -291,8 +291,6 @@ declare module "../highcharts.src" {
      * (Highstock) Linear regression indicator. 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
@@ -303,6 +301,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 PlotLinearregressionOptions {
         /**
@@ -867,8 +874,6 @@ declare module "../highcharts.src" {
      * (Highstock) A linear regression 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
@@ -880,6 +885,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 `SeriesLinearregressionOptions` via an interface
      * to allow custom properties: ``` declare interface
      * SeriesLinearregressionOptions { customProperty: string; }

package/options/linearregressionangle.d.ts

@@ -433,8 +433,6 @@ declare module "../highcharts" {
      * (Highstock) A linear regression intercept 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
@@ -446,6 +444,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 `SeriesLinearregressionangleOptions` via an
      * interface to allow custom properties: ``` declare interface
      * SeriesLinearregressionangleOptions { customProperty: string; }

package/options/linearregressionangle.src.d.ts

@@ -433,8 +433,6 @@ declare module "../highcharts.src" {
      * (Highstock) A linear regression intercept 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
@@ -446,6 +444,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 `SeriesLinearregressionangleOptions` via an
      * interface to allow custom properties: ``` declare interface
      * SeriesLinearregressionangleOptions { customProperty: string; }

package/options/lollipop.d.ts

@@ -134,8 +134,6 @@ declare module "../highcharts" {
      * Requires `highcharts-more.js`, `modules/dumbbell.js` and
      * `modules/lollipop.js`.
      *
-     * 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
@@ -145,6 +143,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 PlotLollipopOptions {
         /**
@@ -830,8 +837,6 @@ declare module "../highcharts" {
      * (Highcharts, Highstock) The `lollipop` 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
@@ -842,6 +847,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 `SeriesLollipopOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesLollipopOptions {
      * customProperty: string; }

package/options/lollipop.src.d.ts

@@ -134,8 +134,6 @@ declare module "../highcharts.src" {
      * Requires `highcharts-more.js`, `modules/dumbbell.js` and
      * `modules/lollipop.js`.
      *
-     * 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
@@ -145,6 +143,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 PlotLollipopOptions {
         /**
@@ -830,8 +837,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) The `lollipop` 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
@@ -842,6 +847,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 `SeriesLollipopOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesLollipopOptions {
      * customProperty: string; }

package/options/macd.d.ts

@@ -85,8 +85,6 @@ declare module "../highcharts" {
      * requires `linkedTo` option to be set and should be loaded after the
      * `stock/indicators/indicators.js`.
      *
-     * 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
@@ -96,6 +94,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 PlotMacdOptions {
         /**

package/options/macd.src.d.ts

@@ -85,8 +85,6 @@ declare module "../highcharts.src" {
      * requires `linkedTo` option to be set and should be loaded after the
      * `stock/indicators/indicators.js`.
      *
-     * 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
@@ -96,6 +94,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 PlotMacdOptions {
         /**

package/options/map.d.ts

@@ -129,8 +129,6 @@ declare module "../highcharts" {
      * (Highmaps) 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
@@ -140,6 +138,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 PlotMapOptions {
         /**
@@ -598,8 +605,6 @@ declare module "../highcharts" {
      * (Highmaps) A `map` 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
@@ -610,6 +615,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 `SeriesMapOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesMapOptions {
      * customProperty: string; }

package/options/map.src.d.ts

@@ -129,8 +129,6 @@ declare module "../highcharts.src" {
      * (Highmaps) 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
@@ -140,6 +138,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 PlotMapOptions {
         /**
@@ -598,8 +605,6 @@ declare module "../highcharts.src" {
      * (Highmaps) A `map` 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
@@ -610,6 +615,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 `SeriesMapOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesMapOptions {
      * customProperty: string; }

package/options/mapbubble.d.ts

@@ -100,8 +100,6 @@ declare module "../highcharts" {
      * (Highmaps) A `mapbubble` 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
@@ -113,6 +111,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 `SeriesMapbubbleOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesMapbubbleOptions {
      * customProperty: string; }

package/options/mapbubble.src.d.ts

@@ -100,8 +100,6 @@ declare module "../highcharts.src" {
      * (Highmaps) A `mapbubble` 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
@@ -113,6 +111,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 `SeriesMapbubbleOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesMapbubbleOptions {
      * customProperty: string; }

package/options/mapline.d.ts

@@ -368,8 +368,6 @@ declare module "../highcharts" {
      * value colors are applied to the strokes rather than the fills. It can
      * also be used for freeform drawing, like dividers, in the 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
@@ -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 PlotMaplineOptions {
         /**

package/options/mapline.src.d.ts

@@ -368,8 +368,6 @@ declare module "../highcharts.src" {
      * value colors are applied to the strokes rather than the fills. It can
      * also be used for freeform drawing, like dividers, in the 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
@@ -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 PlotMaplineOptions {
         /**

package/options/mfi.d.ts

@@ -415,8 +415,6 @@ declare module "../highcharts" {
      * (Highstock) A `MFI` 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
@@ -427,6 +425,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 `SeriesMfiOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesMfiOptions {
      * customProperty: string; }

package/options/mfi.src.d.ts

@@ -415,8 +415,6 @@ declare module "../highcharts.src" {
      * (Highstock) A `MFI` 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
@@ -427,6 +425,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 `SeriesMfiOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesMfiOptions {
      * customProperty: string; }

package/options/momentum.d.ts

@@ -73,8 +73,6 @@ declare module "../highcharts" {
     /**
      * (Highstock) Momentum. 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
@@ -84,6 +82,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 PlotMomentumOptions {
         /**

package/options/momentum.src.d.ts

@@ -73,8 +73,6 @@ declare module "../highcharts.src" {
     /**
      * (Highstock) Momentum. 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
@@ -84,6 +82,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 PlotMomentumOptions {
         /**