@highcharts/grid-pro 2.1.1 → 2.2.0

package/es-modules/Core/Animation/AnimationUtilities.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';
@@ -198,3 +199,38 @@ const animationExports = {
  *
  * */
 export default animationExports;
+/* *
+ *
+ *  API Options
+ *
+ * */
+/**
+ * An animation configuration. Animation configurations can also be defined as
+ * booleans, where `false` turns off animation and `true` defaults to a duration
+ * of 500ms and defer of 0ms.
+ *
+ * @interface Highcharts.AnimationOptionsObject
+ */ /**
+* A callback function to execute when the animation finishes.
+* @name Highcharts.AnimationOptionsObject#complete
+* @type {Function|undefined}
+*/ /**
+* The animation defer in milliseconds.
+* @name Highcharts.AnimationOptionsObject#defer
+* @type {number|undefined}
+*/ /**
+* The animation duration in milliseconds.
+* @name Highcharts.AnimationOptionsObject#duration
+* @type {number|undefined}
+*/ /**
+* The name of an easing function as defined on the `Math` object.
+* @name Highcharts.AnimationOptionsObject#easing
+* @type {string|Function|undefined}
+*/ /**
+* A callback function to execute on each step of each attribute or CSS property
+* that's being animated. The first argument contains information about the
+* animation and progress.
+* @name Highcharts.AnimationOptionsObject#step
+* @type {Function|undefined}
+*/
+''; // Keeps doclets in JS file

package/es-modules/Core/Animation/Fx.d.ts

@@ -1,130 +1 @@
-import type AnimationOptions from './AnimationOptions';
-import type FxBase from './FxBase';
-import type { HTMLDOMElement } from '../Renderer/DOMElementType';
-import type HTMLElement from '../Renderer/HTML/HTMLElement';
-import type SVGElement from '../Renderer/SVG/SVGElement';
-import type SVGPath from '../Renderer/SVG/SVGPath';
-/**
- * An animator object used internally. One instance applies to one property
- * (attribute or style prop) on one element. Animation is always initiated
- * through {@link SVGElement#animate}.
- *
- * @example
- * let rect = renderer.rect(0, 0, 10, 10).add();
- * rect.animate({ width: 100 });
- *
- * @private
- * @class
- * @name Highcharts.Fx
- *
- * @param {Highcharts.HTMLDOMElement|Highcharts.SVGElement} elem
- * The element to animate.
- *
- * @param {Partial<Highcharts.AnimationOptionsObject>} options
- * Animation options.
- *
- * @param {string} prop
- * The single attribute or CSS property to animate.
- */
-declare class Fx {
-    static timers: Array<Fx.Timer>;
-    constructor(elem: (HTMLElement | SVGElement), options: Partial<AnimationOptions>, prop: string);
-    elem: (HTMLElement | SVGElement);
-    end?: number;
-    from?: number;
-    now?: number;
-    options: Partial<AnimationOptions>;
-    paths?: [SVGPath, SVGPath];
-    pos: number;
-    prop: string;
-    start?: number;
-    startTime?: number;
-    toD?: SVGPath;
-    unit?: string;
-    /**
-     * Set the current step of a path definition on SVGElement.
-     *
-     * @function Highcharts.Fx#dSetter
-     *
-     */
-    dSetter(): void;
-    /**
-     * Update the element with the current animation step.
-     *
-     * @function Highcharts.Fx#update
-     *
-     */
-    update(): void;
-    /**
-     * Run an animation.
-     *
-     * @function Highcharts.Fx#run
-     *
-     * @param {number} from
-     *        The current value, value to start from.
-     *
-     * @param {number} to
-     *        The end value, value to land on.
-     *
-     * @param {string} unit
-     *        The property unit, for example `px`.
-     *
-     */
-    run(from: number, to: number, unit: string): void;
-    /**
-     * Run a single step in the animation.
-     *
-     * @function Highcharts.Fx#step
-     *
-     * @param {boolean} [gotoEnd]
-     *        Whether to go to the endpoint of the animation after abort.
-     *
-     * @return {boolean}
-     *         Returns `true` if animation continues.
-     */
-    step(gotoEnd?: boolean): boolean;
-    /**
-     * Prepare start and end values so that the path can be animated one to one.
-     *
-     * @function Highcharts.Fx#initPath
-     *
-     * @param {Highcharts.SVGElement} elem
-     *        The SVGElement item.
-     *
-     * @param {Highcharts.SVGPathArray|undefined} fromD
-     *        Starting path definition.
-     *
-     * @param {Highcharts.SVGPathArray} toD
-     *        Ending path definition.
-     *
-     * @return {Array<Highcharts.SVGPathArray,Highcharts.SVGPathArray>}
-     *         An array containing start and end paths in array form so that
-     *         they can be animated in parallel.
-     */
-    initPath(elem: SVGElement, fromD: SVGPath | undefined, toD: SVGPath): [SVGPath, SVGPath];
-    /**
-     * Handle animation of the color attributes directly.
-     *
-     * @function Highcharts.Fx#fillSetter
-     *
-     */
-    fillSetter(): void;
-    /**
-     * Handle animation of the color attributes directly.
-     *
-     * @function Highcharts.Fx#strokeSetter
-     *
-     */
-    strokeSetter(): void;
-}
-interface Fx extends FxBase {
-}
-declare namespace Fx {
-    interface Timer {
-        (gotoEnd?: boolean): boolean;
-        elem?: (HTMLDOMElement | SVGElement);
-        prop?: string;
-        stopped?: boolean;
-    }
-}
-export default Fx;
+export {};

package/es-modules/Core/Animation/Fx.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';
@@ -29,7 +30,7 @@ const { isNumber, objectEach } = U;
  * let rect = renderer.rect(0, 0, 10, 10).add();
  * rect.animate({ width: 100 });
  *
- * @private
+ * @internal
  * @class
  * @name Highcharts.Fx
  *
@@ -49,6 +50,10 @@ class Fx {
      *
      * */
     constructor(elem, options, prop) {
+        /**
+         * Current position of the animation, a value between 0 and 1.
+         * @internal
+         */
         this.pos = NaN;
         this.options = options;
         this.elem = elem;
@@ -254,7 +259,7 @@ class Fx {
         }
         /**
          * If shifting points, prepend a dummy point to the end path.
-         * @private
+         * @internal
          */
         function prepend(arr, other) {
             while (arr.length < fullLength) {
@@ -288,7 +293,7 @@ class Fx {
         }
         /**
          * Copy and append last point until the length matches the end length.
-         * @private
+         * @internal
          */
         function append(arr) {
             while (arr.length < fullLength) {
@@ -379,10 +384,12 @@ class Fx {
  *  Static Properties
  *
  * */
+/** @internal */
 Fx.timers = [];
 /* *
  *
  *  Default Export
  *
  * */
+/** @internal */
 export default Fx;

package/es-modules/Core/Animation/FxBase.d.ts

@@ -0,0 +1 @@
+export {};

package/es-modules/Core/Animation/FxBase.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/Callback.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Generic callback function.
+ *
+ * @callback Highcharts.Callback
+ *
+ * @param {TScope} this
+ * The context for the callback.
+ *
+ * @return {TReturn}
+ * Return value.
+ */
+export interface Callback<TScope, TReturn> {
+    (this: TScope): TReturn;
+}
+/**
+ * Generic event callback function.
+ *
+ * @callback Highcharts.EventCallback
+ *
+ * @param {TScope} this
+ * The context for the callback.
+ *
+ * @param {TEvent} e
+ * Event argument.
+ *
+ * @return {boolean|void}
+ * Return value.
+ */
+export interface EventCallback<TScope, TEvent = AnyRecord | Event> {
+    (this: TScope, e: TEvent): (boolean | void);
+}
+/**
+ * Generic formatter callback function.
+ *
+ * @callback Highcharts.FormatterCallback
+ *
+ * @param {TScope} this
+ * The context for the callback.
+ *
+ * @param {TEvent} e
+ * Event argument.
+ *
+ * @return {string}
+ * Return value.
+ */
+export interface FormatterCallback<TScope, TEvent = unknown> {
+    (this: TScope, e: TEvent): string;
+}
+export default Callback;

package/es-modules/Core/Callback.js

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