highcharts 11.4.6 → 11.4.8

package/options/psar.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts" {
      * (Highstock) Parabolic SAR. This series requires `linkedTo` option to be
      * set and should be loaded after `stock/indicators/indicators.js` file.
      *
-     * 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 PlotPsarOptions {
         /**
@@ -649,8 +656,6 @@ declare module "../highcharts" {
      * (Highstock) A `PSAR` 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
@@ -661,6 +666,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 `SeriesPsarOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesPsarOptions {
      * customProperty: string; }

package/options/psar.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (Highstock) Parabolic SAR. This series requires `linkedTo` option to be
      * set and should be loaded after `stock/indicators/indicators.js` file.
      *
-     * 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 PlotPsarOptions {
         /**
@@ -649,8 +656,6 @@ declare module "../highcharts.src" {
      * (Highstock) A `PSAR` 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
@@ -661,6 +666,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 `SeriesPsarOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesPsarOptions {
      * customProperty: string; }

package/options/pyramid.d.ts

@@ -369,8 +369,6 @@ declare module "../highcharts" {
      * charts are a type of chart often used to visualize stages in a sales
      * project, where the top are the initial stages with the most clients.
      *
-     * 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
@@ -381,6 +379,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 PlotPyramid3dOptions {
         /**
@@ -1057,8 +1064,6 @@ declare module "../highcharts" {
      * (Highcharts) A pyramid series is a special type of funnel, without neck
      * and reversed by default.
      *
-     * 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
@@ -1068,6 +1073,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 PlotPyramidOptions {
         /**
@@ -1447,8 +1461,6 @@ declare module "../highcharts" {
      * (Highcharts) A `pyramid3d` 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
@@ -1460,6 +1472,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 `SeriesPyramid3dOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesPyramid3dOptions {
      * customProperty: string; }
@@ -1494,8 +1515,6 @@ declare module "../highcharts" {
      * (Highcharts) A `pyramid` 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
@@ -1506,6 +1525,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 `SeriesPyramidOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesPyramidOptions {
      * customProperty: string; }

package/options/pyramid.src.d.ts

@@ -369,8 +369,6 @@ declare module "../highcharts.src" {
      * charts are a type of chart often used to visualize stages in a sales
      * project, where the top are the initial stages with the most clients.
      *
-     * 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
@@ -381,6 +379,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 PlotPyramid3dOptions {
         /**
@@ -1057,8 +1064,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A pyramid series is a special type of funnel, without neck
      * and reversed by default.
      *
-     * 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
@@ -1068,6 +1073,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 PlotPyramidOptions {
         /**
@@ -1447,8 +1461,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `pyramid3d` 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
@@ -1460,6 +1472,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 `SeriesPyramid3dOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesPyramid3dOptions {
      * customProperty: string; }
@@ -1494,8 +1515,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `pyramid` 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
@@ -1506,6 +1525,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 `SeriesPyramidOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesPyramidOptions {
      * customProperty: string; }

package/options/roc.d.ts

@@ -82,8 +82,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
@@ -93,6 +91,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 PlotRocOptions {
         /**

package/options/roc.src.d.ts

@@ -82,8 +82,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
@@ -93,6 +91,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 PlotRocOptions {
         /**

package/options/rsi.d.ts

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

package/options/rsi.src.d.ts

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

package/options/sankey.d.ts

@@ -100,8 +100,6 @@ declare module "../highcharts" {
      * width of the link between two nodes is shown proportionally to the flow
      * quantity.
      *
-     * 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
@@ -111,6 +109,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 PlotSankeyOptions {
         /**
@@ -542,8 +549,6 @@ declare module "../highcharts" {
      * (Highcharts) A `sankey` 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
@@ -554,6 +559,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 `SeriesSankeyOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesSankeyOptions {
      * customProperty: string; }

package/options/sankey.src.d.ts

@@ -100,8 +100,6 @@ declare module "../highcharts.src" {
      * width of the link between two nodes is shown proportionally to the flow
      * quantity.
      *
-     * 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
@@ -111,6 +109,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 PlotSankeyOptions {
         /**
@@ -542,8 +549,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `sankey` 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
@@ -554,6 +559,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 `SeriesSankeyOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesSankeyOptions {
      * customProperty: string; }

package/options/scatter.d.ts

@@ -604,8 +604,6 @@ declare module "../highcharts" {
      * (Highcharts, Highstock) A scatter plot uses cartesian coordinates to
      * display values for two variables for a set of data.
      *
-     * 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
@@ -615,6 +613,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 PlotScatterOptions {
         /**

package/options/scatter.src.d.ts

@@ -604,8 +604,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) A scatter plot uses cartesian coordinates to
      * display values for two variables for a set of data.
      *
-     * 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
@@ -615,6 +613,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 PlotScatterOptions {
         /**

package/options/series.d.ts

@@ -76,8 +76,6 @@ declare module "../highcharts" {
      * (Highcharts, Highstock, Highmaps, Gantt) General options for all series
      * types.
      *
-     * 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 PlotSeriesOptions {
         /**

package/options/series.src.d.ts

@@ -76,8 +76,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock, Highmaps, Gantt) General options for all series
      * types.
      *
-     * 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 PlotSeriesOptions {
         /**

package/options/slowstochastic.d.ts

@@ -418,8 +418,6 @@ declare module "../highcharts" {
      * (Highstock) A Slow Stochastic indicator. 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
@@ -431,6 +429,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 `SeriesSlowstochasticOptions` via an interface to
      * allow custom properties: ``` declare interface
      * SeriesSlowstochasticOptions { customProperty: string; }

package/options/slowstochastic.src.d.ts

@@ -418,8 +418,6 @@ declare module "../highcharts.src" {
      * (Highstock) A Slow Stochastic indicator. 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
@@ -431,6 +429,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 `SeriesSlowstochasticOptions` via an interface to
      * allow custom properties: ``` declare interface
      * SeriesSlowstochasticOptions { customProperty: string; }

package/options/sma.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts" {
      * (Highstock) Simple moving average indicator (SMA). 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
@@ -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 PlotSmaOptions {
         /**