highcharts 10.2.1 → 10.3.1

package/es-modules/Core/Chart/ChartDefaults.js

@@ -426,6 +426,7 @@ var ChartDefaults = {
          * @sample {highcharts} highcharts/chart/panning-type
          *         Zooming and xy panning
          *
+         * @declare    Highcharts.OptionsChartPanningTypeValue
          * @type       {string}
          * @validvalue ["x", "y", "xy"]
          * @default    {highcharts|highstock} x
@@ -566,7 +567,9 @@ var ChartDefaults = {
     /**
      * The button that appears after a selection zoom, allowing the user
      * to reset zoom.
-     * @deprecated
+     *
+     * @since      2.2
+     * @deprecated 10.2.1
      */
     resetZoomButton: {
         /**
@@ -578,11 +581,9 @@ var ChartDefaults = {
          * @sample {highstock} highcharts/chart/resetzoombutton-relativeto/
          *         Relative to the chart
          *
-         * @type       {Highcharts.ButtonRelativeToValue}
-         * @default    plot
-         * @deprecated
-         * @since      2.2
-         * @apioption  chart.resetZoomButton.relativeTo
+         * @type      {Highcharts.ButtonRelativeToValue}
+         * @default   plot
+         * @apioption chart.resetZoomButton.relativeTo
          */
         /**
          * A collection of attributes for the button. The object takes SVG
@@ -597,13 +598,10 @@ var ChartDefaults = {
          *         Theming the button
          *
          * @type {Highcharts.SVGAttributes}
-         * @deprecated
-         * @since 2.2
          */
         theme: {
             /**
              * @internal
-             * @deprecated
              */
             zIndex: 6
         },
@@ -617,32 +615,26 @@ var ChartDefaults = {
          * @sample {highmaps} highcharts/chart/resetzoombutton-position/
          *         Above the plot area
          *
-         * @type  {Highcharts.AlignObject}
-         * @deprecated
-         * @since 2.2
+         * @type {Highcharts.AlignObject}
          */
         position: {
             /**
              * The horizontal alignment of the button.
-             * @deprecated
              */
             align: 'right',
             /**
              * The horizontal offset of the button.
-             * @deprecated
              */
             x: -10,
             /**
              * The vertical alignment of the button.
              *
-             * @type       {Highcharts.VerticalAlignValue}
-             * @deprecated
-             * @default    top
-             * @apioption  chart.resetZoomButton.position.verticalAlign
+             * @type      {Highcharts.VerticalAlignValue}
+             * @default   top
+             * @apioption chart.resetZoomButton.position.verticalAlign
              */
             /**
              * The vertical offset of the button.
-             * @deprecated
              */
             y: 10
         }
@@ -911,6 +903,8 @@ var ChartDefaults = {
      *         Y
      * @sample {highcharts} highcharts/chart/zoomtype-xy/
      *         Xy
+     * @sample {highcharts} highcharts/chart/zoomtype-polar/
+     *         Zoom on polar chart
      * @sample {highstock} stock/demo/basic-line/
      *         None by default
      * @sample {highstock} stock/chart/zoomtype-x/
@@ -959,7 +953,6 @@ var ChartDefaults = {
          * @default    {highcharts} undefined
          * @default    {highstock} x
          * @product    highcharts highstock gantt
-         * @since 10.2.1
          * @validvalue ["x", "y", "xy"]
          * @apioption  chart.zooming.pinchType
          */
@@ -967,25 +960,24 @@ var ChartDefaults = {
          * Decides in what dimensions the user can zoom by dragging the mouse.
          * Can be one of `x`, `y` or `xy`.
          *
+         * @declare    Highcharts.OptionsChartZoomingTypeValue
          * @type       {string}
          * @default    {highcharts} undefined
          * @product    highcharts highstock gantt
          * @validvalue ["x", "y", "xy"]
-         * @since 10.2.1
          * @apioption  chart.zooming.type
          */
         /**
-        * Set a key to hold when dragging to zoom the chart. This is useful to
-        * avoid zooming while moving points. Should be set different than
-        * [chart.panKey](#chart.panKey).
-        *
-        * @type       {string}
-        * @default    {highcharts} undefined
-        * @since 10.2.1
-        * @validvalue ["alt", "ctrl", "meta", "shift"]
-        * @requires   modules/draggable-points
-        * @apioption  chart.zooming.key
-        */
+         * Set a key to hold when dragging to zoom the chart. This is useful to
+         * avoid zooming while moving points. Should be set different than
+         * [chart.panKey](#chart.panKey).
+         *
+         * @type       {string}
+         * @default    {highcharts} undefined
+         * @validvalue ["alt", "ctrl", "meta", "shift"]
+         * @requires   modules/draggable-points
+         * @apioption  chart.zooming.key
+         */
         /**
          * Enables zooming by a single touch, in combination with
          * [chart.zooming.type](#chart.zooming.type). When enabled, two-finger
@@ -994,16 +986,16 @@ var ChartDefaults = {
          * with touch-dragging the chart to read the tooltip. And especially
          * when vertical zooming is enabled, it will make it hard to scroll
          * vertically on the page.
-         * @sample     highcharts/chart/zoombysingletouch
-         *             Zoom by single touch enabled, with buttons to toggle
-         * @product    highcharts highstock gantt
-         * @since 10.2.1
+         *
+         * @sample  highcharts/chart/zoombysingletouch
+         *          Zoom by single touch enabled, with buttons to toggle
+         *
+         * @product highcharts highstock gantt
          */
         singleTouch: false,
         /**
          * The button that appears after a selection zoom, allowing the user
          * to reset zoom.
-         * @since 10.2.1
          */
         resetButton: {
             /**
@@ -1015,10 +1007,9 @@ var ChartDefaults = {
              * @sample {highstock} highcharts/chart/resetzoombutton-relativeto/
              *         Relative to the chart
              *
-             * @type       {Highcharts.ButtonRelativeToValue}
-             * @default    plot
-             * @since 10.2.1
-             * @apioption  chart.zooming.resetButton.relativeTo
+             * @type      {Highcharts.ButtonRelativeToValue}
+             * @default   plot
+             * @apioption chart.zooming.resetButton.relativeTo
              */
             /**
              * A collection of attributes for the button. The object takes SVG
@@ -1032,7 +1023,7 @@ var ChartDefaults = {
              * @sample {highstock} highcharts/chart/resetzoombutton-theme/
              *         Theming the button
              *
-             * @type {Highcharts.SVGAttributes}
+             * @type  {Highcharts.SVGAttributes}
              * @since 10.2.1
              */
             theme: {
@@ -1065,7 +1056,6 @@ var ChartDefaults = {
                  * The vertical alignment of the button.
                  *
                  * @type       {Highcharts.VerticalAlignValue}
-                 * @since 10.2.1
                  * @default    top
                  * @apioption  chart.zooming.resetButton.position.verticalAlign
                  */

package/es-modules/Core/Chart/GanttChart.js

@@ -26,7 +26,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import Chart from './Chart.js';
-import D from '../DefaultOptions.js';
+import D from '../Defaults.js';
 var getOptions = D.getOptions;
 import U from '../Utilities.js';
 var isArray = U.isArray, merge = U.merge, splat = U.splat;

package/es-modules/Core/Chart/MapChart.js

@@ -24,7 +24,7 @@ var __extends = (this && this.__extends) || (function () {
     };
 })();
 import Chart from './Chart.js';
-import D from '../DefaultOptions.js';
+import D from '../Defaults.js';
 var getOptions = D.getOptions;
 import SVGRenderer from '../Renderer/SVG/SVGRenderer.js';
 import U from '../Utilities.js';

package/es-modules/Core/Chart/StockChart.js

@@ -23,28 +23,20 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
-import A from '../Animation/AnimationUtilities.js';
-var animObject = A.animObject;
 import Axis from '../Axis/Axis.js';
 import Chart from '../Chart/Chart.js';
 import F from '../../Core/FormatUtilities.js';
 var format = F.format;
-import D from '../DefaultOptions.js';
+import D from '../Defaults.js';
 var getOptions = D.getOptions;
+import NavigatorDefaults from '../../Stock/Navigator/NavigatorDefaults.js';
+import RangeSelectorDefaults from '../../Stock/RangeSelector/RangeSelectorDefaults.js';
+import ScrollbarDefaults from '../../Stock/Scrollbar/ScrollbarDefaults.js';
 import Series from '../Series/Series.js';
 import SVGRenderer from '../Renderer/SVG/SVGRenderer.js';
 import U from '../Utilities.js';
 var addEvent = U.addEvent, clamp = U.clamp, defined = U.defined, extend = U.extend, find = U.find, isNumber = U.isNumber, isString = U.isString, merge = U.merge, pick = U.pick, splat = U.splat;
 import '../Pointer.js';
-// Has a dependency on Navigator due to the use of
-// defaultOptions.navigator
-import '../Navigator.js';
-// Has a dependency on Scrollbar due to the use of
-// defaultOptions.scrollbar
-import '../Scrollbar.js';
-// Has a dependency on RangeSelector due to the use of
-// defaultOptions.rangeSelector
-import '../../Extensions/RangeSelector.js';
 /* *
  *
  *  Class
@@ -85,7 +77,7 @@ var StockChart = /** @class */ (function (_super) {
         var defaultOptions = getOptions(), xAxisOptions = userOptions.xAxis, yAxisOptions = userOptions.yAxis, 
         // Always disable startOnTick:true on the main axis when the
         // navigator is enabled (#1090)
-        navigatorEnabled = pick(userOptions.navigator && userOptions.navigator.enabled, defaultOptions.navigator.enabled, true);
+        navigatorEnabled = pick(userOptions.navigator && userOptions.navigator.enabled, NavigatorDefaults.enabled, true);
         // Avoid doing these twice
         userOptions.xAxis = userOptions.yAxis = void 0;
         var options = merge({
@@ -103,12 +95,11 @@ var StockChart = /** @class */ (function (_super) {
             },
             scrollbar: {
                 // #4988 - check if setOptions was called
-                enabled: pick((defaultOptions.scrollbar &&
-                    defaultOptions.scrollbar.enabled), true)
+                enabled: pick(ScrollbarDefaults.enabled, true)
             },
             rangeSelector: {
                 // #4988 - check if setOptions was called
-                enabled: pick(defaultOptions.rangeSelector.enabled, true)
+                enabled: pick(RangeSelectorDefaults.rangeSelector.enabled, true)
             },
             title: {
                 text: null
@@ -230,13 +221,6 @@ function getDefaultAxisOptions(type, options) {
                 y: -2
             },
             opposite: pick(options.opposite, true),
-            /**
-             * @default {highcharts} true
-             * @default {highstock} false
-             * @apioption yAxis.showLastLabel
-             *
-             * @private
-             */
             showLastLabel: !!(
             // #6104, show last label by default for category axes
             options.categories ||
@@ -256,10 +240,9 @@ function getDefaultAxisOptions(type, options) {
  */
 function getForcedAxisOptions(type, chartOptions) {
     if (type === 'xAxis') {
-        var defaultOptions = getOptions(), 
-        // Always disable startOnTick:true on the main axis when the
-        // navigator is enabled (#1090)
-        navigatorEnabled = pick(chartOptions.navigator && chartOptions.navigator.enabled, defaultOptions.navigator.enabled, true);
+        // Always disable startOnTick:true on the main axis when the navigator
+        // is enabled (#1090)
+        var navigatorEnabled = pick(chartOptions.navigator && chartOptions.navigator.enabled, NavigatorDefaults.enabled, true);
         var axisOptions = {
             type: 'datetime',
             categories: void 0
@@ -636,7 +619,7 @@ addEvent(Chart, 'update', function (e) {
     // case (#6615)
     if ('scrollbar' in options && this.navigator) {
         merge(true, this.options.scrollbar, options.scrollbar);
-        this.navigator.update({}, false);
+        this.navigator.update({});
         delete options.scrollbar;
     }
 });

package/es-modules/Core/{DefaultOptions.js → Defaults.js}

@@ -1217,8 +1217,8 @@ var defaultOptions = {
              * Whether to enable the legend navigation. In most cases, disabling
              * the navigation results in an unwanted overflow.
              *
-             * See also the [adapt chart to legend](
-             * https://www.highcharts.com/products/plugin-registry/single/8/Adapt-Chart-To-Legend)
+             * See also the
+             * [adapt chart to legend](https://github.com/highcharts/adapt-chart-to-legend)
              * plugin for a solution to extend the chart height to make room for
              * the legend, optionally in exported charts only.
              *
@@ -1517,6 +1517,24 @@ var defaultOptions = {
          * @default   false
          * @apioption legend.useHTML
          */
+        /**
+         * For a color axis with data classes, how many decimals to render in
+         * the legend. The default preserves the decimals of the range numbers.
+         *
+         * @type      {number}
+         * @default   -1
+         * @product   highcharts highmaps
+         * @apioption legend.valueDecimals
+         */
+        /**
+         * For a color axis with data classes, a suffix for the range numbers in
+         * the legend.
+         *
+         * @type      {string}
+         * @default   ''
+         * @product   highcharts highmaps
+         * @apioption legend.valueSuffix
+         */
         /**
          * The width of the legend box. If a number is set, it translates to
          * pixels. Since v7.0.2 it allows setting a percent string of the full
@@ -2705,44 +2723,10 @@ export default DefaultOptions;
  * @param {Highcharts.Chart} this
  *        The chart on which the event occured.
  *
- * @param {global.ChartSelectionContextObject} event
+ * @param {Highcharts.SelectEventObject} event
  *        Event informations
  *
  * @return {boolean|undefined}
  *         Return false to prevent the default action, usually zoom.
  */
-/**
- * The primary axes are `xAxis[0]` and `yAxis[0]`. Remember the unit of a
- * datetime axis is milliseconds since 1970-01-01 00:00:00.
- *
- * @interface Highcharts.ChartSelectionContextObject
- * @extends global.Event
- */ /**
-* Arrays containing the axes of each dimension and each axis' min and max
-* values.
-* @name Highcharts.ChartSelectionContextObject#xAxis
-* @type {Array<Highcharts.ChartSelectionAxisContextObject>}
-*/ /**
-* Arrays containing the axes of each dimension and each axis' min and max
-* values.
-* @name Highcharts.ChartSelectionContextObject#yAxis
-* @type {Array<Highcharts.ChartSelectionAxisContextObject>}
-*/
-/**
- * Axis context of the selection.
- *
- * @interface Highcharts.ChartSelectionAxisContextObject
- */ /**
-* The selected Axis.
-* @name Highcharts.ChartSelectionAxisContextObject#axis
-* @type {Highcharts.Axis}
-*/ /**
-* The maximum axis value, either automatic or set manually.
-* @name Highcharts.ChartSelectionAxisContextObject#max
-* @type {number}
-*/ /**
-* The minimum axis value, either automatic or set manually.
-* @name Highcharts.ChartSelectionAxisContextObject#min
-* @type {number}
-*/
 (''); // detach doclets above

package/es-modules/Core/FormatUtilities.js

@@ -8,7 +8,7 @@
  *
  * */
 'use strict';
-import D from './DefaultOptions.js';
+import D from './Defaults.js';
 var defaultOptions = D.defaultOptions, defaultTime = D.defaultTime;
 import U from './Utilities.js';
 var getNestedProperty = U.getNestedProperty, isNumber = U.isNumber, pick = U.pick, pInt = U.pInt;

package/es-modules/Core/Globals.js

@@ -24,7 +24,7 @@ var Globals;
      *  Constants
      *
      * */
-    Globals.SVG_NS = 'http://www.w3.org/2000/svg', Globals.product = 'Highcharts', Globals.version = '10.2.1', Globals.win = (typeof window !== 'undefined' ?
+    Globals.SVG_NS = 'http://www.w3.org/2000/svg', Globals.product = 'Highcharts', Globals.version = '10.3.1', Globals.win = (typeof window !== 'undefined' ?
         window :
         {}), // eslint-disable-line node/no-unsupported-features/es-builtins
     Globals.doc = Globals.win.document, Globals.svg = (Globals.doc &&