highcharts 11.4.6 → 11.4.8

package/options/bar.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A bar series is a special type of column series where the
      * columns are horizontal.
      *
-     * 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 PlotBarOptions {
         /**

package/options/bb.d.ts

@@ -84,8 +84,6 @@ declare module "../highcharts" {
      * option to be set and should be loaded after the
      * `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
@@ -95,6 +93,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 PlotBbOptions {
         /**
@@ -680,8 +687,6 @@ declare module "../highcharts" {
      * (Highstock) A bollinger bands 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
@@ -692,6 +697,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 `SeriesBbOptions` via an interface to allow custom
      * properties: ``` declare interface SeriesBbOptions { customProperty:
      * string; }

package/options/bb.src.d.ts

@@ -84,8 +84,6 @@ declare module "../highcharts.src" {
      * option to be set and should be loaded after the
      * `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
@@ -95,6 +93,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 PlotBbOptions {
         /**
@@ -680,8 +687,6 @@ declare module "../highcharts.src" {
      * (Highstock) A bollinger bands 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
@@ -692,6 +697,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 `SeriesBbOptions` via an interface to allow custom
      * properties: ``` declare interface SeriesBbOptions { customProperty:
      * string; }

package/options/bubble.d.ts

@@ -398,8 +398,6 @@ declare module "../highcharts" {
      * as a bubble where the position along the X and Y axes mark the X and Y
      * values, and the size of the bubble 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
@@ -409,6 +407,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 PlotBubbleOptions {
         /**

package/options/bubble.src.d.ts

@@ -398,8 +398,6 @@ declare module "../highcharts.src" {
      * as a bubble where the position along the X and Y axes mark the X and Y
      * values, and the size of the bubble 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
@@ -409,6 +407,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 PlotBubbleOptions {
         /**

package/options/bullet.d.ts

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

package/options/bullet.src.d.ts

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

package/options/candlestick.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts" {
      * (Highstock) A candlestick chart is a style of financial chart used to
      * describe price movements over time.
      *
-     * 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 PlotCandlestickOptions {
         /**
@@ -784,8 +791,6 @@ declare module "../highcharts" {
      * (Highstock) A `candlestick` 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
@@ -797,6 +802,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 `SeriesCandlestickOptions` via an interface to
      * allow custom properties: ``` declare interface SeriesCandlestickOptions {
      * customProperty: string; }

package/options/candlestick.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (Highstock) A candlestick chart is a style of financial chart used to
      * describe price movements over time.
      *
-     * 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 PlotCandlestickOptions {
         /**
@@ -784,8 +791,6 @@ declare module "../highcharts.src" {
      * (Highstock) A `candlestick` 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
@@ -797,6 +802,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 `SeriesCandlestickOptions` via an interface to
      * allow custom properties: ``` declare interface SeriesCandlestickOptions {
      * customProperty: string; }

package/options/cci.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts" {
      * (Highstock) Commodity Channel Index (CCI). 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 PlotCciOptions {
         /**

package/options/cci.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (Highstock) Commodity Channel Index (CCI). 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.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 PlotCciOptions {
         /**

package/options/chaikin.d.ts

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

package/options/chaikin.src.d.ts

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

package/options/cmf.d.ts

@@ -73,8 +73,6 @@ declare module "../highcharts" {
     /**
      * (Highstock) Chaikin Money Flow indicator (cmf).
      *
-     * 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 PlotCmfOptions {
         /**

package/options/cmf.src.d.ts

@@ -73,8 +73,6 @@ declare module "../highcharts.src" {
     /**
      * (Highstock) Chaikin Money Flow indicator (cmf).
      *
-     * 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 PlotCmfOptions {
         /**

package/options/cmo.d.ts

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

package/options/cmo.src.d.ts

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

package/options/column.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts" {
      * (Highcharts, Highstock) Column series display one column per value along
      * an X axis.
      *
-     * 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 PlotColumnOptions {
         /**
@@ -820,8 +827,6 @@ declare module "../highcharts" {
      * (Highcharts, Highstock) A `column` 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
@@ -832,6 +837,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 `SeriesColumnOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesColumnOptions {
      * customProperty: string; }

package/options/column.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) Column series display one column per value along
      * an X axis.
      *
-     * 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 PlotColumnOptions {
         /**
@@ -820,8 +827,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) A `column` 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
@@ -832,6 +837,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 `SeriesColumnOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesColumnOptions {
      * customProperty: string; }