@highcharts/grid-pro 2.2.0 → 2.3.0

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

@@ -26,10 +26,10 @@ import SeriesRegistry from '../Series/SeriesRegistry.js';
 const { seriesTypes } = SeriesRegistry;
 import SVGRenderer from '../Renderer/SVG/SVGRenderer.js';
 import Time from '../Time.js';
-import U from '../Utilities.js';
 import AST from '../Renderer/HTML/AST.js';
 import Tick from '../Axis/Tick.js';
-const { addEvent, attr, createElement, css, defined, diffObjects, discardElement, erase, error, extend, find, fireEvent, getAlignFactor, getStyle, isArray, isNumber, isObject, isString, merge, objectEach, pick, pInt, relativeLength, removeEvent, splat, syncTimeout, uniqueKey } = U;
+import { addEvent, attr, createElement, css, defined, diffObjects, discardElement, erase, extend, find, fireEvent, getAlignFactor, getStyle, internalClearTimeout, isArray, isNumber, isObject, isString, merge, objectEach, pick, pInt, relativeLength, removeEvent, splat, syncTimeout } from '../../Shared/Utilities.js';
+import { error, uniqueKey } from '../Utilities.js';
 /* *
  *
  *  Class
@@ -107,6 +107,11 @@ class Chart {
     ) {
         /** @internal */
         this.sharedClips = {};
+        // Return early if there's no browser API (server environment).
+        if (!doc) {
+            error(36, false, this);
+            return;
+        }
         const args = [
             // ES5 builds fail unless we cast it to an Array
             ...arguments
@@ -369,13 +374,6 @@ class Chart {
             for (let i = fromIndex, iEnd = collection.length; i < iEnd; ++i) {
                 const item = collection[i];
                 if (item) {
-                    /**
-                     * Contains the series' index in the `Chart.series` array.
-                     *
-                     * @name Highcharts.Series#index
-                     * @type {number}
-                     * @readonly
-                     */
                     item.index = i;
                     if (item instanceof Series) {
                         item.name = item.getName();
@@ -1277,7 +1275,7 @@ class Chart {
             containerBox.width) {
             if (containerBox.width !== oldBox.width ||
                 containerBox.height !== oldBox.height) {
-                U.clearTimeout(chart.reflowTimeout);
+                internalClearTimeout(chart.reflowTimeout);
                 // When called from window.resize, e is set, else it's called
                 // directly (#2224)
                 chart.reflowTimeout = syncTimeout(function () {
@@ -1681,15 +1679,6 @@ class Chart {
                 // #3341 avoid mutual linking
                 linkedParent.linkedParent !== series) {
                 linkedParent.linkedSeries.push(series);
-                /**
-                 * The parent series of the current series, if the current
-                 * series has a [linkedTo](https://api.highcharts.com/highcharts/series.line.linkedTo)
-                 * setting.
-                 *
-                 * @name Highcharts.Series#linkedParent
-                 * @type {Highcharts.Series}
-                 * @readonly
-                 */
                 series.linkedParent = linkedParent;
                 if (linkedParent.enabledDataSorting) {
                     series.setDataSortingOptions();
@@ -1772,14 +1761,25 @@ class Chart {
         while ((redoHorizontal || redoVertical || axisLayoutRuns > 1) &&
             run < axisLayoutRuns // #19794
         ) {
-            const tempWidth = chart.plotWidth, tempHeight = chart.plotHeight;
+            const tempWidth = chart.plotWidth, tempHeight = chart.plotHeight, threshold = [1.05, 1.1];
             for (const axis of axes) {
+                const horizNum = +(axis.horiz || 0);
                 if (run === 0) {
                     // Get margins by pre-rendering axes
                     axis.setScale();
+                    // On datetime axes, consider the tick interval match. A
+                    // match close to 1 means that the current normalized tick
+                    // interval is an insecure match to the requested tick
+                    // interval, on the brink of landing on a higher unit. In
+                    // this case, we should redo the axis to get a more
+                    // appropriate tick interval (#17393).
+                    const tickIntervalMatch = axis.tickPositions?.info?.match;
+                    if (tickIntervalMatch) {
+                        threshold[horizNum] = Math.min(tickIntervalMatch, threshold[horizNum]);
+                    }
                 }
-                else if ((axis.horiz && redoHorizontal) ||
-                    (!axis.horiz && redoVertical)) {
+                else if ((horizNum && redoHorizontal) ||
+                    (!horizNum && redoVertical)) {
                     // Update to reflect the new margins
                     axis.setTickInterval(true);
                 }
@@ -1791,8 +1791,10 @@ class Chart {
                 // Check again for new, rotated or moved labels
                 chart.getMargins();
             }
-            redoHorizontal = (tempWidth / chart.plotWidth) > (run ? 1 : 1.1);
-            redoVertical = (tempHeight / chart.plotHeight) > (run ? 1 : 1.05);
+            redoHorizontal = (tempWidth / chart.plotWidth) >
+                (run ? 1 : threshold[1]);
+            redoVertical = (tempHeight / chart.plotHeight) >
+                (run ? 1 : threshold[0]);
             run++;
         }
         // Draw the borders and backgrounds
@@ -1973,7 +1975,7 @@ class Chart {
         chart.render();
         chart.pointer?.getChartPosition(); // #14973
         // Fire the load event if there are no external images
-        if (!chart.renderer.imgCount && !chart.hasLoaded) {
+        if (!chart.renderer.asyncCounter && !chart.hasLoaded) {
             chart.onload();
         }
         // If the chart was rendered outside the top container, put it back in
@@ -2199,13 +2201,13 @@ class Chart {
      *        [lang.loading](https://api.highcharts.com/highcharts/lang.loading).
      */
     showLoading(str) {
-        const chart = this, options = chart.options, loadingOptions = options.loading, setLoadingSize = function () {
+        const chart = this, options = chart.options, loadingOptions = options.loading, loadingStyle = loadingOptions?.style ?? {}, setLoadingSize = function () {
             if (loadingDiv) {
                 css(loadingDiv, {
-                    left: chart.plotLeft + 'px',
-                    top: chart.plotTop + 'px',
-                    width: chart.plotWidth + 'px',
-                    height: chart.plotHeight + 'px'
+                    left: loadingStyle.left ?? chart.plotLeft + 'px',
+                    top: loadingStyle.top ?? chart.plotTop + 'px',
+                    width: loadingStyle.width ?? chart.plotWidth + 'px',
+                    height: loadingStyle.height ?? chart.plotHeight + 'px'
                 });
             }
         };
@@ -2225,10 +2227,8 @@ class Chart {
         AST.setElementHTML(loadingSpan, pick(str, options.lang.loading, ''));
         if (!chart.styledMode) {
             // Update visuals
-            css(loadingDiv, extend(loadingOptions.style, {
-                zIndex: 10
-            }));
-            css(loadingSpan, loadingOptions.labelStyle);
+            css(loadingDiv, extend(loadingStyle, { zIndex: 10 }));
+            css(loadingSpan, loadingOptions?.labelStyle ?? {});
             // Show it
             if (!chart.loadingShown) {
                 css(loadingDiv, {
@@ -2236,9 +2236,9 @@ class Chart {
                     display: ''
                 });
                 animate(loadingDiv, {
-                    opacity: loadingOptions.style.opacity || 0.5
+                    opacity: loadingStyle.opacity ?? 0.5
                 }, {
-                    duration: loadingOptions.showDuration || 0
+                    duration: loadingOptions?.showDuration ?? 0
                 });
             }
         }
@@ -2266,7 +2266,7 @@ class Chart {
                 animate(loadingDiv, {
                     opacity: 0
                 }, {
-                    duration: options.loading.hideDuration || 100,
+                    duration: options.loading?.hideDuration ?? 100,
                     complete: function () {
                         css(loadingDiv, { display: 'none' });
                     }
@@ -2435,9 +2435,12 @@ class Chart {
         // update the first series in the chart. Setting two series without
         // an id will update the first and the second respectively (#6019)
         // chart.update and responsive.
-        this.collectionsWithUpdate.forEach(function (coll) {
+        this.collectionsWithUpdate.forEach((coll) => {
             if (options[coll]) {
-                splat(options[coll]).forEach(function (newOptions, i) {
+                splat(options[coll]).forEach((newOptions, i) => {
+                    if (!newOptions) {
+                        return;
+                    }
                     const hasId = defined(newOptions.id);
                     let item;
                     // Match by id
@@ -2476,7 +2479,7 @@ class Chart {
                 });
                 // Add items for removal
                 if (oneToOne) {
-                    chart[coll].forEach(function (item) {
+                    chart[coll].forEach((item) => {
                         if (!item.touched && !item.options.isInternal) {
                             itemsForRemoval.push(item);
                         }
@@ -2487,7 +2490,7 @@ class Chart {
                 }
             }
         });
-        itemsForRemoval.forEach(function (item) {
+        itemsForRemoval.forEach((item) => {
             if (item.chart && item.remove) { // #9097, avoid removing twice
                 item.remove(false);
             }
@@ -2930,6 +2933,10 @@ export default Chart;
  *        The thousands separator, defaults to the one given in the lang
  *        options, or a space character.
  *
+ * @param {Highcharts.Chart} [ctx]
+ *        Since v12.5.0, the chart context passed as an extra argument for
+ *        arrow functions.
+ *
  * @return {string} The formatted number.
  */
 /**

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

@@ -17,8 +17,7 @@ import D from '../Defaults.js';
 const { defaultOptions: genericDefaultOptions } = D;
 import Math3D from '../Math3D.js';
 const { perspective, shapeArea3D } = Math3D;
-import U from '../Utilities.js';
-const { addEvent, isArray, merge, pick, wrap } = U;
+import { addEvent, isArray, merge, pick, wrap } from '../../Shared/Utilities.js';
 /* *
  *
  *  Composition

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

@@ -386,6 +386,9 @@ const ChartDefaults = {
     /**
      * Callback function to override the default function that formats all
      * the numbers in the chart. Returns a string with the formatted number.
+     * Since v12.5.0, the callback also receives `ctx` as the last argument,
+     * so that arrow functions can access the same context as regular
+     * functions using `this`.
      *
      * @sample highcharts/members/highcharts-numberformat
      *      Arabic digits in Highcharts
@@ -439,6 +442,10 @@ const ChartDefaults = {
      * requires two fingers. To allow panning with one finger, set
      * `followTouchMove` to `false`.
      *
+     * **Note:** If both zooming and panning are enabled without keys, zooming
+     * will take precedence by default. To prioritize panning, either set
+     * [chart.zooming.key](#chart.zooming.key) or panKey.
+     *
      * @sample  {highcharts} highcharts/chart/pankey/ Zooming and panning
      * @sample  {highstock} stock/chart/panning/ Zooming and xy panning
      */
@@ -1048,6 +1055,10 @@ const ChartDefaults = {
          * avoid zooming while moving points. Should be set different than
          * [chart.panKey](#chart.panKey).
          *
+         * **Note:** If both zooming and panning are enabled without keys,
+         * zooming will take precedence by default. To prioritize panning,
+         * either set zooming key or [chart.panKey](#chart.panKey).
+         *
          * @type       {string}
          * @default    {highcharts} undefined
          * @validvalue ["alt", "ctrl", "meta", "shift"]

package/es-modules/Core/Chart/ChartOptions.d.ts

@@ -598,6 +598,10 @@ export interface ChartOptions {
      * requires two fingers. To allow panning with one finger, set
      * `followTouchMove` to `false`.
      *
+     * **Note:** If both zooming and panning are enabled without keys, zooming
+     * will take precedence by default. To prioritize panning, either set
+     * [chart.zooming.key](#chart.zooming.key) or panKey.
+     *
      * @sample  {highcharts} highcharts/chart/pankey/
      *          Zooming and panning
      * @sample  {highstock} stock/chart/panning/
@@ -1160,6 +1164,10 @@ export interface ChartZoomingOptions {
      * avoid zooming while moving points. Should be set different than
      * [chart.panKey](#chart.panKey).
      *
+     * **Note:** If both zooming and panning are enabled without keys, zooming
+     * will take precedence by default. To prioritize panning, either set
+     * zooming key or [chart.panKey](#chart.panKey).
+     *
      * @default    {highcharts} undefined
      * @validvalue ["alt", "ctrl", "meta", "shift"]
      * @requires   modules/draggable-points

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

@@ -13,8 +13,7 @@
 import Chart from './Chart.js';
 import D from '../Defaults.js';
 const { defaultOptions } = D;
-import U from '../Utilities.js';
-const { isArray, merge, splat } = U;
+import { isArray, merge, splat } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class

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

@@ -13,9 +13,8 @@ import Chart from './Chart.js';
 import D from '../Defaults.js';
 const { getOptions } = D;
 import SVGRenderer from '../Renderer/SVG/SVGRenderer.js';
-import U from '../Utilities.js';
-const { isNumber, merge, pick } = U;
 import '../../Maps/MapSymbols.js';
+import { isNumber, merge, pick } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class

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

@@ -19,8 +19,7 @@ import RangeSelectorDefaults from '../../Stock/RangeSelector/RangeSelectorDefaul
 import ScrollbarDefaults from '../../Stock/Scrollbar/ScrollbarDefaults.js';
 import StockUtilities from '../../Stock/Utilities/StockUtilities.js';
 const { setFixedRange } = StockUtilities;
-import U from '../Utilities.js';
-const { addEvent, clamp, crisp, defined, extend, find, isNumber, isString, merge, pick, splat } = U;
+import { addEvent, clamp, crisp, defined, extend, find, isNumber, isString, merge, pick, splat } from '../../Shared/Utilities.js';
 /* *
  *
  *  Functions
@@ -339,7 +338,7 @@ addEvent(Chart, 'update', function (e) {
             text = format(formatOption, { value }, chart);
         }
         else if (options.formatter && isNumber(value)) {
-            text = options.formatter.call(axis, value);
+            text = options.formatter.call(axis, value, axis);
         }
         crossLabel.attr({
             text,

package/es-modules/Core/Color/Color.js

@@ -11,8 +11,7 @@
 'use strict';
 import H from '../Globals.js';
 const { win } = H;
-import U from '../Utilities.js';
-const { isNumber, isString, merge, pInt, defined } = U;
+import { defined, isNumber, isString, merge, pInt } from '../../Shared/Utilities.js';
 /* *
  *
  *  Helpers

package/es-modules/Core/Defaults.js

@@ -14,8 +14,7 @@ import H from './Globals.js';
 const { isTouchDevice } = H;
 import Palettes from './Color/Palettes.js';
 import Time from './Time.js';
-import U from './Utilities.js';
-const { fireEvent, merge } = U;
+import { fireEvent, merge } from '../Shared/Utilities.js';
 /* *
  *
  *  API Options
@@ -990,6 +989,9 @@ const defaultOptions = {
          * columns. Setting this to `false` makes room for more items, but will
          * look more messy.
          *
+         * @sample highcharts/legend/aligncolumns
+         *         Align columns
+         *
          * @since 6.1.0
          */
         alignColumns: true,
@@ -1120,6 +1122,9 @@ const defaultOptions = {
          * for each legend label. Available variables relates to properties on
          * the series, or the point in case of pies.
          *
+         * @sample {highcharts} highcharts/legend/labelformat/
+         *         Add text
+         *
          * @type      {string}
          * @default   {name}
          * @since     1.3
@@ -1129,7 +1134,10 @@ const defaultOptions = {
         /**
          * Callback function to format each of the series' labels. The `this`
          * keyword refers to the series object, or the point object in case of
-         * pie charts. By default the series or point name is printed.
+         * pie charts. By default the series or point name is printed. Since
+         * v12.5.0, the callback also receives `ctx` as the first argument, so
+         * that arrow functions can access the same context as regular
+         * functions using `this`.
          *
          * @productdesc {highmaps}
          * In Highmaps the context can also be a data class in case of a
@@ -2025,13 +2033,18 @@ const defaultOptions = {
          * @sample {highmaps} maps/tooltip/formatter/
          *         String formatting
          *
+         * Since v12.5.0, the callback also receives `ctx` as the second
+         * argument, so that arrow functions can access the same context as
+         * regular functions using `this`.
+         *
          * @type      {Highcharts.TooltipFormatterCallbackFunction}
          * @apioption tooltip.formatter
          */
         /**
          * Callback function to format the text of the tooltip for
          * visible null points.
-         * Works analogously to [formatter](#tooltip.formatter).
+         * Works analogously to [formatter](#tooltip.formatter), including the
+         * `ctx` callback argument added in v12.5.0.
          *
          * @sample highcharts/plotoptions/series-nullformat
          *         Format data label and tooltip for null point.
@@ -2065,7 +2078,9 @@ const defaultOptions = {
         /**
          * A callback function for formatting the HTML output for a single point
          * in the tooltip. Like the `pointFormat` string, but with more
-         * flexibility.
+         * flexibility. Since v12.5.0, the callback also receives `ctx` as the
+         * first argument, so that arrow functions can access the same context
+         * as regular functions using `this`.
          *
          * @type      {Highcharts.FormatterCallbackFunction<Highcharts.Point>}
          * @since     4.1.0
@@ -2074,10 +2089,13 @@ const defaultOptions = {
          */
         /**
          * A callback function to place the tooltip in a custom position. The
-         * callback receives three parameters: `labelWidth`, `labelHeight` and
-         * `point`, where point contains values for `plotX` and `plotY` telling
-         * where the reference point is in the plot area. Add `chart.plotLeft`
-         * and `chart.plotTop` to get the full coordinates.
+         * callback receives four parameters: `labelWidth`, `labelHeight`,
+         * `point`, and `ctx`, where point contains values for `plotX` and
+         * `plotY` telling where the reference point is in the plot area, and
+         * `ctx` is the tooltip context (so that arrow-functions can access the
+         * same context as a normal function using `this`). Add
+         * `chart.plotLeft` and `chart.plotTop` to get the full coordinates.
+         * Since v12.5.0, the callback receives `ctx`.
          *
          * To find the actual hovered `Point` instance, use
          * `this.chart.hoverPoint`. For shared or split tooltips, all the hover
@@ -2301,6 +2319,15 @@ const defaultOptions = {
          * @since 3.0
          */
         hideDelay: 500,
+        /**
+         * The number of milliseconds to wait until the tooltip is shown when
+         * mouse over a point. Works on initial hover.
+         *
+         * @sample {highcharts|highstock} highcharts/tooltip/showdelay/
+         *
+         * @since next
+         */
+        showDelay: 0,
         /**
          * Padding inside the tooltip, in pixels.
          *

package/es-modules/Core/Delaunay.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Delaunay triangulation of a 2D point set.
+ */
+declare class Delaunay<T extends Float32Array | Float64Array = Float32Array> {
+    /**
+     * The resulting triangulation as a flat array of triangle vertex indices.
+     */
+    readonly triangles: Uint32Array;
+    /**
+     * The input points array.
+     */
+    readonly points: T;
+    /**
+     * Sorted and deduplicated point indices used for triangulation.
+     */
+    private readonly ids;
+    /**
+     * Numerical tolerance for geometric predicates.
+     */
+    private readonly epsilon;
+    /**
+     * Minimum X value used for normalization.
+     */
+    private readonly minX;
+    /**
+     * Minimum Y value used for normalization.
+     */
+    private readonly minY;
+    /**
+     * Inverse X scale factor used for normalization.
+     */
+    private readonly invScaleX;
+    /**
+     * Inverse Y scale factor used for normalization.
+     */
+    private readonly invScaleY;
+    /**
+     * Create a new Delaunay triangulation.
+     *
+     * @param {Float32Array|Float64Array} points
+     * A 1D array of points in the format [x0, y0, x1, y1, ...].
+     */
+    constructor(points: T);
+    /**
+     * Triangulate the points.
+     *
+     * @return {Uint32Array}
+     * A 1D array of triangle vertex indices.
+     */
+    private triangulate;
+}
+export default Delaunay;