highcharts 9.1.1 → 9.2.2

package/es-modules/Core/DefaultOptions.js

@@ -8,187 +8,15 @@
  *
  * */
 'use strict';
-import H from './Globals.js';
-var isTouchDevice = H.isTouchDevice, svg = H.svg;
 import ChartDefaults from './Chart/ChartDefaults.js';
 import Color from './Color/Color.js';
 var color = Color.parse;
+import H from './Globals.js';
+var isTouchDevice = H.isTouchDevice, svg = H.svg;
 import palette from './Color/Palette.js';
 import Time from './Time.js';
 import U from './Utilities.js';
 var merge = U.merge;
-/* *
- *
- *  API Declarations
- *
- * */
-/**
- * @typedef {"plotBox"|"spacingBox"} Highcharts.ButtonRelativeToValue
- */
-/**
- * Gets fired when a series is added to the chart after load time, using the
- * `addSeries` method. Returning `false` prevents the series from being added.
- *
- * @callback Highcharts.ChartAddSeriesCallbackFunction
- *
- * @param {Highcharts.Chart} this
- *        The chart on which the event occured.
- *
- * @param {Highcharts.ChartAddSeriesEventObject} event
- *        The event that occured.
- */
-/**
- * Contains common event information. Through the `options` property you can
- * access the series options that were passed to the `addSeries` method.
- *
- * @interface Highcharts.ChartAddSeriesEventObject
- */ /**
-* The series options that were passed to the `addSeries` method.
-* @name Highcharts.ChartAddSeriesEventObject#options
-* @type {Highcharts.SeriesOptionsType}
-*/ /**
-* Prevents the default behaviour of the event.
-* @name Highcharts.ChartAddSeriesEventObject#preventDefault
-* @type {Function}
-*/ /**
-* The event target.
-* @name Highcharts.ChartAddSeriesEventObject#target
-* @type {Highcharts.Chart}
-*/ /**
-* The event type.
-* @name Highcharts.ChartAddSeriesEventObject#type
-* @type {"addSeries"}
-*/
-/**
- * Gets fired when clicking on the plot background.
- *
- * @callback Highcharts.ChartClickCallbackFunction
- *
- * @param {Highcharts.Chart} this
- *        The chart on which the event occured.
- *
- * @param {Highcharts.PointerEventObject} event
- *        The event that occured.
- */
-/**
- * Contains an axes of the clicked spot.
- *
- * @interface Highcharts.ChartClickEventAxisObject
- */ /**
-* Axis at the clicked spot.
-* @name Highcharts.ChartClickEventAxisObject#axis
-* @type {Highcharts.Axis}
-*/ /**
-* Axis value at the clicked spot.
-* @name Highcharts.ChartClickEventAxisObject#value
-* @type {number}
-*/
-/**
- * Contains information about the clicked spot on the chart. Remember the unit
- * of a datetime axis is milliseconds since 1970-01-01 00:00:00.
- *
- * @interface Highcharts.ChartClickEventObject
- * @extends Highcharts.PointerEventObject
- */ /**
-* Information about the x-axis on the clicked spot.
-* @name Highcharts.ChartClickEventObject#xAxis
-* @type {Array<Highcharts.ChartClickEventAxisObject>}
-*/ /**
-* Information about the y-axis on the clicked spot.
-* @name Highcharts.ChartClickEventObject#yAxis
-* @type {Array<Highcharts.ChartClickEventAxisObject>}
-*/ /**
-* Information about the z-axis on the clicked spot.
-* @name Highcharts.ChartClickEventObject#zAxis
-* @type {Array<Highcharts.ChartClickEventAxisObject>|undefined}
-*/
-/**
- * Gets fired when the chart is finished loading.
- *
- * @callback Highcharts.ChartLoadCallbackFunction
- *
- * @param {Highcharts.Chart} this
- *        The chart on which the event occured.
- *
- * @param {global.Event} event
- *        The event that occured.
- */
-/**
- * Fires when the chart is redrawn, either after a call to `chart.redraw()` or
- * after an axis, series or point is modified with the `redraw` option set to
- * `true`.
- *
- * @callback Highcharts.ChartRedrawCallbackFunction
- *
- * @param {Highcharts.Chart} this
- *        The chart on which the event occured.
- *
- * @param {global.Event} event
- *        The event that occured.
- */
-/**
- * Gets fired after initial load of the chart (directly after the `load` event),
- * and after each redraw (directly after the `redraw` event).
- *
- * @callback Highcharts.ChartRenderCallbackFunction
- *
- * @param {Highcharts.Chart} this
- *        The chart on which the event occured.
- *
- * @param {global.Event} event
- *        The event that occured.
- */
-/**
- * Gets fired when an area of the chart has been selected. The default action
- * for the selection event is to zoom the chart to the selected area. It can be
- * prevented by calling `event.preventDefault()` or return false.
- *
- * @callback Highcharts.ChartSelectionCallbackFunction
- *
- * @param {Highcharts.Chart} this
- *        The chart on which the event occured.
- *
- * @param {global.ChartSelectionContextObject} 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
 /* *
  *
  *  API Options
@@ -2058,15 +1886,6 @@ var defaultOptions = {
          * @type      {Highcharts.TooltipFormatterCallbackFunction}
          * @apioption tooltip.nullFormatter
          */
-        /**
-         * The number of milliseconds to wait until the tooltip is hidden when
-         * mouse out from a point or chart.
-         *
-         * @type      {number}
-         * @default   500
-         * @since     3.0
-         * @apioption tooltip.hideDelay
-         */
         /**
          * Whether to allow the tooltip to render outside the chart's SVG
          * element box. By default (`false`), the tooltip is rendered within the
@@ -2129,69 +1948,6 @@ var defaultOptions = {
          * @since     2.2.4
          * @apioption tooltip.positioner
          */
-        /**
-         * The name of a symbol to use for the border around the tooltip. Can
-         * be one of: `"callout"`, `"circle"` or `"rect"`. When
-         * [tooltip.split](#tooltip.split)
-         * option is enabled, shape is applied to all boxes except header, which
-         * is controlled by
-         * [tooltip.headerShape](#tooltip.headerShape).
-         *
-         * Custom callbacks for symbol path generation can also be added to
-         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
-         * [series.marker.symbol](plotOptions.line.marker.symbol).
-         *
-         * @type      {Highcharts.TooltipShapeValue}
-         * @default   callout
-         * @since     4.0
-         * @apioption tooltip.shape
-         */
-        /**
-         * The name of a symbol to use for the border around the tooltip
-         * header. Applies only when [tooltip.split](#tooltip.split) is
-         * enabled.
-         *
-         * Custom callbacks for symbol path generation can also be added to
-         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
-         * [series.marker.symbol](plotOptions.line.marker.symbol).
-         *
-         * @see [tooltip.shape](#tooltip.shape)
-         *
-         * @sample {highstock} stock/tooltip/split-positioner/
-         *         Different shapes for header and split boxes
-         *
-         * @type       {Highcharts.TooltipShapeValue}
-         * @default    callout
-         * @validvalue ["callout", "square"]
-         * @since      7.0
-         * @apioption  tooltip.headerShape
-         */
-        /**
-         * When the tooltip is shared, the entire plot area will capture mouse
-         * movement or touch events. Tooltip texts for series types with ordered
-         * data (not pie, scatter, flags etc) will be shown in a single bubble.
-         * This is recommended for single series charts and for tablet/mobile
-         * optimized charts.
-         *
-         * See also [tooltip.split](#tooltip.split), that is better suited for
-         * charts with many series, especially line-type series. The
-         * `tooltip.split` option takes precedence over `tooltip.shared`.
-         *
-         * @sample {highcharts} highcharts/tooltip/shared-false/
-         *         False by default
-         * @sample {highcharts} highcharts/tooltip/shared-true/
-         *         True
-         * @sample {highcharts} highcharts/tooltip/shared-x-crosshair/
-         *         True with x axis crosshair
-         * @sample {highcharts} highcharts/tooltip/shared-true-mixed-types/
-         *         True with mixed series types
-         *
-         * @type      {boolean}
-         * @default   false
-         * @since     2.1
-         * @product   highcharts highstock
-         * @apioption tooltip.shared
-         */
         /**
          * Split the tooltip into one label per series, with the header close
          * to the axis. This is recommended over [shared](#tooltip.shared)
@@ -2255,7 +2011,7 @@ var defaultOptions = {
          * @sample {highmaps} maps/tooltip/valuedecimals/
          *         Set decimals, prefix and suffix for the value
          *
-         * @type      {number}
+         * @type      {number|undefined}
          * @since     2.2
          * @apioption tooltip.valueDecimals
          */
@@ -2376,12 +2132,78 @@ var defaultOptions = {
          * @since 2.2
          */
         footerFormat: '',
+        /**
+         * The name of a symbol to use for the border around the tooltip
+         * header. Applies only when [tooltip.split](#tooltip.split) is
+         * enabled.
+         *
+         * Custom callbacks for symbol path generation can also be added to
+         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
+         * [series.marker.symbol](plotOptions.line.marker.symbol).
+         *
+         * @see [tooltip.shape](#tooltip.shape)
+         *
+         * @sample {highstock} stock/tooltip/split-positioner/
+         *         Different shapes for header and split boxes
+         *
+         * @type       {Highcharts.TooltipShapeValue}
+         * @validvalue ["callout", "square"]
+         * @since      7.0
+         */
+        headerShape: 'callout',
+        /**
+         * The number of milliseconds to wait until the tooltip is hidden when
+         * mouse out from a point or chart.
+         *
+         * @since     3.0
+         */
+        hideDelay: 500,
         /**
          * Padding inside the tooltip, in pixels.
          *
          * @since      5.0.0
          */
         padding: 8,
+        /**
+         * The name of a symbol to use for the border around the tooltip. Can
+         * be one of: `"callout"`, `"circle"` or `"rect"`. When
+         * [tooltip.split](#tooltip.split)
+         * option is enabled, shape is applied to all boxes except header, which
+         * is controlled by
+         * [tooltip.headerShape](#tooltip.headerShape).
+         *
+         * Custom callbacks for symbol path generation can also be added to
+         * `Highcharts.SVGRenderer.prototype.symbols` the same way as for
+         * [series.marker.symbol](plotOptions.line.marker.symbol).
+         *
+         * @type      {Highcharts.TooltipShapeValue}
+         * @since     4.0
+         */
+        shape: 'callout',
+        /**
+         * When the tooltip is shared, the entire plot area will capture mouse
+         * movement or touch events. Tooltip texts for series types with ordered
+         * data (not pie, scatter, flags etc) will be shown in a single bubble.
+         * This is recommended for single series charts and for tablet/mobile
+         * optimized charts.
+         *
+         * See also [tooltip.split](#tooltip.split), that is better suited for
+         * charts with many series, especially line-type series. The
+         * `tooltip.split` option takes precedence over `tooltip.shared`.
+         *
+         * @sample {highcharts} highcharts/tooltip/shared-false/
+         *         False by default
+         * @sample {highcharts} highcharts/tooltip/shared-true/
+         *         True
+         * @sample {highcharts} highcharts/tooltip/shared-x-crosshair/
+         *         True with x axis crosshair
+         * @sample {highcharts} highcharts/tooltip/shared-true-mixed-types/
+         *         True with mixed series types
+         *
+         * @since     2.1
+         * @product   highcharts highstock
+         */
+        shared: false,
         /**
          * Proximity snap for graphs or single points. It defaults to 10 for
          * mouse-powered devices and 25 for touch devices.
@@ -2479,6 +2301,7 @@ var defaultOptions = {
          * @type {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
          */
         backgroundColor: color(palette.neutralColor3)
+            // @todo: Disallow undefined as input for colors
             .setOpacity(0.85).get(),
         /**
          * The pixel width of the tooltip border.
@@ -2515,6 +2338,16 @@ var defaultOptions = {
          * @type {boolean|Highcharts.ShadowOptionsObject}
          */
         shadow: true,
+        /**
+         * Prevents the tooltip from switching or closing when touched or
+         * pointed.
+         *
+         * @sample highcharts/tooltip/stickoncontact/
+         *         Tooltip sticks on pointer contact
+         *
+         * @since     8.0.1
+         */
+        stickOnContact: false,
         /**
          * CSS styles for the tooltip. The tooltip can also be styled through
          * the CSS class `.highcharts-tooltip`.
@@ -2537,7 +2370,23 @@ var defaultOptions = {
             fontSize: '12px',
             /** @internal */
             whiteSpace: 'nowrap'
-        }
+        },
+        /**
+         * Use HTML to render the contents of the tooltip instead of SVG. Using
+         * HTML allows advanced formatting like tables and images in the
+         * tooltip. It is also recommended for rtl languages as it works around
+         * rtl bugs in early Firefox.
+         *
+         * @sample {highcharts|highstock} highcharts/tooltip/footerformat/
+         *         A table for value alignment
+         * @sample {highcharts|highstock} highcharts/tooltip/fullhtml/
+         *         Full HTML tooltip
+         * @sample {highmaps} maps/tooltip/usehtml/
+         *         Pure HTML tooltip
+         *
+         * @since     2.2
+         */
+        useHTML: false
     },
     /**
      * Highchart by default puts a credits label in the lower right corner
@@ -2717,3 +2566,175 @@ var DefaultOptions = {
     setOptions: setOptions
 };
 export default DefaultOptions;
+/* *
+ *
+ *  API Declarations
+ *
+ * */
+/**
+ * @typedef {"plotBox"|"spacingBox"} Highcharts.ButtonRelativeToValue
+ */
+/**
+ * Gets fired when a series is added to the chart after load time, using the
+ * `addSeries` method. Returning `false` prevents the series from being added.
+ *
+ * @callback Highcharts.ChartAddSeriesCallbackFunction
+ *
+ * @param {Highcharts.Chart} this
+ *        The chart on which the event occured.
+ *
+ * @param {Highcharts.ChartAddSeriesEventObject} event
+ *        The event that occured.
+ */
+/**
+ * Contains common event information. Through the `options` property you can
+ * access the series options that were passed to the `addSeries` method.
+ *
+ * @interface Highcharts.ChartAddSeriesEventObject
+ */ /**
+* The series options that were passed to the `addSeries` method.
+* @name Highcharts.ChartAddSeriesEventObject#options
+* @type {Highcharts.SeriesOptionsType}
+*/ /**
+* Prevents the default behaviour of the event.
+* @name Highcharts.ChartAddSeriesEventObject#preventDefault
+* @type {Function}
+*/ /**
+* The event target.
+* @name Highcharts.ChartAddSeriesEventObject#target
+* @type {Highcharts.Chart}
+*/ /**
+* The event type.
+* @name Highcharts.ChartAddSeriesEventObject#type
+* @type {"addSeries"}
+*/
+/**
+ * Gets fired when clicking on the plot background.
+ *
+ * @callback Highcharts.ChartClickCallbackFunction
+ *
+ * @param {Highcharts.Chart} this
+ *        The chart on which the event occured.
+ *
+ * @param {Highcharts.PointerEventObject} event
+ *        The event that occured.
+ */
+/**
+ * Contains an axes of the clicked spot.
+ *
+ * @interface Highcharts.ChartClickEventAxisObject
+ */ /**
+* Axis at the clicked spot.
+* @name Highcharts.ChartClickEventAxisObject#axis
+* @type {Highcharts.Axis}
+*/ /**
+* Axis value at the clicked spot.
+* @name Highcharts.ChartClickEventAxisObject#value
+* @type {number}
+*/
+/**
+ * Contains information about the clicked spot on the chart. Remember the unit
+ * of a datetime axis is milliseconds since 1970-01-01 00:00:00.
+ *
+ * @interface Highcharts.ChartClickEventObject
+ * @extends Highcharts.PointerEventObject
+ */ /**
+* Information about the x-axis on the clicked spot.
+* @name Highcharts.ChartClickEventObject#xAxis
+* @type {Array<Highcharts.ChartClickEventAxisObject>}
+*/ /**
+* Information about the y-axis on the clicked spot.
+* @name Highcharts.ChartClickEventObject#yAxis
+* @type {Array<Highcharts.ChartClickEventAxisObject>}
+*/ /**
+* Information about the z-axis on the clicked spot.
+* @name Highcharts.ChartClickEventObject#zAxis
+* @type {Array<Highcharts.ChartClickEventAxisObject>|undefined}
+*/
+/**
+ * Gets fired when the chart is finished loading.
+ *
+ * @callback Highcharts.ChartLoadCallbackFunction
+ *
+ * @param {Highcharts.Chart} this
+ *        The chart on which the event occured.
+ *
+ * @param {global.Event} event
+ *        The event that occured.
+ */
+/**
+ * Fires when the chart is redrawn, either after a call to `chart.redraw()` or
+ * after an axis, series or point is modified with the `redraw` option set to
+ * `true`.
+ *
+ * @callback Highcharts.ChartRedrawCallbackFunction
+ *
+ * @param {Highcharts.Chart} this
+ *        The chart on which the event occured.
+ *
+ * @param {global.Event} event
+ *        The event that occured.
+ */
+/**
+ * Gets fired after initial load of the chart (directly after the `load` event),
+ * and after each redraw (directly after the `redraw` event).
+ *
+ * @callback Highcharts.ChartRenderCallbackFunction
+ *
+ * @param {Highcharts.Chart} this
+ *        The chart on which the event occured.
+ *
+ * @param {global.Event} event
+ *        The event that occured.
+ */
+/**
+ * Gets fired when an area of the chart has been selected. The default action
+ * for the selection event is to zoom the chart to the selected area. It can be
+ * prevented by calling `event.preventDefault()` or return false.
+ *
+ * @callback Highcharts.ChartSelectionCallbackFunction
+ *
+ * @param {Highcharts.Chart} this
+ *        The chart on which the event occured.
+ *
+ * @param {global.ChartSelectionContextObject} 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/Foundation.js

@@ -27,14 +27,15 @@ var registerEventOptions = function (component, options) {
     component.eventOptions = component.eventOptions || {};
     // Register event listeners
     objectEach(options.events, function (event, eventType) {
-        if (isFunction(event)) {
-            // If event does not exist, or is changed by the .update()
-            // function
-            if (component.eventOptions[eventType] !== event) {
-                // Remove existing if set by option
-                if (isFunction(component.eventOptions[eventType])) {
-                    removeEvent(component, eventType, component.eventOptions[eventType]);
-                }
+        // If event does not exist, or is changed by the .update()
+        // function
+        if (component.eventOptions[eventType] !== event) {
+            // Remove existing if set by option
+            if (component.eventOptions[eventType]) {
+                removeEvent(component, eventType, component.eventOptions[eventType]);
+                delete component.eventOptions[eventType];
+            }
+            if (isFunction(event)) {
                 component.eventOptions[eventType] = event;
                 addEvent(component, eventType, event);
             }