highcharts 11.4.6 → 11.4.7

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 {
         /**

package/options/sma.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (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.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 PlotSmaOptions {
         /**

package/options/solidgauge.d.ts

@@ -348,8 +348,6 @@ declare module "../highcharts" {
      * indicated by a filled arc, and the color of the arc may variate with the
      * 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
@@ -360,6 +358,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 PlotSolidgaugeOptions {
         /**

package/options/solidgauge.src.d.ts

@@ -348,8 +348,6 @@ declare module "../highcharts.src" {
      * indicated by a filled arc, and the color of the arc may variate with the
      * 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
@@ -360,6 +358,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 PlotSolidgaugeOptions {
         /**

package/options/spline.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts" {
      * (Highcharts, Highstock) A spline series is a special type of line series,
      * where the segments between the data points are smoothed.
      *
-     * 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 PlotSplineOptions {
         /**

package/options/spline.src.d.ts

@@ -74,8 +74,6 @@ declare module "../highcharts.src" {
      * (Highcharts, Highstock) A spline series is a special type of line series,
      * where the segments between the data points are smoothed.
      *
-     * 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 PlotSplineOptions {
         /**

package/options/stochastic.d.ts

@@ -75,8 +75,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
@@ -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 PlotStochasticOptions {
         /**
@@ -664,8 +671,6 @@ declare module "../highcharts" {
      * (Highstock) A 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
@@ -677,6 +682,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 `SeriesStochasticOptions` via an interface to
      * allow custom properties: ``` declare interface SeriesStochasticOptions {
      * customProperty: string; }

package/options/stochastic.src.d.ts

@@ -75,8 +75,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
@@ -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 PlotStochasticOptions {
         /**
@@ -664,8 +671,6 @@ declare module "../highcharts.src" {
      * (Highstock) A 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
@@ -677,6 +682,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 `SeriesStochasticOptions` via an interface to
      * allow custom properties: ``` declare interface SeriesStochasticOptions {
      * customProperty: string; }

package/options/streamgraph.d.ts

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

package/options/streamgraph.src.d.ts

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

package/options/sunburst.d.ts

@@ -300,8 +300,6 @@ declare module "../highcharts" {
      * of the tree. The visualization bears a resemblance to both treemap and
      * pie charts.
      *
-     * 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
@@ -311,6 +309,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 PlotSunburstOptions {
         /**
@@ -661,8 +668,6 @@ declare module "../highcharts" {
      * (Highcharts) A `sunburst` 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
@@ -673,6 +678,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 `SeriesSunburstOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesSunburstOptions {
      * customProperty: string; }

package/options/sunburst.src.d.ts

@@ -300,8 +300,6 @@ declare module "../highcharts.src" {
      * of the tree. The visualization bears a resemblance to both treemap and
      * pie charts.
      *
-     * 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
@@ -311,6 +309,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 PlotSunburstOptions {
         /**
@@ -661,8 +668,6 @@ declare module "../highcharts.src" {
      * (Highcharts) A `sunburst` 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
@@ -673,6 +678,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 `SeriesSunburstOptions` via an interface to allow
      * custom properties: ``` declare interface SeriesSunburstOptions {
      * customProperty: string; }

package/options/supertrend.d.ts

@@ -82,8 +82,6 @@ declare module "../highcharts" {
      * option to be set and should be loaded after the
      * `stock/indicators/indicators.js` and `stock/indicators/sma.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
@@ -94,6 +92,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 PlotSupertrendOptions {
         /**

package/options/supertrend.src.d.ts

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

package/options/tema.d.ts

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

package/options/tema.src.d.ts

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