@highcharts/grid-pro 2.1.1 → 2.3.0

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,25 @@ declare namespace Time {
         (this: Time, timestamp: number): string;
     }
     interface TimeNormalizedObject {
+        /**
+         * The count of the interval.
+         */
         count: number;
+        /**
+         * A value for how well the returned tick interval fits the input
+         * interval. Ranges close to but above 1 indicate that the fit is bad,
+         * where 1 is a perfect fit for the _next_ higher interval. For example,
+         * if the algorithm lands on weekly ticks but the match is 1.01, it is
+         * very close to monthly ticks.
+         */
+        match?: 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,16 +1,17 @@
 /* *
  *
- *  (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';
 import TimeBase from '../Shared/TimeBase.js';
-import U from '../Core/Utilities.js';
-const { defined, extend, timeUnits } = U;
+import { defined, extend } from '../Shared/Utilities.js';
+import { timeUnits } from './Utilities.js';
 /* *
  *
  *  Constants

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

@@ -4,7 +4,6 @@ import type Pointer from './Pointer';
 import type PointerEvent from './PointerEvent';
 import type PositionObject from './Renderer/PositionObject';
 import type Series from './Series/Series';
-import type SizeObject from './Renderer/SizeObject';
 import type SVGElement from './Renderer/SVG/SVGElement';
 import type SVGRenderer from './Renderer/SVG/SVGRenderer';
 import type TooltipOptions from './TooltipOptions';
@@ -24,11 +23,6 @@ declare module './Series/SeriesBase' {
         tt?: SVGElement;
     }
 }
-declare module './Series/SeriesOptions' {
-    interface SeriesOptions {
-        tooltip?: Partial<TooltipOptions>;
-    }
-}
 /**
  * Tooltip of a chart.
  *
@@ -47,51 +41,95 @@ declare module './Series/SeriesOptions' {
 declare class Tooltip {
     constructor(chart: Chart, options: TooltipOptions, pointer: Pointer);
     allowShared: boolean;
+    /**
+     * Chart of the tooltip.
+     *
+     * @readonly
+     * @name Highcharts.Tooltip#chart
+     * @type {Highcharts.Chart}
+     */
     chart: Chart;
+    /**
+     * Reference to the tooltip's container, when
+     * [Highcharts.Tooltip#outside] is set to true, otherwise it's undefined.
+     *
+     * @name Highcharts.Tooltip#container
+     * @type {Highcharts.HTMLDOMElement|undefined}
+     */
     container?: globalThis.HTMLElement;
-    crosshairs: Array<null>;
     distance: number;
     followPointer?: boolean;
     hideTimer?: number;
-    isHidden: boolean;
+    showTimer?: number;
     isSticky: boolean;
     label?: SVGElement;
     len?: number;
+    /**
+     * Used tooltip options.
+     *
+     * @readonly
+     * @name Highcharts.Tooltip#options
+     * @type {Highcharts.TooltipOptions}
+     */
     options: TooltipOptions;
+    /**
+     * Whether to allow the tooltip to render outside the chart's SVG
+     * element box. By default (false), the tooltip is rendered within the
+     * chart's SVG element, which results in the tooltip being aligned
+     * inside the chart area.
+     *
+     * @readonly
+     * @name Highcharts.Tooltip#outside
+     * @type {boolean}
+     *
+     * @todo
+     * Split tooltip does not support outside in the first iteration. Should
+     * not be too complicated to implement.
+     */
     outside: boolean;
+    /**
+     * The pointer instance.
+     *
+     * @readonly
+     * @name Highcharts.Tooltip#pointer
+     * @type {Highcharts.Pointer}
+     */
     pointer: Pointer;
-    renderer?: SVGRenderer;
-    shared?: boolean;
-    split?: boolean;
-    tracker?: SVGElement;
-    tt?: SVGElement;
     /**
-     * Build the body (lines) of the tooltip by iterating over the items and
-     * returning one entry for each item, abstracting this functionality allows
-     * to easily overwrite and extend it.
+     * Reference to the tooltip's renderer, when
+     * [Highcharts.Tooltip#outside] is set to true, otherwise it's undefined.
      *
-     * @private
-     * @function Highcharts.Tooltip#bodyFormatter
+     * @name Highcharts.Tooltip#renderer
+     * @type {Highcharts.SVGRenderer|undefined}
      */
-    bodyFormatter(points: Array<Point>): Array<string>;
+    renderer?: SVGRenderer;
     /**
-     * Destroy the single tooltips in a split tooltip.
-     * If the tooltip is active then it is not destroyed, unless forced to.
+     * When the tooltip is shared, the entire plot area will capture mouse
+     * movement or touch events.
      *
-     * @private
-     * @function Highcharts.Tooltip#cleanSplit
+     * @readonly
+     * @name Highcharts.Tooltip#shared
+     * @type {boolean|undefined}
+     */
+    shared?: boolean;
+    /**
+     * True, if the tooltip is split into one label per series, with the
+     * header close to the axis.
      *
-     * @param {boolean} [force]
-     * Force destroy all tooltips.
+     * @readonly
+     * @name Highcharts.Tooltip#split
+     * @type {boolean|undefined}
      */
-    cleanSplit(force?: boolean): void;
+    split?: boolean;
+    tracker?: SVGElement;
+    tt?: SVGElement;
     /**
      * In case no user defined formatter is given, this will be used. Note that
      * the context here is an object holding point, series, x, y etc.
      *
      * @function Highcharts.Tooltip#defaultFormatter
      *
-     * @param {Highcharts.Tooltip} tooltip
+     * @param {Highcharts.Tooltip} tooltip The tooltip instance.
      *
      * @return {string|Array<string>}
      * Returns a string (single tooltip and shared)
@@ -104,14 +142,6 @@ declare class Tooltip {
      * @function Highcharts.Tooltip#destroy
      */
     destroy(): void;
-    /**
-     * Extendable method to get the anchor position of the tooltip
-     * from a point or set of points
-     *
-     * @private
-     * @function Highcharts.Tooltip#getAnchor
-     */
-    getAnchor(points: (Point | Array<Point>), mouseEvent?: PointerEvent): Array<number>;
     /**
      * Get the CSS class names for the tooltip's label. Styles the label
      * by `colorIndex` or user-defined CSS.
@@ -131,12 +161,6 @@ declare class Tooltip {
      * Tooltip label
      */
     getLabel({ anchorX, anchorY }?: Partial<SVGElement>): SVGElement;
-    /**
-     * Get the total area available area to place the tooltip
-     *
-     * @private
-     */
-    getPlayingField(): SizeObject;
     /**
      * Place the tooltip in a chart without spilling over and not covering the
      * point itself.
@@ -156,13 +180,6 @@ declare class Tooltip {
      *         Recommended position of the tooltip.
      */
     getPosition(boxWidth: number, boxHeight: number, point: Tooltip.PositionerPointObject | Point): PositionObject;
-    /**
-     * Place the tooltip when `position.fixed` is true. This is called both for
-     * single tooltips, and for partial tooltips when `split`.
-     *
-     * @private
-     */
-    getFixedPosition(boxWidth: number, boxHeight: number, point: Point | Tooltip.PositionerPointObject): PositionObject;
     /**
      * Hides the tooltip with a fade out animation.
      *
@@ -174,35 +191,7 @@ declare class Tooltip {
      *        the fade out animation.
      */
     hide(delay?: number): void;
-    /**
-     * Initialize tooltip.
-     *
-     * @private
-     * @function Highcharts.Tooltip#init
-     *
-     * @param {Highcharts.Chart} chart
-     *        The chart instance.
-     *
-     * @param {Highcharts.TooltipOptions} options
-     *        Tooltip options.
-     */
-    init(chart: Chart, options: TooltipOptions): void;
     shouldStickOnContact(pointerEvent?: PointerEvent): boolean;
-    /**
-     * Moves the tooltip with a soft animation to a new position.
-     *
-     * @private
-     * @function Highcharts.Tooltip#move
-     *
-     * @param {number} x
-     *
-     * @param {number} y
-     *
-     * @param {number} anchorX
-     *
-     * @param {number} anchorY
-     */
-    move(x: number, y: number, anchorX: number, anchorY: number): void;
     /**
      * Refresh the tooltip's text and position.
      *
@@ -216,38 +205,6 @@ declare class Tooltip {
      *        used for the tooltip update.
      */
     refresh(pointOrPoints: (Point | Array<Point>), mouseEvent?: PointerEvent): void;
-    /**
-     * Render the split tooltip. Loops over each point's text and adds
-     * a label next to the point, then uses the distribute function to
-     * find best non-overlapping positions.
-     *
-     * @private
-     * @function Highcharts.Tooltip#renderSplit
-     *
-     * @param {string|Array<(boolean|string)>} labels
-     *
-     * @param {Array<Highcharts.Point>} points
-     */
-    renderSplit(labels: (string | Array<(boolean | string)>), points: Array<Point>): void;
-    /**
-     * If the `stickOnContact` option is active, this will add a tracker shape.
-     *
-     * @private
-     * @function Highcharts.Tooltip#drawTracker
-     */
-    private drawTracker;
-    /**
-     * @private
-     */
-    styledModeFormat(formatString: string): string;
-    /**
-     * Format the footer/header of the tooltip
-     * #3397: abstraction to enable formatting of footer and header
-     *
-     * @private
-     * @function Highcharts.Tooltip#headerFooterFormatter
-     */
-    headerFooterFormatter(point: Point, isFooter?: boolean): string;
     /**
      * Updates the tooltip with the provided tooltip options.
      *
@@ -257,19 +214,10 @@ declare class Tooltip {
      *        The tooltip options to update.
      */
     update(options: TooltipOptions): void;
-    /**
-     * Find the new position and perform the move
-     *
-     * @private
-     * @function Highcharts.Tooltip#updatePosition
-     *
-     * @param {Highcharts.Point} point
-     */
-    updatePosition(point: Tooltip.PositionerPointObject): void;
 }
 declare namespace Tooltip {
     interface FormatterCallbackFunction {
-        (this: Point, tooltip: Tooltip): (false | string | Array<string>);
+        (this: Point, tooltip: Tooltip, ctx?: Point): (false | string | Array<string>);
     }
     interface HeaderFormatterEventObject {
         isFooter?: boolean;
@@ -277,7 +225,7 @@ declare namespace Tooltip {
         text?: string;
     }
     interface PositionerCallbackFunction {
-        (this: Tooltip, labelWidth: number, labelHeight: number, point: (Point | PositionerPointObject), anchor?: [number, number], alignLeft?: boolean): PositionObject;
+        (this: Tooltip, labelWidth: number, labelHeight: number, point: (Point | PositionerPointObject), ctx?: Tooltip, anchor?: [number, number], alignLeft?: boolean): PositionObject;
     }
     interface PositionerPointObject {
         isHeader?: boolean;
@@ -289,9 +237,5 @@ declare namespace Tooltip {
         ttBelow?: boolean;
     }
     type ShapeValue = ('callout' | 'circle' | 'rect');
-    /**
-     * @private
-     */
-    function compose(PointerClass: typeof Pointer): void;
 }
 export default Tooltip;