@highcharts/grid-pro 2.1.0 → 2.2.0

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

@@ -1,74 +1 @@
-import type Chart from './Chart/Chart';
-import type Options from './Options';
-import type PointerEvent from './PointerEvent';
-import Pointer from './Pointer.js';
-import DOMElementType from './Renderer/DOMElementType';
-declare global {
-    /** @deprecated */
-    interface MSPointerEvent extends Partial<PointerEvent> {
-        /** @deprecated */
-        readonly MSPOINTER_TYPE_TOUCH: string;
-        readonly currentTarget?: EventTarget;
-        readonly pointerId: number;
-        readonly pointerType?: undefined;
-        /** @deprecated */
-        readonly toElement: Element;
-    }
-    interface Window {
-        /** @deprecated */
-        MSPointerEvent?: Class<MSPointerEvent>;
-    }
-}
-/** @private */
-declare class MSPointer extends Pointer {
-    static isRequired(): boolean;
-    /**
-     * Add or remove the MS Pointer specific events
-     * @private
-     * @function Highcharts.Pointer#batchMSEvents
-     */
-    private batchMSEvents;
-    destroy(): void;
-    constructor(chart: Chart, options: Options);
-    /**
-     * Utility to detect whether an element has, or has a parent with, a
-     * specific class name. Used on detection of tracker objects and on deciding
-     * whether hovering the tooltip should cause the active series to mouse out.
-     *
-     * @function Highcharts.Pointer#inClass
-     *
-     * @param {Highcharts.SVGDOMElement|Highcharts.HTMLDOMElement} element
-     * The element to investigate.
-     *
-     * @param {string} className
-     * The class name to look for.
-     *
-     * @return {boolean|undefined}
-     * True if either the element or one of its parents has the given class
-     * name.
-     */
-    inClass(element: DOMElementType, className: string): (boolean | undefined);
-    /**
-     * @private
-     * @function Highcharts.Pointer#onContainerPointerDown
-     */
-    private onContainerPointerDown;
-    /**
-     * @private
-     * @function Highcharts.Pointer#onContainerPointerMove
-     */
-    private onContainerPointerMove;
-    /**
-     * @private
-     * @function Highcharts.Pointer#onDocumentPointerUp
-     */
-    private onDocumentPointerUp;
-    setDOMEvents(): void;
-}
-declare namespace MSPointer {
-    /**
-     * @private
-     */
-    function compose(ChartClass: typeof Chart): void;
-}
-export default MSPointer;
+export {};

package/es-modules/Core/MSPointer.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';
@@ -27,7 +28,7 @@ const hasPointerEvent = !!win.PointerEvent;
  *
  * */
 /* eslint-disable valid-jsdoc */
-/** @private */
+/** @internal */
 function getWebkitTouches() {
     const fake = [];
     fake.item = function (i) {
@@ -42,7 +43,7 @@ function getWebkitTouches() {
     });
     return fake;
 }
-/** @private */
+/** @internal */
 function translateMSPointer(e, method, wktype, func) {
     const pointer = charts[Pointer.hoverChartIndex ?? -1]?.pointer;
     if (pointer &&
@@ -62,13 +63,22 @@ function translateMSPointer(e, method, wktype, func) {
  *  Class
  *
  * */
-/** @private */
+/** @internal */
 class MSPointer extends Pointer {
     /* *
      *
      *  Static Functions
      *
      * */
+    /**
+     * The isRequired method is required for Highcharts to decide whether to use
+     * this module.
+     *
+     * @internal
+     *
+     * @return {boolean}
+     * Returns true if the module is required.
+     */
     static isRequired() {
         return !!(!win.TouchEvent && (win.PointerEvent || win.MSPointerEvent));
     }
@@ -79,7 +89,7 @@ class MSPointer extends Pointer {
      * */
     /**
      * Add or remove the MS Pointer specific events
-     * @private
+     * @internal
      * @function Highcharts.Pointer#batchMSEvents
      */
     batchMSEvents(fn) {
@@ -144,7 +154,7 @@ class MSPointer extends Pointer {
         }
     }
     /**
-     * @private
+     * @internal
      * @function Highcharts.Pointer#onContainerPointerDown
      */
     onContainerPointerDown(e) {
@@ -157,7 +167,7 @@ class MSPointer extends Pointer {
         });
     }
     /**
-     * @private
+     * @internal
      * @function Highcharts.Pointer#onContainerPointerMove
      */
     onContainerPointerMove(e) {
@@ -169,7 +179,7 @@ class MSPointer extends Pointer {
         });
     }
     /**
-     * @private
+     * @internal
      * @function Highcharts.Pointer#onDocumentPointerUp
      */
     onDocumentPointerUp(e) {
@@ -192,15 +202,14 @@ class MSPointer extends Pointer {
  *  Class Namespace
  *
  * */
+/** @internal */
 (function (MSPointer) {
     /* *
      *
      *  Functions
      *
      * */
-    /**
-     * @private
-     */
+    /** @internal */
     function compose(ChartClass) {
         if (pushUnique(composed, 'Core.MSPointer')) {
             addEvent(ChartClass, 'beforeRender', function () {
@@ -215,4 +224,5 @@ class MSPointer extends Pointer {
  *  Default Export
  *
  * */
+/** @internal */
 export default MSPointer;

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

@@ -1,117 +1 @@
-import type Chart from './Chart/Chart';
-import type Position3DObject from './Renderer/Position3DObject';
-import type PositionObject from './Renderer/PositionObject';
-declare module './Chart/ChartBase' {
-    interface ChartBase {
-        scale3d?: number;
-    }
-}
-/**
- * Transforms a given array of points according to the angles in chart.options.
- *
- * @private
- * @function Highcharts.perspective
- *
- * @param {Array<Highcharts.Position3DObject>} points
- * The array of points
- *
- * @param {Highcharts.Chart} chart
- * The chart
- *
- * @param {boolean} [insidePlotArea]
- * Whether to verify that the points are inside the plotArea
- *
- * @param {boolean} [useInvertedPersp]
- * Whether to use inverted perspective in calculations
- *
- * @return {Array<Highcharts.Position3DObject>}
- * An array of transformed points
- *
- * @requires highcharts-3d
- */
-declare function perspective(points: Array<Position3DObject>, chart: Chart, insidePlotArea?: boolean, useInvertedPersp?: boolean): Array<Position3DObject>;
-/**
- * Perspective3D function is available in global Highcharts scope because is
- * needed also outside of perspective() function (#8042).
- * @private
- * @function Highcharts.perspective3D
- *
- * @param {Highcharts.Position3DObject} coordinate
- * 3D position
- *
- * @param {Highcharts.Position3DObject} origin
- * 3D root position
- *
- * @param {number} distance
- * Perspective distance
- *
- * @return {Highcharts.PositionObject}
- * Perspective 3D Position
- *
- * @requires highcharts-3d
- */
-declare function perspective3D(coordinate: Position3DObject, origin: Position3DObject, distance: number): PositionObject;
-/**
- * Calculate a distance from camera to points - made for calculating zIndex of
- * scatter points.
- *
- * @private
- * @function Highcharts.pointCameraDistance
- *
- * @param {Highcharts.Dictionary<number>} coordinates
- * Coordinates of the specific point
- *
- * @param {Highcharts.Chart} chart
- * Related chart
- *
- * @return {number}
- * Distance from camera to point
- *
- * @requires highcharts-3d
- */
-declare function pointCameraDistance(coordinates: Record<string, number>, chart: Chart): number;
-/**
- * Calculate area of a 2D polygon using Shoelace algorithm
- * https://en.wikipedia.org/wiki/Shoelace_formula
- *
- * @private
- * @function Highcharts.shapeArea
- *
- * @param {Array<Highcharts.PositionObject>} vertexes
- * 2D Polygon
- *
- * @return {number}
- * Calculated area
- *
- * @requires highcharts-3d
- */
-declare function shapeArea(vertexes: Array<PositionObject>): number;
-/**
- * Calculate area of a 3D polygon after perspective projection
- *
- * @private
- * @function Highcharts.shapeArea3d
- *
- * @param {Array<Highcharts.Position3DObject>} vertexes
- * 3D Polygon
- *
- * @param {Highcharts.Chart} chart
- * Related chart
- *
- * @param {boolean} [insidePlotArea]
- * Whether to verify that the points are inside the plotArea
- *
- * @return {number}
- * Calculated area
- *
- * @requires highcharts-3d
- */
-declare function shapeArea3D(vertexes: Array<Position3DObject>, chart: Chart, insidePlotArea?: boolean): number;
-declare const Math3D: {
-    perspective: typeof perspective;
-    perspective3D: typeof perspective3D;
-    pointCameraDistance: typeof pointCameraDistance;
-    shapeArea: typeof shapeArea;
-    shapeArea3D: typeof shapeArea3D;
-};
-export default Math3D;
+export {};

package/es-modules/Core/Math3D.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';
@@ -42,13 +43,13 @@ const { pick } = U;
  * | - sinA * sinB |  cosA  | - sinA * cosB |  x  | y |  =  | py |
  * |  cosA * sinB  |  sinA  |  cosA * cosB  |     | z |     | pz |
  *
- * @private
+ * @internal
  * @function rotate3D
  */
 /* eslint-enable max-len */
 /**
  * Rotates the position as defined in angles.
- * @private
+ * @internal
  * @param {number} x
  *        X coordinate
  * @param {number} y
@@ -72,7 +73,7 @@ function rotate3D(x, y, z, angles) {
 /**
  * Transforms a given array of points according to the angles in chart.options.
  *
- * @private
+ * @internal
  * @function Highcharts.perspective
  *
  * @param {Array<Highcharts.Position3DObject>} points
@@ -131,7 +132,7 @@ function perspective(points, chart, insidePlotArea, useInvertedPersp) {
 /**
  * Perspective3D function is available in global Highcharts scope because is
  * needed also outside of perspective() function (#8042).
- * @private
+ * @internal
  * @function Highcharts.perspective3D
  *
  * @param {Highcharts.Position3DObject} coordinate
@@ -162,7 +163,7 @@ function perspective3D(coordinate, origin, distance) {
  * Calculate a distance from camera to points - made for calculating zIndex of
  * scatter points.
  *
- * @private
+ * @internal
  * @function Highcharts.pointCameraDistance
  *
  * @param {Highcharts.Dictionary<number>} coordinates
@@ -193,7 +194,7 @@ function pointCameraDistance(coordinates, chart) {
  * Calculate area of a 2D polygon using Shoelace algorithm
  * https://en.wikipedia.org/wiki/Shoelace_formula
  *
- * @private
+ * @internal
  * @function Highcharts.shapeArea
  *
  * @param {Array<Highcharts.PositionObject>} vertexes
@@ -215,7 +216,7 @@ function shapeArea(vertexes) {
 /**
  * Calculate area of a 3D polygon after perspective projection
  *
- * @private
+ * @internal
  * @function Highcharts.shapeArea3d
  *
  * @param {Array<Highcharts.Position3DObject>} vertexes
@@ -240,6 +241,7 @@ function shapeArea3D(vertexes, chart, insidePlotArea) {
  *  Default Export
  *
  * */
+/** @internal */
 const Math3D = {
     perspective,
     perspective3D,
@@ -247,4 +249,5 @@ const Math3D = {
     shapeArea,
     shapeArea3D
 };
+/** @internal */
 export default Math3D;