@highcharts/grid-pro 2.1.1 → 2.2.0

package/es-modules/Core/Color/Palettes.d.ts

@@ -1,84 +1 @@
-import type ColorString from './ColorString';
-/**
- * Palette for Highcharts. Palette colors are defined in highcharts.css.
- * **Do not edit this file!** This file is generated using the 'gulp palette' task.
- * @private
- */
-export declare const enum Palette {
-    /**
-     * Chart background, point stroke for markers and columns etc
-     */
-    backgroundColor = "#ffffff",
-    /**
-     * Strong text.
-     */
-    neutralColor100 = "#000000",
-    /**
-     * Main text, axis labels and some strokes.
-     */
-    neutralColor80 = "#333333",
-    /**
-     * Axis title, connector fallback.
-     */
-    neutralColor60 = "#666666",
-    /**
-     * Credits text, export menu stroke.
-     */
-    neutralColor40 = "#999999",
-    /**
-     * Disabled texts, button strokes, crosshair etc.
-     */
-    neutralColor20 = "#cccccc",
-    /**
-     * Grid lines etc.
-     */
-    neutralColor10 = "#e6e6e6",
-    /**
-     * Minor grid lines etc.
-     */
-    neutralColor5 = "#f2f2f2",
-    /**
-     * Tooltip background, button fills, map null points.
-     */
-    neutralColor3 = "#f7f7f7",
-    /**
-     * Drilldown clickable labels, color axis max color.
-     */
-    highlightColor100 = "#0022ff",
-    /**
-     * Selection marker, menu hover, button hover, chart border, navigator series.
-     */
-    highlightColor80 = "#334eff",
-    /**
-     * Navigator mask fill.
-     */
-    highlightColor60 = "#667aff",
-    /**
-     * Ticks and axis line.
-     */
-    highlightColor20 = "#ccd3ff",
-    /**
-     * Pressed button, color axis min color.
-     */
-    highlightColor10 = "#e6e9ff",
-    /**
-     * Indicators
-     */
-    positiveColor = "#06b535",
-    /**
-     * Indicators
-     */
-    negativeColor = "#f21313"
-}
-/**
- * Series palettes for Highcharts. Series colors are defined in highcharts.css.
- * **Do not edit this file!** This file is generated using the 'gulp palette' task.
- * @private
- */
-declare const SeriesPalettes: {
-    /**
-     * Colors for data series and points
-     */
-    colors: Array<ColorString>;
-};
-export default SeriesPalettes;
+export {};

package/es-modules/Core/Color/Palettes.js

@@ -1,7 +1,7 @@
 /**
  * Series palettes for Highcharts. Series colors are defined in highcharts.css.
  * **Do not edit this file!** This file is generated using the 'gulp palette' task.
- * @private
+ * @internal
  */
 const SeriesPalettes = {
     /**
@@ -20,4 +20,5 @@ const SeriesPalettes = {
         '#91e8e1'
     ],
 };
+/** @internal */
 export default SeriesPalettes;

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

@@ -3,6 +3,12 @@ import type { DefaultOptions, Options } from './Options';
 import Time from './Time.js';
 declare module './GlobalsBase' {
     interface GlobalsBase {
+        /**
+         * Global default settings.
+         *
+         * @name Highcharts.defaultOptions
+         * @type {Highcharts.Options}
+         */
         defaultOptions: DefaultOptions;
         time: Time;
     }

package/es-modules/Core/Defaults.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,7 +28,7 @@ const { fireEvent, merge } = U;
  * @type {Highcharts.Options}
  */ /**
 * @optionparent
-* @private
+* @internal
 */
 const defaultOptions = {
     /**
@@ -262,17 +263,17 @@ const defaultOptions = {
          * @since 1.2.4
          */
         resetZoom: 'Reset zoom',
-        /**
-         * The tooltip title for the label appearing when a chart is zoomed.
-         *
-         * @since 1.2.4
-         */
         /**
          * The default title of the Y axis
          *
          * @since 12.2.0
          */
         yAxisTitle: 'Values',
+        /**
+         * The tooltip title for the label appearing when a chart is zoomed.
+         *
+         * @since 1.2.4
+         */
         resetZoomTitle: 'Reset zoom level 1:1'
     },
     /**
@@ -484,7 +485,7 @@ const defaultOptions = {
          * `"UTC"`. Setting `useUTC` to false is equivalent to setting
          * `time.timezone` to `undefined`.
          *
-         * @see [time.timezone](#timezone)
+         * @see [timezone](#time.timezone)
          *
          * @sample {highcharts} highcharts/time/useutc-true/
          *         True by default
@@ -712,27 +713,6 @@ const defaultOptions = {
          * @since     2.1
          * @apioption subtitle.floating
          */
-        /**
-         * CSS styles for the title.
-         *
-         * In styled mode, the subtitle style is given in the
-         * `.highcharts-subtitle` class.
-         *
-         * @sample {highcharts} highcharts/subtitle/style/
-         *         Custom color and weight
-         * @sample {highcharts} highcharts/css/titles/
-         *         Styled mode
-         * @sample {highstock} stock/chart/subtitle-style
-         *         Custom color and weight
-         * @sample {highstock} highcharts/css/titles/
-         *         Styled mode
-         * @sample {highmaps} highcharts/css/titles/
-         *         Styled mode
-         *
-         * @type      {Highcharts.CSSObject}
-         * @default   {"color": "#666666"}
-         * @apioption subtitle.style
-         */
         /**
          * Whether to
          * [use HTML](https://www.highcharts.com/docs/chart-concepts/labels-and-string-formatting#html)
@@ -1024,7 +1004,7 @@ const defaultOptions = {
          *
          * @declare Highcharts.LegendEventsOptionsObject
          *
-         * @private
+         * @internal
          */
         events: {},
         /**
@@ -1876,8 +1856,17 @@ const defaultOptions = {
          * @apioption tooltip.borderColor
          */
         /**
-         * A CSS class name to apply to the tooltip's container div,
-         * allowing unique CSS styling for each chart.
+         * A CSS class name to apply to the tooltip, allowing unique CSS
+         * styling for each chart.
+         *
+         * **Note:** The class is applied to the SVG element of the tooltip
+         * (the tooltip label group), not to a container div. This allows you
+         * to style the tooltip using CSS applicable to SVG elements.
+         *
+         * When [tooltip.outside](#tooltip.outside) is `true`, a separate
+         * container div with class `highcharts-tooltip-container` is created
+         * as the parent to the SVG tooltip element, but the `className` option
+         * is still applied to the SVG element itself, not to the container.
          *
          * @type      {string}
          * @apioption tooltip.className
@@ -2150,35 +2139,6 @@ const defaultOptions = {
          * @product   highcharts highstock
          * @apioption tooltip.split
          */
-        /**
-         * Prevents the tooltip from switching or closing, when touched or
-         * pointed.
-         *
-         * @sample highcharts/tooltip/stickoncontact/
-         *         Tooltip sticks on pointer contact
-         *
-         * @type      {boolean}
-         * @since     8.0.1
-         * @apioption tooltip.stickOnContact
-         */
-        /**
-         * Use HTML to render the contents of the tooltip instead of SVG. Using
-         * HTML allows advanced formatting like tables and images in the
-         * tooltip. It is also recommended for rtl languages as it works around
-         * rtl bugs in early Firefox.
-         *
-         * @sample {highcharts|highstock} highcharts/tooltip/footerformat/
-         *         A table for value alignment
-         * @sample {highcharts|highstock} highcharts/tooltip/fullhtml/
-         *         Full HTML tooltip
-         * @sample {highmaps} maps/tooltip/usehtml/
-         *         Pure HTML tooltip
-         *
-         * @type      {boolean}
-         * @default   false
-         * @since     2.2
-         * @apioption tooltip.useHTML
-         */
         /**
          * How many decimals to show in each series' y value. This is
          * overridable in each series' tooltip options object. The default is to
@@ -2501,6 +2461,9 @@ const defaultOptions = {
          * contains the category name, x value or datetime string depending on
          * the type of axis. For datetime axes, the `point.key` date format can
          * be set using `tooltip.xDateFormat`.
+         * In v12+, locale-aware date names follow the browser's casing and can
+         * be lower-case, so use the `ucfirst` helper (for example
+         * `{ucfirst point.key}`) if you want a capitalized header.
          *
          * @sample {highcharts} highcharts/tooltip/footerformat/
          *         An HTML table in the tooltip
@@ -2615,13 +2578,14 @@ const defaultOptions = {
          * @apioption tooltip.shadow
          */
         /**
-         * Prevents the tooltip from switching or closing when touched or
+         * Prevents the tooltip from switching or closing, when touched or
          * pointed.
          *
          * @sample highcharts/tooltip/stickoncontact/
          *         Tooltip sticks on pointer contact
          *
-         * @since 8.0.1
+         * @type      {boolean}
+         * @since     8.0.1
          */
         stickOnContact: false,
         /**
@@ -2660,7 +2624,7 @@ const defaultOptions = {
          * @sample {highmaps} maps/tooltip/usehtml/
          *         Pure HTML tooltip
          *
-         * @since 2.2
+         * @since     2.2
          */
         useHTML: false
     },

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

@@ -1,19 +1 @@
-import type { XAxisOptions } from './Axis/AxisOptions';
-import type { ChartOptions } from './Chart/ChartOptions';
-import type { SeriesOptions } from './Series/SeriesOptions';
-import type { LegendOptions } from './Legend/LegendOptions';
-import Axis from './Axis/Axis.js';
-import Chart from './Chart/Chart.js';
-import Legend from './Legend/Legend.js';
-import Series from './Series/Series.js';
-declare namespace Foundation {
-    /**
-     * Register event options. If an event handler is set on the options, it
-     * should be subject to Chart.update, Axis.update and Series.update. This is
-     * contrary to general handlers that are set directly using addEvent either
-     * on the class or on the instance. #6538, #6943, #10861.
-     * @private
-     */
-    function registerEventOptions(component: Axis | Chart | Legend | Series, options: XAxisOptions | ChartOptions | LegendOptions | SeriesOptions): void;
-}
-export default Foundation;
+export {};

package/es-modules/Core/Foundation.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';
@@ -15,6 +16,7 @@ const { addEvent, isFunction, objectEach, removeEvent } = U;
  *  Class Namespace
  *
  * */
+/** @internal */
 var Foundation;
 (function (Foundation) {
     /* *
@@ -28,7 +30,7 @@ var Foundation;
      * should be subject to Chart.update, Axis.update and Series.update. This is
      * contrary to general handlers that are set directly using addEvent either
      * on the class or on the instance. #6538, #6943, #10861.
-     * @private
+     * @internal
      */
     function registerEventOptions(component, options) {
         // A lookup over those events that are added by _options_ (not
@@ -60,4 +62,5 @@ var Foundation;
  *  Default Export
  *
  * */
+/** @internal */
 export default Foundation;

package/es-modules/Core/Geometry/CircleObject.d.ts

@@ -0,0 +1,5 @@
+import type PositionObject from '../Renderer/PositionObject';
+export interface CircleObject extends PositionObject {
+    r: number;
+}
+export default CircleObject;

package/es-modules/Core/Geometry/CircleObject.js

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

package/es-modules/Core/Geometry/CircleUtilities.d.ts

@@ -1,189 +1 @@
-import type CircleObject from './CircleObject';
-import type GeometryObject from './GeometryObject';
-import type IntersectionObject from './IntersectionObject';
-import type PositionObject from '../Renderer/PositionObject';
-declare namespace CircleUtilities {
-    /**
-     * @private
-     *
-     * @param {number} x
-     * Number to round
-     *
-     * @param {number} decimals
-     * Number of decimals to round to
-     *
-     * @return {number}
-     * Rounded number
-     */
-    function round(x: number, decimals: number): number;
-    /**
-     * Calculates the area of a circle based on its radius.
-     *
-     * @private
-     *
-     * @param {number} r
-     * The radius of the circle.
-     *
-     * @return {number}
-     * Returns the area of the circle.
-     */
-    function getAreaOfCircle(r: number): number;
-    /**
-     * Calculates the area of a circular segment based on the radius of the
-     * circle and the height of the segment.
-     *
-     * @see http://mathworld.wolfram.com/CircularSegment.html
-     *
-     * @private
-     *
-     * @param {number} r
-     * The radius of the circle.
-     *
-     * @param {number} h
-     * The height of the circular segment.
-     *
-     * @return {number}
-     * Returns the area of the circular segment.
-     */
-    function getCircularSegmentArea(r: number, h: number): number;
-    /**
-     * Calculates the area of overlap between two circles based on their
-     * radiuses and the distance between them.
-     *
-     * @see http://mathworld.wolfram.com/Circle-CircleIntersection.html
-     *
-     * @private
-     *
-     * @param {number} r1
-     * Radius of the first circle.
-     *
-     * @param {number} r2
-     * Radius of the second circle.
-     *
-     * @param {number} d
-     * The distance between the two circles.
-     *
-     * @return {number}
-     * Returns the area of overlap between the two circles.
-     */
-    function getOverlapBetweenCircles(r1: number, r2: number, d: number): number;
-    /**
-     * Calculates the intersection points of two circles.
-     *
-     * NOTE: does not handle floating errors well.
-     *
-     * @private
-     *
-     * @param {Highcharts.CircleObject} c1
-     * The first circle.
-     *
-     * @param {Highcharts.CircleObject} c2
-     * The second circle.
-     *
-     * @return {Array<Highcharts.PositionObject>}
-     * Returns the resulting intersection points.
-     */
-    function getCircleCircleIntersection(c1: CircleObject, c2: CircleObject): Array<PositionObject>;
-    /**
-     * Calculates all the intersection points for between a list of circles.
-     *
-     * @private
-     *
-     * @param {Array<Highcharts.CircleObject>} circles
-     * The circles to calculate the points from.
-     *
-     * @return {Array<Highcharts.GeometryObject>}
-     * Returns a list of intersection points.
-     */
-    function getCirclesIntersectionPoints(circles: Array<CircleObject>): Array<GeometryObject>;
-    /**
-     * Tests whether the first circle is completely overlapping the second
-     * circle.
-     *
-     * @private
-     *
-     * @param {Highcharts.CircleObject} circle1
-     * The first circle.
-     *
-     * @param {Highcharts.CircleObject} circle2
-     * The second circle.
-     *
-     * @return {boolean}
-     * Returns true if circle1 is completely overlapping circle2, false if not.
-     */
-    function isCircle1CompletelyOverlappingCircle2(circle1: CircleObject, circle2: CircleObject): boolean;
-    /**
-     * Tests whether a point lies within a given circle.
-     * @private
-     * @param {Highcharts.PositionObject} point
-     * The point to test for.
-     *
-     * @param {Highcharts.CircleObject} circle
-     * The circle to test if the point is within.
-     *
-     * @return {boolean}
-     * Returns true if the point is inside, false if outside.
-     */
-    function isPointInsideCircle(point: PositionObject, circle: CircleObject): boolean;
-    /**
-     * Tests whether a point lies within a set of circles.
-     *
-     * @private
-     *
-     * @param {Highcharts.PositionObject} point
-     * The point to test.
-     *
-     * @param {Array<Highcharts.CircleObject>} circles
-     * The list of circles to test against.
-     *
-     * @return {boolean}
-     * Returns true if the point is inside all the circles, false if not.
-     */
-    function isPointInsideAllCircles(point: PositionObject, circles: Array<CircleObject>): boolean;
-    /**
-     * Tests whether a point lies outside a set of circles.
-     *
-     * TODO: add unit tests.
-     *
-     * @private
-     *
-     * @param {Highcharts.PositionObject} point
-     * The point to test.
-     *
-     * @param {Array<Highcharts.CircleObject>} circles
-     * The list of circles to test against.
-     *
-     * @return {boolean}
-     * Returns true if the point is outside all the circles, false if not.
-     */
-    function isPointOutsideAllCircles(point: PositionObject, circles: Array<CircleObject>): boolean;
-    /**
-     * Calculates the points for the polygon of the intersection area between
-     * a set of circles.
-     *
-     * @private
-     *
-     * @param {Array<Highcharts.CircleObject>} circles
-     * List of circles to calculate polygon of.
-     *
-     * @return {Array<Highcharts.GeometryObject>}
-     * Return list of points in the intersection polygon.
-     */
-    function getCirclesIntersectionPolygon(circles: Array<CircleObject>): Array<GeometryObject>;
-    /**
-     * Calculate the path for the area of overlap between a set of circles.
-     *
-     * @todo handle cases with only 1 or 0 arcs.
-     *
-     * @private
-     *
-     * @param {Array<Highcharts.CircleObject>} circles
-     * List of circles to calculate area of.
-     *
-     * @return {Highcharts.GeometryIntersectionObject|undefined}
-     * Returns the path for the area of overlap. Returns an empty string if
-     * there are no intersection between all the circles.
-     */
-    function getAreaOfIntersectionBetweenCircles(circles: Array<CircleObject>): (IntersectionObject | undefined);
-}
-export default CircleUtilities;
+export {};

package/es-modules/Core/Geometry/CircleUtilities.js

@@ -1,10 +1,10 @@
 /* *
  *
- *  (c) 2010-2025 Highsoft AS
+ *  (c) 2010-2026 Highsoft AS
  *
- *  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';
@@ -17,6 +17,7 @@ const { correctFloat } = Utilities;
  *  Namespace
  *
  * */
+/** @internal */
 var CircleUtilities;
 (function (CircleUtilities) {
     /* *
@@ -25,7 +26,7 @@ var CircleUtilities;
      *
      * */
     /**
-     * @private
+     * @internal
      *
      * @param {number} x
      * Number to round
@@ -44,7 +45,7 @@ var CircleUtilities;
     /**
      * Calculates the area of a circle based on its radius.
      *
-     * @private
+     * @internal
      *
      * @param {number} r
      * The radius of the circle.
@@ -65,7 +66,7 @@ var CircleUtilities;
      *
      * @see http://mathworld.wolfram.com/CircularSegment.html
      *
-     * @private
+     * @internal
      *
      * @param {number} r
      * The radius of the circle.
@@ -87,7 +88,7 @@ var CircleUtilities;
      *
      * @see http://mathworld.wolfram.com/Circle-CircleIntersection.html
      *
-     * @private
+     * @internal
      *
      * @param {number} r1
      * Radius of the first circle.
@@ -130,7 +131,7 @@ var CircleUtilities;
      *
      * NOTE: does not handle floating errors well.
      *
-     * @private
+     * @internal
      *
      * @param {Highcharts.CircleObject} c1
      * The first circle.
@@ -163,7 +164,7 @@ var CircleUtilities;
     /**
      * Calculates all the intersection points for between a list of circles.
      *
-     * @private
+     * @internal
      *
      * @param {Array<Highcharts.CircleObject>} circles
      * The circles to calculate the points from.
@@ -190,7 +191,7 @@ var CircleUtilities;
      * Tests whether the first circle is completely overlapping the second
      * circle.
      *
-     * @private
+     * @internal
      *
      * @param {Highcharts.CircleObject} circle1
      * The first circle.
@@ -207,7 +208,7 @@ var CircleUtilities;
     CircleUtilities.isCircle1CompletelyOverlappingCircle2 = isCircle1CompletelyOverlappingCircle2;
     /**
      * Tests whether a point lies within a given circle.
-     * @private
+     * @internal
      * @param {Highcharts.PositionObject} point
      * The point to test for.
      *
@@ -224,7 +225,7 @@ var CircleUtilities;
     /**
      * Tests whether a point lies within a set of circles.
      *
-     * @private
+     * @internal
      *
      * @param {Highcharts.PositionObject} point
      * The point to test.
@@ -246,7 +247,7 @@ var CircleUtilities;
      *
      * TODO: add unit tests.
      *
-     * @private
+     * @internal
      *
      * @param {Highcharts.PositionObject} point
      * The point to test.
@@ -267,7 +268,7 @@ var CircleUtilities;
      * Calculates the points for the polygon of the intersection area between
      * a set of circles.
      *
-     * @private
+     * @internal
      *
      * @param {Array<Highcharts.CircleObject>} circles
      * List of circles to calculate polygon of.
@@ -287,7 +288,7 @@ var CircleUtilities;
      *
      * @todo handle cases with only 1 or 0 arcs.
      *
-     * @private
+     * @internal
      *
      * @param {Array<Highcharts.CircleObject>} circles
      * List of circles to calculate area of.
@@ -385,4 +386,5 @@ var CircleUtilities;
  *  Default Export
  *
  * */
+/** @internal */
 export default CircleUtilities;