@highcharts/grid-pro 2.1.1 → 2.3.0

package/es-modules/Core/Pointer.js

@@ -1,10 +1,11 @@
 /* *
  *
- *  (c) 2010-2025 Torstein Honsi
+ *  (c) 2010-2026 Highsoft AS
+ *  Author: Torstein Honsi
  *
- *  License: www.highcharts.com/license
+ *  A commercial license may be required depending on use.
+ *  See www.highcharts.com/license
  *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  *
  * */
 'use strict';
@@ -12,8 +13,25 @@ import Color from './Color/Color.js';
 const { parse: color } = Color;
 import H from './Globals.js';
 const { charts, composed, isTouchDevice } = H;
-import U from './Utilities.js';
-const { addEvent, attr, css, extend, find, fireEvent, isNumber, isObject, objectEach, offset, pick, pushUnique, splat } = U;
+import { addEvent, attr, css, defined, extend, find, fireEvent, isNumber, isObject, objectEach, offset, pick, pushUnique, splat } from '../Shared/Utilities.js';
+/**
+ *
+ *  Functions
+ *
+ */
+/**
+ * Check whether the configured action key allows the interaction.
+ *
+ * @internal
+ * @param {Event} e
+ *        A mouse event.
+ * @param {string | undefined} key
+ *        Zoom or pan key.
+ * @return {boolean}
+ *         True if the key is undefined
+ *         or if the action key is pressed. False otherwise.
+ */
+const checkActionKey = (e, key) => !defined(key) || e[`${key}Key`];
 /* *
  *
  *  Class
@@ -45,7 +63,7 @@ class Pointer {
      * or, if `inactiveOtherPoints` is set to true, set inactive state to
      * all points within that series.
      *
-     * @private
+     * @internal
      * @function Highcharts.Pointer#applyInactiveState
      *
      * @param {Array<Highcharts.Point>} points
@@ -112,7 +130,7 @@ class Pointer {
     }
     /**
      * Calculate attrs for selection marker.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#getSelectionMarkerAttrs
      * @emits getSelectionMarkerAttrs
      */
@@ -149,7 +167,7 @@ class Pointer {
     /**
      * Perform a drag operation in response to a mousemove event while the mouse
      * is down.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#drag
      */
     drag(e) {
@@ -211,14 +229,15 @@ class Pointer {
                 selectionMarker.attr(attrs);
             }
             // Panning
-            if (clickedInside && !selectionMarker && panningEnabled) {
+            if (clickedInside && !selectionMarker && panningEnabled &&
+                (checkActionKey(e, panKey))) {
                 chart.pan(e, panning);
             }
         }
     }
     /**
      * Start a drag operation.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#dragStart
      */
     dragStart(e) {
@@ -231,7 +250,7 @@ class Pointer {
     }
     /**
      * Get selection box to calculate extremes
-     * @private
+     * @internal
      * @function Highcharts.Pointer#getSelectionBox
      * @emits getSelectionBox
      */
@@ -245,7 +264,7 @@ class Pointer {
     }
     /**
      * On mouse up or touch end across the entire document, drop the selection.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#drop
      */
     drop(e) {
@@ -322,7 +341,7 @@ class Pointer {
      */
     findNearestKDPoint(series, shared, e) {
         let closest;
-        /** @private */
+        /** @internal */
         function sort(p1, p2) {
             const isCloserX = p1.distX - p2.distX, isCloser = p1.dist - p2.dist, isAbove = (p2.series.group?.zIndex -
                 p1.series.group?.zIndex);
@@ -362,10 +381,7 @@ class Pointer {
         });
         return closest;
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#getChartCoordinatesFromPoint
-     */
+    /** @internal */
     getChartCoordinatesFromPoint(point, inverted) {
         const { xAxis, yAxis } = point.series, shapeArgs = point.shapeArgs;
         if (xAxis && yAxis) {
@@ -453,7 +469,7 @@ class Pointer {
     /**
      * Calculates what is the current hovered point/points and series.
      *
-     * @private
+     * @internal
      * @function Highcharts.Pointer#getHoverData
      *
      * @param {Highcharts.Point|undefined} existingHoverPoint
@@ -548,10 +564,7 @@ class Pointer {
             hoverPoints: hoverPoints
         };
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#getPointFromEvent
-     */
+    /** @internal */
     getPointFromEvent(e) {
         let target = e.target, point;
         while (target && !point) {
@@ -560,10 +573,7 @@ class Pointer {
         }
         return point;
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#onTrackerMouseOut
-     */
+    /** @internal */
     onTrackerMouseOut(e) {
         const chart = this.chart;
         const relatedTarget = e.relatedTarget;
@@ -613,7 +623,7 @@ class Pointer {
     /**
      * Initialize the Pointer.
      *
-     * @private
+     * @internal
      * @function Highcharts.Pointer#init
      *
      * @param {Highcharts.Chart} chart
@@ -624,8 +634,21 @@ class Pointer {
      * tooltip structures.
      */
     constructor(chart, options) {
+        /**
+         * The distance by which the mouse has been dragged since the last
+         * `mousedown` event.
+         * @internal
+         */
         this.hasDragged = 0;
+        /**
+         * A list of events to unbind when the pointer is destroyed.
+         * @internal
+         */
         this.pointerCaptureEventsToUnbind = [];
+        /**
+         * A list of events to unbind when the pointer is destroyed.
+         * @internal
+         */
         this.eventsToUnbind = [];
         // Store references
         this.options = options;
@@ -678,10 +701,7 @@ class Pointer {
             chartY: Math.round(chartY)
         });
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#onContainerClick
-     */
+    /** @internal */
     onContainerClick(e) {
         const chart = this.chart;
         const hoverPoint = chart.hoverPoint;
@@ -713,10 +733,7 @@ class Pointer {
             }
         }
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#onContainerMouseDown
-     */
+    /** @internal */
     onContainerMouseDown(e) {
         const isPrimaryButton = ((e.buttons || e.button) & 1) === 1;
         e = this.normalize(e);
@@ -738,7 +755,7 @@ class Pointer {
     }
     /**
      * When mouse leaves the container, hide the tooltip.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#onContainerMouseLeave
      */
     onContainerMouseLeave(e) {
@@ -755,7 +772,7 @@ class Pointer {
     }
     /**
      * When mouse enters the container, delete pointer's chartPosition.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#onContainerMouseEnter
      */
     onContainerMouseEnter() {
@@ -763,7 +780,7 @@ class Pointer {
     }
     /**
      * The mousemove, touchmove and touchstart event handler
-     * @private
+     * @internal
      * @function Highcharts.Pointer#onContainerMouseMove
      */
     onContainerMouseMove(e) {
@@ -790,17 +807,11 @@ class Pointer {
             }
         }
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#onDocumentTouchEnd
-     */
+    /** @internal */
     onDocumentTouchEnd(e) {
         this.onDocumentMouseUp(e);
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#onContainerTouchMove
-     */
+    /** @internal */
     onContainerTouchMove(e) {
         if (this.touchSelect(e)) {
             this.onContainerMouseMove(e);
@@ -809,10 +820,7 @@ class Pointer {
             this.touch(e);
         }
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#onContainerTouchStart
-     */
+    /** @internal */
     onContainerTouchStart(e) {
         if (this.touchSelect(e)) {
             this.onContainerMouseDown(e);
@@ -826,7 +834,7 @@ class Pointer {
      * Special handler for mouse move that will hide the tooltip when the mouse
      * leaves the plotarea. Issue #149 workaround. The mouseleave event does not
      * always fire.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#onDocumentMouseMove
      */
     onDocumentMouseMove(e) {
@@ -844,10 +852,7 @@ class Pointer {
             this.reset();
         }
     }
-    /**
-     * @private
-     * @function Highcharts.Pointer#onDocumentMouseUp
-     */
+    /** @internal */
     onDocumentMouseUp(e) {
         // #17852, IOS devices sometimes reverts back to previous point when
         // dragging between points
@@ -860,7 +865,7 @@ class Pointer {
     }
     /**
      * Handle touch events with two touches
-     * @private
+     * @internal
      * @function Highcharts.Pointer#pinch
      */
     pinch(e) {
@@ -934,7 +939,7 @@ class Pointer {
     }
     /**
      * Run translation operations
-     * @private
+     * @internal
      * @function Highcharts.Pointer#pinchTranslate
      * /
     public pinchTranslate(
@@ -972,7 +977,7 @@ class Pointer {
     /**
      * Run translation operations for each direction (horizontal and vertical)
      * independently.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#pinchTranslateDirection
      * /
     public pinchTranslateDirection(
@@ -1161,7 +1166,7 @@ class Pointer {
      * With line type charts with a single tracker, get the point closest to the
      * mouse. Run Point.onMouseOver and display tooltip for the point or points.
      *
-     * @private
+     * @internal
      * @function Highcharts.Pointer#runPointActions
      *
      * @emits Highcharts.Point#event:mouseOut
@@ -1283,7 +1288,7 @@ class Pointer {
      * contain a one-to-one assignment between methods and their handlers. Any
      * advanced logic should be moved to the handler reflecting the event's
      * name.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#setDOMEvents
      */
     setDOMEvents() {
@@ -1320,7 +1325,7 @@ class Pointer {
      * Sets, or removes on update, pointer events using pointer capture for
      * tooltip.followTouchMove if any series has findNearestPointBy that
      * includes the y dimension.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#setPointerCapture
     */
     setPointerCapture() {
@@ -1365,7 +1370,7 @@ class Pointer {
     /**
      * Sets the index of the hovered chart and leaves the previous hovered
      * chart, to reset states like tooltip.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#setHoverChartIndex
      */
     setHoverChartIndex(e) {
@@ -1387,7 +1392,7 @@ class Pointer {
     }
     /**
      * General touch handler shared by touchstart and touchmove.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#touch
      */
     touch(e, start) {
@@ -1432,7 +1437,7 @@ class Pointer {
     /**
      * Returns true if the chart is set up for zooming by single touch and the
      * event is capable
-     * @private
+     * @internal
      * @function Highcharts.Pointer#touchSelect
      */
     touchSelect(e) {
@@ -1443,7 +1448,7 @@ class Pointer {
     /**
      * Resolve the zoomType option, this is reset on all touch start and mouse
      * down events.
-     * @private
+     * @internal
      * @function Highcharts.Pointer#zoomOption
      */
     zoomOption(e) {
@@ -1457,9 +1462,11 @@ class Pointer {
         this.zoomY = zoomY = /y/.test(zoomType);
         this.zoomHor = (zoomX && !inverted) || (zoomY && inverted);
         this.zoomVert = (zoomY && !inverted) || (zoomX && inverted);
-        this.hasZoom = zoomX || zoomY;
+        this.hasZoom = (zoomX || zoomY) &&
+            (checkActionKey(e, chart.zooming.key));
     }
 }
+/** @internal */
 Pointer.unbindDocumentMouseUp = [];
 /* *
  *
@@ -1477,9 +1484,7 @@ Pointer.unbindDocumentMouseUp = [];
      *  Functions
      *
      * */
-    /**
-     * @private
-     */
+    /** @internal */
     function compose(ChartClass) {
         if (pushUnique(composed, 'Core.Pointer')) {
             addEvent(ChartClass, 'beforeRender', function () {

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

@@ -0,0 +1,20 @@
+import type Point from './Series/Point';
+import type Pointer from './Pointer';
+/**
+ * A native browser mouse or touch event, extended with position information
+ * relative to the `Highcharts.Chart.container`.
+ */
+export interface PointerEvent extends globalThis.PointerEvent {
+    accumulate?: boolean;
+    chartX: number;
+    chartY: number;
+    DOMType?: string;
+    lat?: number;
+    lon?: number;
+    point?: Point;
+    touches?: Array<Touch>;
+    trigger?: string;
+    xAxis?: Array<Pointer.AxisCoordinateObject>;
+    yAxis?: Array<Pointer.AxisCoordinateObject>;
+}
+export default PointerEvent;

package/es-modules/Core/PointerEvent.js

@@ -0,0 +1,11 @@
+/* *
+ *
+ *  (c) 2010-2026 Highsoft AS
+ *  Author: Torstein Honsi
+ *
+ *  A commercial license may be required depending on use.
+ *  See www.highcharts.com/license
+ *
+ *
+ * */
+export {};

package/es-modules/Core/Renderer/AlignObject.d.ts

@@ -1,37 +1,35 @@
-/* *
- *
- *  (c) 2010-2025 Torstein Honsi
- *
- *  License: www.highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-
-/* *
- *
- *  Declarations
- *
- * */
-
-export type AlignValue = ('center'|'left'|'right');
-
-export type VerticalAlignValue = ('bottom'|'middle'|'top');
-
+export type AlignValue = ('center' | 'left' | 'right');
+export type VerticalAlignValue = ('bottom' | 'middle' | 'top');
 export interface AlignObject {
+    /**
+     * Horizontal alignment of the object.
+     * @type {Highcharts.AlignValue}
+     */
     align?: AlignValue;
+    /**
+     * Align element by translation.
+     */
     alignByTranslate?: boolean;
+    /**
+     * Vertical alignment of the object.
+     * @type {Highcharts.VerticalAlignValue}
+     */
     verticalAlign?: VerticalAlignValue;
+    /**
+     * Horizontal offset of the object.
+     */
     x?: number;
+    /**
+     * Vertical offset of the object.
+     */
     y?: number;
+    /**
+     * The width of the object.
+     */
     width?: number;
+    /**
+     * The height of the object.
+     */
     height?: number;
 }
-
-/* *
- *
- *  Default Export
- *
- * */
-
 export default AlignObject;

package/es-modules/Core/Renderer/AlignObject.js

@@ -0,0 +1,11 @@
+/* *
+ *
+ *  (c) 2010-2026 Highsoft AS
+ *  Author: Torstein Honsi
+ *
+ *  A commercial license may be required depending on use.
+ *  See www.highcharts.com/license
+ *
+ *
+ * */
+export {};

package/es-modules/Core/Renderer/BBoxObject.d.ts

@@ -1,40 +1,29 @@
-/* *
- *
- *  (c) 2010-2025 Torstein Honsi
- *
- *  License: www.highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-
-/* *
- *
- *  Imports
- *
- * */
-
 import type PositionObject from './PositionObject';
 import type SizeObject from './SizeObject';
-
-/* *
- *
- *  Declarations
- *
- * */
-
+/**
+ * Bounding box of an element.
+ */
 export interface BBoxObject extends PositionObject, SizeObject {
+    /**
+     * Height of the bounding box.
+     */
     height: number;
+    /**
+     * Width of the bounding box.
+     */
     width: number;
+    /**
+     * Horizontal position of the bounding box.
+     */
     x: number;
+    /**
+     * Vertical position of the bounding box.
+     */
     y: number;
-    polygon?: [number, number][]
+    /**
+     * The polygon of the bounding box, used for more accurate collision
+     * detection.
+     */
+    polygon?: Array<[number, number]>;
 }
-
-/* *
- *
- *  Default Export
- *
- * */
-
 export default BBoxObject;

package/es-modules/Core/Renderer/BBoxObject.js

@@ -0,0 +1,11 @@
+/* *
+ *
+ *  (c) 2010-2026 Highsoft AS
+ *  Author: Torstein Honsi
+ *
+ *  A commercial license may be required depending on use.
+ *  See www.highcharts.com/license
+ *
+ *
+ * */
+export {};