@highcharts/grid-pro 2.1.1 → 2.2.0

package/es-modules/Core/Renderer/SVG/SymbolOptions.d.ts

@@ -1,29 +1,13 @@
-/* *
- *
- *  (c) 2010-2025 Torstein Honsi
- *
- *  License: www.highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-
-/* *
- *
- *  Declarations
- *
- * */
-
 export interface SymbolOptions {
     anchorX?: number;
     anchorY?: number;
-    backgroundSize?: ('contain'|'cover'|'within');
+    backgroundSize?: ('contain' | 'cover' | 'within');
     context?: 'legend';
-    clockwise?: (0|1);
+    clockwise?: (0 | 1);
     end?: number;
     height?: number;
     innerR?: number;
-    longArc?: (0|1);
+    longArc?: (0 | 1);
     open?: boolean;
     r?: number;
     start?: number;
@@ -31,11 +15,4 @@ export interface SymbolOptions {
     x?: number;
     y?: number;
 }
-
-/* *
- *
- *  Default Export
- *
- * */
-
 export default SymbolOptions;

package/es-modules/Core/Renderer/SVG/SymbolType.d.ts

@@ -1,50 +1,10 @@
-/* *
- *
- *  (c) 2010-2025 Torstein Honsi
- *
- *  License: www.highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-
-/* *
- *
- *  Imports
- *
- * */
-
 import type SVGPath from './SVGPath';
 import type SymbolOptions from './SymbolOptions';
-
-/* *
- *
- *  Declarations
- *
- * */
-
 export interface SymbolFunction {
-    (
-        x: number,
-        y: number,
-        width: number,
-        height: number,
-        options?: SymbolOptions
-    ): SVGPath;
+    (x: number, y: number, width: number, height: number, options?: SymbolOptions): SVGPath;
 }
-
 export type SymbolKey = keyof SymbolTypeRegistry;
-
 export type SymbolType = SymbolTypeRegistry[SymbolKey];
-
 export interface SymbolTypeRegistry {
-    // Add with declare module pattern
 }
-
-/* *
- *
- *  Default Export
- *
- * */
-
 export default SymbolType;

package/es-modules/Core/Renderer/SVG/Symbols.d.ts

@@ -0,0 +1,146 @@
+import type SVGPath from './SVGPath';
+import type SymbolOptions from './SymbolOptions';
+import type { SymbolTypeRegistry } from './SymbolType';
+/**
+ * Arc symbol path.
+ *
+ * @param {number} cx
+ * Center X
+ * @param {number} cy
+ * Center Y
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @param {Highcharts.SymbolOptions} [options]
+ * Options
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function arc(cx: number, cy: number, w: number, h: number, options?: SymbolOptions): SVGPath;
+/**
+ * Callout shape used for default tooltips.
+ *
+ * @param {number} cx
+ * Center X
+ * @param {number} cy
+ * Center Y
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @param {Highcharts.SymbolOptions} [options]
+ * Options
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function callout(x: number, y: number, w: number, h: number, options?: SymbolOptions): SVGPath;
+/**
+ * Circle symbol path.
+ *
+ * @param {number} x
+ * X coordinate
+ * @param {number} y
+ * Y coordinate
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function circle(x: number, y: number, w: number, h: number): SVGPath;
+/**
+ * Diamond symbol path.
+ *
+ * @param {number} x
+ * X coordinate
+ * @param {number} y
+ * Y coordinate
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function diamond(x: number, y: number, w: number, h: number): SVGPath;
+/**
+ * Rect symbol path.
+ *
+ * @param {number} x
+ * X coordinate
+ * @param {number} y
+ * Y coordinate
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @param {Highcharts.SymbolOptions} [options]
+ * Options
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function rect(x: number, y: number, w: number, h: number, options?: SymbolOptions): SVGPath;
+/**
+ * Rounded rectangle symbol path.
+ *
+ * @param {number} x
+ * X coordinate
+ * @param {number} y
+ * Y coordinate
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @param {Highcharts.SymbolOptions} [options]
+ * Options
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function roundedRect(x: number, y: number, w: number, h: number, options?: SymbolOptions): SVGPath;
+/**
+ * Triangle symbol path.
+ *
+ * @param {number} x
+ * X coordinate
+ * @param {number} y
+ * Y coordinate
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function triangle(x: number, y: number, w: number, h: number): SVGPath;
+/**
+ * Inverted triangle symbol path.
+ *
+ * @param {number} x
+ * X coordinate
+ * @param {number} y
+ * Y coordinate
+ * @param {number} w
+ * Width
+ * @param {number} h
+ * Height
+ * @return {Highcharts.SVGPathArray}
+ * Path
+ */
+declare function triangleDown(x: number, y: number, w: number, h: number): SVGPath;
+declare module './SymbolType' {
+    interface SymbolTypeRegistry {
+        arc: typeof arc;
+        callout: typeof callout;
+        circle: typeof circle;
+        diamond: typeof diamond;
+        rect: typeof rect;
+        roundedRect: typeof roundedRect;
+        square: typeof rect;
+        triangle: typeof triangle;
+        'triangle-down': typeof triangleDown;
+    }
+}
+declare const Symbols: SymbolTypeRegistry;
+export default Symbols;

package/es-modules/Core/Renderer/SVG/TextBuilder.d.ts

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

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

@@ -1,40 +1,31 @@
-/* *
- *
- *  (c) 2010-2025 Torstein Honsi
- *
- *  License: www.highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-
-/* *
- *
- *  Imports
- *
- * */
-
 import type ColorString from '../Color/ColorString';
-
-/* *
- *
- *  Declarations
- *
- * */
-
+/**
+ * The shadow options.
+ */
 export interface ShadowOptionsObject {
+    /**
+     * The color of the shadow.
+     */
     color: ColorString;
+    /**
+     * The units for the filter effect. Can be `userSpaceOnUse` or `objectBoundingBox`.
+     */
     filterUnits?: string;
+    /**
+     * The horizontal offset of the shadow.
+     */
     offsetX: number;
+    /**
+     * The vertical offset of the shadow.
+     */
     offsetY: number;
+    /**
+     * The opacity of the shadow.
+     */
     opacity: number;
+    /**
+     * The blur radius of the shadow.
+     */
     width: number;
 }
-
-/* *
- *
- *  Default Export
- *
- * */
-
 export default ShadowOptionsObject;

package/es-modules/Core/Renderer/ShadowOptionsObject.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/SizeObject.d.ts

@@ -1,28 +1,5 @@
-/* *
- *
- *  (c) 2010-2025 Torstein Honsi
- *
- *  License: www.highcharts.com/license
- *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
- *
- * */
-
-/* *
- *
- *  Declarations
- *
- * */
-
 export interface SizeObject {
     height: number;
     width: number;
 }
-
-/* *
- *
- *  Default Export
- *
- * */
-
 export default SizeObject;

package/es-modules/Core/Renderer/SizeObject.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/Responsive.d.ts

@@ -1,14 +1,22 @@
 import type Chart from './Chart/Chart.js';
 import type GlobalOptions from './Options';
-declare module './Chart/ChartBase' {
-    interface ChartBase {
-        /** @requires Core/Responsive */
-        setResponsive(redraw?: boolean, reset?: boolean): void;
-    }
-}
 declare module './Options' {
     interface Options {
-        isResponsiveOptions?: boolean;
+        /**
+         * Allows setting a set of rules to apply for different screen or chart
+         * sizes. Each rule specifies additional chart options.
+         *
+         * @sample {highstock} stock/demo/responsive/
+         *         Stock chart
+         * @sample highcharts/responsive/axis/
+         *         Axis
+         * @sample highcharts/responsive/legend/
+         *         Legend
+         * @sample highcharts/responsive/classname/
+         *         Class name
+         *
+         * @since     5.0.0
+         */
         responsive?: Responsive.Options;
     }
 }
@@ -16,40 +24,95 @@ declare namespace Responsive {
     interface CallbackFunction {
         (this: Chart): boolean;
     }
-    class Composition extends Chart {
-        /** @requires Core/Responsive */
-        currentResponsive?: CurrentObject;
-        /** @requires Core/Responsive */
-        currentOptions(options: Partial<GlobalOptions>): Partial<GlobalOptions>;
-        /** @requires Core/Responsive */
-        matchResponsiveRule(rule: RuleOptions, matches: Array<string>): void;
-        /** @requires Core/Responsive */
-        setResponsive(redraw?: boolean, reset?: boolean): void;
-        updatingResponsive: boolean;
-    }
-    interface CurrentObject {
-        mergedOptions: Partial<GlobalOptions>;
-        ruleIds: string;
-        undoOptions: Partial<GlobalOptions>;
-    }
     interface Options {
+        /**
+         * A set of rules for responsive settings. The rules are executed from
+         * the top down.
+         *
+         * @sample {highcharts} highcharts/responsive/axis/
+         *         Axis changes
+         * @sample {highstock} highcharts/responsive/axis/
+         *         Axis changes
+         * @sample {highmaps} highcharts/responsive/axis/
+         *         Axis changes
+         *
+         * @since     5.0.0
+         */
         rules?: Array<RuleOptions>;
     }
     interface RuleConditionOptions {
+        /**
+         * A callback function to gain complete control on when the responsive
+         * rule applies. Return `true` if it applies. This opens for checking
+         * against other metrics than the chart size, for example the document
+         * size or other elements.
+         *
+         * @since     5.0.0
+         * @context   Highcharts.Chart
+         */
         callback?: CallbackFunction;
+        /**
+         * The responsive rule applies if the chart height is less than this.
+         *
+         * @since     5.0.0
+         */
         maxHeight?: number;
+        /**
+         * The responsive rule applies if the chart width is less than this.
+         *
+         * @sample highcharts/responsive/axis/
+         *         Max width is 500
+         *
+         * @since     5.0.0
+         */
         maxWidth?: number;
+        /**
+         * The responsive rule applies if the chart height is greater than this.
+         *
+         * @default   0
+         * @since     5.0.0
+         */
         minHeight?: number;
+        /**
+         * The responsive rule applies if the chart width is greater than this.
+         *
+         * @default   0
+         * @since     5.0.0
+         */
         minWidth?: number;
     }
     interface RuleOptions {
-        _id?: string;
+        /**
+         * A full set of chart options to apply as overrides to the general
+         * chart options. The chart options are applied when the given rule
+         * is active.
+         *
+         * A special case is configuration objects that take arrays, for example
+         * [xAxis](#xAxis), [yAxis](#yAxis) or [series](#series). For these
+         * collections, an `id` option is used to map the new option set to
+         * an existing object. If an existing object of the same id is not
+         * found, the item of the same index updated. So for example, setting
+         * `chartOptions` with two series items without an `id`, will cause the
+         * existing chart's two series to be updated with respective options.
+         *
+         * @sample {highstock} stock/demo/responsive/
+         *         Stock chart
+         * @sample highcharts/responsive/axis/
+         *         Axis
+         * @sample highcharts/responsive/legend/
+         *         Legend
+         * @sample highcharts/responsive/classname/
+         *         Class name
+         *
+         * @since     5.0.0
+         */
         chartOptions?: GlobalOptions;
+        /**
+         * Under which conditions the rule applies.
+         *
+         * @since     5.0.0
+         */
         condition: RuleConditionOptions;
     }
-    /**
-     * @private
-     */
-    function compose<T extends typeof Chart>(ChartClass: T): (T & typeof Composition);
 }
 export default Responsive;

package/es-modules/Core/Responsive.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,9 +28,7 @@ var Responsive;
      *  Functions
      *
      * */
-    /**
-     * @private
-     */
+    /** @internal */
     function compose(ChartClass) {
         const chartProto = ChartClass.prototype;
         if (!chartProto.matchResponsiveRule) {
@@ -44,7 +43,7 @@ var Responsive;
     /**
      * Handle a single responsiveness rule.
      *
-     * @private
+     * @internal
      * @function Highcharts.Chart#matchResponsiveRule
      * @param {Highcharts.ResponsiveRulesOptions} rule
      * @param {Array<string>} matches
@@ -64,7 +63,7 @@ var Responsive;
      * Update the chart based on the current chart/document size and options
      * for responsiveness.
      *
-     * @private
+     * @internal
      * @function Highcharts.Chart#setResponsive
      * @param  {boolean} [redraw=true]
      * @param  {boolean} [reset=false]

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

@@ -113,12 +113,28 @@ declare namespace Templating {
         (this: T): string;
     }
     interface OwnerOptions {
+        /**
+         * Language options. See {@link Highcharts.LangOptions} for details.
+         */
         lang?: LangOptionsCore;
     }
     interface Owner {
+        /**
+         * The chart options. See {@link Highcharts.Options} for details.
+         */
         options?: OwnerOptions;
+        /**
+         * The time object. See {@link Highcharts.Time} for details.
+         */
         time?: TimeBase;
+        /**
+         * A function to format numbers. See {@link Highcharts.numberFormat} for
+         * details.
+         */
         numberFormatter?: Function;
+        /**
+         * The locale to use for number formatting.
+         */
         locale?: string | string[];
     }
 }

package/es-modules/Core/Templating.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';
@@ -14,6 +15,7 @@ import G from './Globals.js';
 const { pageLang } = G;
 import U from './Utilities.js';
 const { extend, getNestedProperty, isArray, isNumber, isObject, isString, pick, ucfirst } = U;
+/** @internal */
 const helpers = {
     // Built-in helpers
     add: (a, b) => a + b,
@@ -48,7 +50,10 @@ const numberFormatCache = {};
  *  Functions
  *
  * */
-// Internal convenience function
+/**
+ * Internal convenience function.
+ * @internal
+ */
 const isQuotedString = (str) => /^["'].+["']$/.test(str);
 /**
  * Formats a JavaScript date timestamp (milliseconds since Jan 1st 1970) into a

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

@@ -33,7 +33,7 @@ declare class Time extends TimeBase {
 declare namespace Time {
     interface DateTimeFormatOptions extends Intl.DateTimeFormatOptions {
         dateStyle?: 'full' | 'long' | 'medium' | 'short';
-        fractionalSecondDigits?: number;
+        fractionalSecondDigits?: 1 | 2 | 3;
         prefix?: string;
         suffix?: string;
         timeStyle?: 'full' | 'long' | 'medium' | 'short';
@@ -59,8 +59,17 @@ declare namespace Time {
         (this: Time, timestamp: number): string;
     }
     interface TimeNormalizedObject {
+        /**
+         * The count of the interval.
+         */
         count: number;
+        /**
+         * The name of the time unit.
+         */
         unitName: TimeUnit;
+        /**
+         * The interval in axis values (ms).
+         */
         unitRange: number;
     }
     type TimeUnit = ('millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'year');

package/es-modules/Core/Time.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';