@highcharts/grid-pro 2.1.1 → 2.3.0

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

@@ -1,276 +1,166 @@
 import type ColorType from '../Color/ColorType';
-import type Position3DObject from '../Renderer/Position3DObject';
-import type SVGElement3D from '../Renderer/SVG/SVGElement3D';
-import Chart from './Chart.js';
-import Fx from '../Animation/Fx.js';
-import Series from '../Series/Series.js';
-declare module '../Animation/FxBase' {
-    interface FxBase {
-        matrixSetter?(): void;
-    }
-}
 declare module '../Chart/ChartBase' {
     interface ChartBase {
-        chart3d?: Chart3D.Additions;
-        frameShapes?: Record<string, SVGElement3D>;
         is3d(): boolean;
     }
 }
 declare module '../Chart/ChartOptions' {
     interface ChartOptions {
+        /**
+         * Options to render charts in 3 dimensions. This feature requires
+         * `highcharts-3d.js`, found in the download package or online at
+         * [code.highcharts.com/highcharts-3d.js](https://code.highcharts.com/highcharts-3d.js).
+         *
+         * @since    4.0
+         * @product  highcharts
+         * @requires highcharts-3d
+         */
         options3d?: ChartOptions3D;
     }
 }
+/**
+ * Options to render charts in 3 dimensions. This feature requires
+ * `highcharts-3d.js`, found in the download package or online at
+ * [code.highcharts.com/highcharts-3d.js](https://code.highcharts.com/highcharts-3d.js).
+ *
+ * @since    4.0
+ * @product  highcharts
+ * @requires highcharts-3d
+ */
 interface ChartOptions3D {
+    /**
+     * One of the two rotation angles for the chart.
+     *
+     * @since   4.0
+     * @product highcharts
+     */
     alpha?: number;
     axisLabelPosition?: ('auto' | null);
+    /**
+     * One of the two rotation angles for the chart.
+     *
+     * @since   4.0
+     * @product highcharts
+     */
     beta?: number;
+    /**
+     * The total depth of the chart.
+     *
+     * @since   4.0
+     * @product highcharts
+     */
     depth?: number;
+    /**
+     * Whether to render the chart using the 3D functionality.
+     *
+     * @since   4.0
+     * @product highcharts
+     */
     enabled?: boolean;
+    /**
+     * Whether the 3d box should automatically adjust to the chart
+     * plot area.
+     *
+     * @since   4.2.4
+     * @product highcharts
+     */
     fitToPlot?: boolean;
+    /**
+     * Provides the option to draw a frame around the charts by
+     * defining a bottom, front and back panel.
+     *
+     * @since    4.0
+     * @product  highcharts
+     * @requires highcharts-3d
+     */
     frame?: Chart3D.FrameOptions;
     viewDistance?: number;
 }
 declare namespace Chart3D {
-    interface Composition extends Chart {
-        chart3d: Additions;
-    }
-    interface Edge3DObject extends Position3DObject {
-        xDir: Position3DObject;
-    }
-    interface FrameObject extends FrameOptions {
-        axes: Record<string, Record<string, (Edge3DObject | null)>>;
-        back: FrameSideObject;
-        bottom: FrameSideObject;
-        front: FrameSideObject;
-        left: FrameSideObject;
-        right: FrameSideObject;
-        top: FrameSideObject;
-    }
+    /**
+     * Provides the option to draw a frame around the charts by
+     * defining a bottom, front and back panel.
+     *
+     * @since    4.0
+     * @product  highcharts
+     * @requires highcharts-3d
+     */
     interface FrameOptions {
+        /**
+         * The back side of the frame around a 3D chart.
+         */
         back?: FrameSideOptions;
+        /**
+         * The bottom of the frame around a 3D chart.
+         */
         bottom?: FrameSideOptions;
+        /**
+         * The front of the frame around a 3D chart.
+         */
         front?: FrameSideOptions;
+        /**
+         * The left side of the frame around a 3D chart.
+         */
         left?: FrameSideOptions;
+        /**
+         * The right of the frame around a 3D chart.
+         */
         right?: FrameSideOptions;
+        /**
+         * General pixel thickness for the frame faces.
+         */
         size?: number;
+        /**
+         * The top of the frame around a 3D chart.
+         */
         top?: FrameSideOptions;
+        /**
+         * Whether the frames are visible.
+         *
+         * @default default
+         */
         visible?: string;
     }
-    interface FrameSideObject extends FrameSideOptions {
-        frontFacing: boolean;
-        size: number;
-    }
-    interface FrameSideOptions {
-        color?: ColorType;
-        size?: number;
-        visible?: ('auto' | 'default' | boolean);
-    }
-    interface Stack3DDictionary {
-        [index: number]: Stack3DDictionaryObject;
-        totalStacks: number;
-    }
-    interface Stack3DDictionaryObject {
-        position: number;
-        series: Array<Series>;
-    }
     /**
-     * @optionparent
-     * @private
+     * A side of the frame around a 3D chart.
+     *
+     * @since    4.0
+     * @product  highcharts
+     * @requires highcharts-3d
      */
-    const defaultOptions: {
-        chart: {
-            /**
-             * Options to render charts in 3 dimensions. This feature requires
-             * `highcharts-3d.js`, found in the download package or online at
-             * [code.highcharts.com/highcharts-3d.js](https://code.highcharts.com/highcharts-3d.js).
-             *
-             * @since    4.0
-             * @product  highcharts
-             * @requires highcharts-3d
-             */
-            options3d: {
-                /**
-                 * Whether to render the chart using the 3D functionality.
-                 *
-                 * @since   4.0
-                 * @product highcharts
-                 */
-                enabled: boolean;
-                /**
-                 * One of the two rotation angles for the chart.
-                 *
-                 * @since   4.0
-                 * @product highcharts
-                 */
-                alpha: number;
-                /**
-                 * One of the two rotation angles for the chart.
-                 *
-                 * @since   4.0
-                 * @product highcharts
-                 */
-                beta: number;
-                /**
-                 * The total depth of the chart.
-                 *
-                 * @since   4.0
-                 * @product highcharts
-                 */
-                depth: number;
-                /**
-                 * Whether the 3d box should automatically adjust to the chart
-                 * plot area.
-                 *
-                 * @since   4.2.4
-                 * @product highcharts
-                 */
-                fitToPlot: boolean;
-                /**
-                 * Defines the distance the viewer is standing in front of the
-                 * chart, this setting is important to calculate the perspective
-                 * effect in column and scatter charts. It is not used for 3D
-                 * pie charts.
-                 *
-                 * @since   4.0
-                 * @product highcharts
-                 */
-                viewDistance: number;
-                /**
-                 * Set it to `"auto"` to automatically move the labels to the
-                 * best edge.
-                 *
-                 * @type    {"auto"|null}
-                 * @since   5.0.12
-                 * @product highcharts
-                 */
-                axisLabelPosition: null;
-                /**
-                 * Provides the option to draw a frame around the charts by
-                 * defining a bottom, front and back panel.
-                 *
-                 * @since    4.0
-                 * @product  highcharts
-                 * @requires highcharts-3d
-                 */
-                frame: {
-                    /**
-                     * Whether the frames are visible.
-                     */
-                    visible: string;
-                    /**
-                     * General pixel thickness for the frame faces.
-                     */
-                    size: number;
-                    /**
-                     * The bottom of the frame around a 3D chart.
-                     *
-                     * @since    4.0
-                     * @product  highcharts
-                     * @requires highcharts-3d
-                     */
-                    /**
-                     * The color of the panel.
-                     *
-                     * @type      {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject}
-                     * @default   transparent
-                     * @since     4.0
-                     * @product   highcharts
-                     * @apioption chart.options3d.frame.bottom.color
-                     */
-                    /**
-                     * The thickness of the panel.
-                     *
-                     * @type      {number}
-                     * @default   1
-                     * @since     4.0
-                     * @product   highcharts
-                     * @apioption chart.options3d.frame.bottom.size
-                     */
-                    /**
-                     * Whether to display the frame. Possible values are `true`,
-                     * `false`, `"auto"` to display only the frames behind the
-                     * data, and `"default"` to display faces behind the data
-                     * based on the axis layout, ignoring the point of view.
-                     *
-                     * @sample {highcharts} highcharts/3d/scatter-frame/
-                     *         Auto frames
-                     *
-                     * @type      {boolean|"default"|"auto"}
-                     * @default   default
-                     * @since     5.0.12
-                     * @product   highcharts
-                     * @apioption chart.options3d.frame.bottom.visible
-                     */
-                    /**
-                     * The bottom of the frame around a 3D chart.
-                     */
-                    bottom: {};
-                    /**
-                     * The top of the frame around a 3D chart.
-                     *
-                     * @extends chart.options3d.frame.bottom
-                     */
-                    top: {};
-                    /**
-                     * The left side of the frame around a 3D chart.
-                     *
-                     * @extends chart.options3d.frame.bottom
-                     */
-                    left: {};
-                    /**
-                     * The right of the frame around a 3D chart.
-                     *
-                     * @extends chart.options3d.frame.bottom
-                     */
-                    right: {};
-                    /**
-                     * The back side of the frame around a 3D chart.
-                     *
-                     * @extends chart.options3d.frame.bottom
-                     */
-                    back: {};
-                    /**
-                     * The front of the frame around a 3D chart.
-                     *
-                     * @extends chart.options3d.frame.bottom
-                     */
-                    front: {};
-                };
-            };
-        };
-    };
-    /**
-     * @private
-     */
-    function compose(ChartClass: typeof Chart, FxClass: typeof Fx): void;
-    class Additions {
-        constructor(chart: Chart);
-        chart: Composition;
-        frame3d: FrameObject;
-        get3dFrame(): Chart3D.FrameObject;
+    interface FrameSideOptions {
         /**
-         * Calculate scale of the 3D view. That is required to fit chart's 3D
-         * projection into the actual plotting area. Reported as #4933.
+         * The color of the panel.
          *
-         * **Note:**
-         * This function should ideally take the plot values instead of a chart
-         * object, but since the chart object is needed for perspective it is
-         * not practical. Possible to make both getScale and perspective more
-         * logical and also immutable.
-         *
-         * @private
-         * @function getScale
+         * @default transparent
+         * @since   4.0
+         * @product highcharts
+         */
+        color?: ColorType;
+        /**
+         * The thickness of the panel.
          *
-         * @param {number} depth
-         * The depth of the chart
+         * @default 1
+         * @since   4.0
+         * @product highcharts
+         */
+        size?: number;
+        /**
+         * Whether to display the frame. Possible values are `true`, `false`,
+         * `"auto"` to display only the frames behind the data, and `"default"`
+         * to display faces behind the data based on the axis layout, ignoring
+         * the point of view.
          *
-         * @return {number}
-         * The scale to fit the 3D chart into the plotting area.
+         * @sample {highcharts} highcharts/3d/scatter-frame/
+         *         Auto frames
          *
-         * @requires highcharts-3d
+         * @default default
+         * @since   5.0.12
+         * @product highcharts
          */
-        getScale(depth: number): number;
+        visible?: ('auto' | 'default' | boolean);
+    }
+    class Additions {
     }
 }
 export default Chart3D;

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

@@ -1,12 +1,13 @@
 /* *
  *
- *  (c) 2010-2025 Torstein Honsi
+ *  (c) 2010-2026 Highsoft AS
+ *  Author: Torstein Honsi
  *
  *  Extension for 3D charts
  *
- *  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';
@@ -16,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
@@ -37,7 +37,7 @@ var Chart3D;
      * */
     /**
      * @optionparent
-     * @private
+     * @internal
      */
     Chart3D.defaultOptions = {
         chart: {
@@ -206,15 +206,13 @@ var Chart3D;
      *  Functions
      *
      * */
-    /**
-     * @private
-     */
+    /** @internal */
     function compose(ChartClass, FxClass) {
         const chartProto = ChartClass.prototype;
         const fxProto = FxClass.prototype;
         /**
          * Shorthand to check the is3d flag.
-         * @private
+         * @internal
          * @return {boolean}
          * Whether it is a 3D chart.
          */
@@ -225,7 +223,7 @@ var Chart3D;
         chartProto.propsRequireUpdateSeries.push('chart.options3d');
         /**
          * Animation setter for matrix property.
-         * @private
+         * @internal
          */
         fxProto.matrixSetter = function () {
             let interpolated;
@@ -260,7 +258,7 @@ var Chart3D;
     /**
      * Legacy support for HC < 6 to make 'scatter' series in a 3D chart route to
      * the real 'scatter3d' series type. (#8407)
-     * @private
+     * @internal
      */
     function onAddSeries(e) {
         if (this.is3d()) {
@@ -269,9 +267,7 @@ var Chart3D;
             }
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     function onAfterDrawChartBox() {
         if (this.chart3d &&
             this.is3d()) {
@@ -1071,7 +1067,7 @@ var Chart3D;
     }
     /**
      * Add the required CSS classes for column sides (#6018)
-     * @private
+     * @internal
      */
     function onAfterGetContainer() {
         if (this.styledMode) {
@@ -1117,7 +1113,7 @@ var Chart3D;
     /**
      * Legacy support for HC < 6 to make 'scatter' series in a 3D chart route to
      * the real 'scatter3d' series type. (#8407)
-     * @private
+     * @internal
      */
     function onAfterInit() {
         const options = this.options;
@@ -1132,9 +1128,7 @@ var Chart3D;
             });
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     function onAfterSetChartSize() {
         const chart = this, options3d = chart.options.chart.options3d;
         if (chart.chart3d &&
@@ -1163,40 +1157,32 @@ var Chart3D;
             chart.chart3d.frame3d = chart.chart3d.get3dFrame(); // #7942
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     function onBeforeRedraw() {
         if (this.is3d()) {
             // Set to force a redraw of all elements
             this.isDirtyBox = true;
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     function onBeforeRender() {
         if (this.chart3d && this.is3d()) {
             this.chart3d.frame3d = this.chart3d.get3dFrame();
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     function onInit() {
         if (!this.chart3d) {
             this.chart3d = new Additions(this);
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     function wrapIsInsidePlot(proceed) {
         return this.is3d() || proceed.apply(this, [].slice.call(arguments, 1));
     }
     /**
      * Draw the series in the reverse order (#3803, #3917)
-     * @private
+     * @internal
      */
     function wrapRenderSeries(proceed) {
         let series, i = this.series.length;
@@ -1211,9 +1197,7 @@ var Chart3D;
             proceed.call(this);
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     function wrapSetClassName(proceed) {
         proceed.apply(this, [].slice.call(arguments, 1));
         if (this.is3d()) {
@@ -1231,6 +1215,7 @@ var Chart3D;
          *  Constructors
          *
          * */
+        /** @internal */
         constructor(chart) {
             this.chart = chart;
         }
@@ -1239,6 +1224,7 @@ var Chart3D;
          *  Functions
          *
          * */
+        /** @internal */
         get3dFrame() {
             const chart = this.chart, options3d = chart.options.chart.options3d, frameOptions = options3d.frame, xm = chart.plotLeft, xp = chart.plotLeft + chart.plotWidth, ym = chart.plotTop, yp = chart.plotTop + chart.plotHeight, zm = 0, zp = options3d.depth, faceOrientation = function (vertexes) {
                 const area = shapeArea3D(vertexes, chart);
@@ -1561,7 +1547,7 @@ var Chart3D;
          * not practical. Possible to make both getScale and perspective more
          * logical and also immutable.
          *
-         * @private
+         * @internal
          * @function getScale
          *
          * @param {number} depth

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

@@ -0,0 +1,3 @@
+export interface ChartBase {
+}
+export default ChartBase;

package/es-modules/Core/Chart/ChartBase.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/Chart/ChartDefaults.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';
@@ -385,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
@@ -438,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
      */
@@ -1047,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"]
@@ -1123,13 +1135,9 @@ const ChartDefaults = {
              * @since 10.2.1
              */
             position: {
-                /**
-                 * The horizontal alignment of the button.
-                 */
+                /** @internal */
                 align: 'right',
-                /**
-                 * The horizontal offset of the button.
-                 */
+                /** @internal */
                 x: -10,
                 /**
                  * The vertical alignment of the button.
@@ -1138,9 +1146,7 @@ const ChartDefaults = {
                  * @default    top
                  * @apioption  chart.zooming.resetButton.position.verticalAlign
                  */
-                /**
-                 * The vertical offset of the button.
-                 */
+                /** @internal */
                 y: 10
             }
         }