@highcharts/grid-pro 2.1.1 → 2.2.0

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';
@@ -47,44 +46,87 @@ 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;
     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.
@@ -104,14 +146,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 +165,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 +184,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 +195,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 +209,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,15 +218,6 @@ 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 {
@@ -289,9 +241,5 @@ declare namespace Tooltip {
         ttBelow?: boolean;
     }
     type ShapeValue = ('callout' | 'circle' | 'rect');
-    /**
-     * @private
-     */
-    function compose(PointerClass: typeof Pointer): void;
 }
 export default Tooltip;

package/es-modules/Core/Tooltip.js

@@ -1,10 +1,11 @@
 /* *
  *
- *  (c) 2010-2024 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';
@@ -53,11 +54,48 @@ class Tooltip {
          *
          * */
         this.allowShared = true;
+        /**
+         * List of crosshairs.
+         *
+         * @internal
+         * @readonly
+         * @name Highcharts.Tooltip#crosshairs
+         * @type {Array<null>}
+         */
         this.crosshairs = [];
         this.distance = 0;
+        /**
+         * Tooltips are initially hidden.
+         *
+         * @internal
+         * @readonly
+         * @name Highcharts.Tooltip#isHidden
+         * @type {boolean}
+         */
         this.isHidden = true;
         this.isSticky = false;
+        /**
+         * Used tooltip options.
+         *
+         * @readonly
+         * @name Highcharts.Tooltip#options
+         * @type {Highcharts.TooltipOptions}
+         */
         this.options = {};
+        /**
+         * 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.
+         */
         this.outside = false;
         this.chart = chart;
         this.init(chart, options);
@@ -73,7 +111,7 @@ class Tooltip {
      * returning one entry for each item, abstracting this functionality allows
      * to easily overwrite and extend it.
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#bodyFormatter
      */
     bodyFormatter(points) {
@@ -87,7 +125,7 @@ class Tooltip {
      * Destroy the single tooltips in a split tooltip.
      * If the tooltip is active then it is not destroyed, unless forced to.
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#cleanSplit
      *
      * @param {boolean} [force]
@@ -155,7 +193,7 @@ class Tooltip {
      * Extendable method to get the anchor position of the tooltip
      * from a point or set of points
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#getAnchor
      */
     getAnchor(points, mouseEvent) {
@@ -335,7 +373,7 @@ class Tooltip {
     /**
      * Get the total area available area to place the tooltip
      *
-     * @private
+     * @internal
      */
     getPlayingField() {
         const { body, documentElement } = doc, { chart, distance, outside } = this;
@@ -414,7 +452,7 @@ class Tooltip {
          * tooltip on top or bottom of the point, it will look for space
          * there.
          *
-         * @private
+         * @internal
          */
         firstDimension = function (dim, outerSize, innerSize, scaledInnerSize, // #11329
         point, min, max) {
@@ -446,7 +484,7 @@ class Tooltip {
          * align the tooltip above the point, trying to align center but
          * allowing left or right align within the chart box.
          *
-         * @private
+         * @internal
          */
         secondDimension = function (dim, outerSize, innerSize, scaledInnerSize, // #11329
         point) {
@@ -500,7 +538,7 @@ class Tooltip {
      * Place the tooltip when `position.fixed` is true. This is called both for
      * single tooltips, and for partial tooltips when `split`.
      *
-     * @private
+     * @internal
      */
     getFixedPosition(boxWidth, boxHeight, point) {
         const series = point.series, { chart, options, split } = this, position = options.position, relativeToOption = position.relativeTo, noPane = options.shared || series?.yAxis?.isRadial &&
@@ -558,7 +596,7 @@ class Tooltip {
     /**
      * Initialize tooltip.
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#init
      *
      * @param {Highcharts.Chart} chart
@@ -587,7 +625,7 @@ class Tooltip {
         /**
          * List of crosshairs.
          *
-         * @private
+         * @internal
          * @readonly
          * @name Highcharts.Tooltip#crosshairs
          * @type {Array<null>}
@@ -596,7 +634,7 @@ class Tooltip {
         /**
          * Tooltips are initially hidden.
          *
-         * @private
+         * @internal
          * @readonly
          * @name Highcharts.Tooltip#isHidden
          * @type {boolean}
@@ -644,7 +682,7 @@ class Tooltip {
     /**
      * Moves the tooltip with a soft animation to a new position.
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#move
      *
      * @param {number} x
@@ -801,7 +839,7 @@ class Tooltip {
      * a label next to the point, then uses the distribute function to
      * find best non-overlapping positions.
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#renderSplit
      *
      * @param {string|Array<(boolean|string)>} labels
@@ -834,7 +872,7 @@ class Tooltip {
         /**
          * Calculates the anchor position for the partial tooltip
          *
-         * @private
+         * @internal
          * @param {Highcharts.Point} point The point related to the tooltip
          * @return {Object} Returns an object with anchorX and anchorY
          */
@@ -865,7 +903,7 @@ class Tooltip {
         }
         /**
          * Calculate the position of the partial tooltip
-         * @private
+         * @internal
          */
         const defaultPositioner = function (boxWidth, boxHeight, point, anchor = [0, 0], alignedLeft = true) {
             let x, y;
@@ -892,7 +930,7 @@ class Tooltip {
          * Updates the attributes and styling of the partial tooltip. Creates a
          * new partial tooltip if it does not exists.
          *
-         * @private
+         * @internal
          * @param {Highcharts.SVGElement|undefined} partialTooltip
          *  The partial tooltip to update
          * @param {Highcharts.Point} point
@@ -1094,7 +1132,7 @@ class Tooltip {
     /**
      * If the `stickOnContact` option is active, this will add a tracker shape.
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#drawTracker
      */
     drawTracker() {
@@ -1152,9 +1190,7 @@ class Tooltip {
             }
         }
     }
-    /**
-     * @private
-     */
+    /** @internal */
     styledModeFormat(formatString) {
         return formatString
             .replace('style="font-size: 0.8em"', 'class="highcharts-header"')
@@ -1166,7 +1202,7 @@ class Tooltip {
      * Format the footer/header of the tooltip
      * #3397: abstraction to enable formatting of footer and header
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#headerFooterFormatter
      */
     headerFooterFormatter(point, isFooter) {
@@ -1215,7 +1251,7 @@ class Tooltip {
     /**
      * Find the new position and perform the move
      *
-     * @private
+     * @internal
      * @function Highcharts.Tooltip#updatePosition
      *
      * @param {Highcharts.Point} point
@@ -1277,9 +1313,7 @@ class Tooltip {
      *  Functions
      *
      * */
-    /**
-     * @private
-     */
+    /** @internal */
     function compose(PointerClass) {
         if (pushUnique(composed, 'Core.Tooltip')) {
             addEvent(PointerClass, 'afterInit', function () {