@highcharts/grid-pro 2.0.0

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

@@ -0,0 +1,112 @@
+import type ColorString from './ColorString';
+import type { ColorBase, ColorType } from './ColorType';
+/**
+ * Handle color operations. Some object methods are chainable.
+ *
+ * @class
+ * @name Highcharts.Color
+ *
+ * @param {Highcharts.ColorType} input
+ * The input color.
+ */
+declare class Color implements ColorBase {
+    /**
+     * Collection of named colors. Can be extended from the outside by adding
+     * colors to Highcharts.Color.names.
+     * @private
+     */
+    static names: Record<string, ColorString>;
+    /**
+     * Collection of parsers. This can be extended from the outside by pushing
+     * parsers to `Color.parsers`.
+     * @private
+     */
+    static parsers: {
+        regex: RegExp;
+        parse: (result: RegExpExecArray) => Color.RGBA;
+    }[];
+    /**
+     * Whether to use CSS `color-mix` for color handling (brightening,
+     * tweening). This can be disabled from the outside.
+     * @private
+     */
+    static useColorMix: boolean;
+    static readonly None: Color;
+    /**
+     * Creates a color instance out of a color string or object.
+     *
+     * @function Highcharts.Color.parse
+     *
+     * @param {Highcharts.ColorType} [input]
+     * The input color.
+     *
+     * @return {Highcharts.Color}
+     * Color instance.
+     */
+    static parse(input?: ColorType): Color;
+    constructor(input: ColorType);
+    input: ColorType;
+    output?: string;
+    rgba: Color.RGBA;
+    stops?: Array<Color>;
+    /**
+     * Return the color or gradient stops in the specified format
+     *
+     * @function Highcharts.Color#get
+     *
+     * @param {string} [format]
+     * Possible values are 'a', 'rgb', 'rgba' (default).
+     *
+     * @return {Highcharts.ColorType}
+     * This color as a string or gradient stops.
+     */
+    get(format?: ('a' | 'rgb' | 'rgba')): ColorType;
+    /**
+     * Brighten the color instance.
+     *
+     * @function Highcharts.Color#brighten
+     *
+     * @param {number} alpha
+     * The alpha value.
+     *
+     * @return {Highcharts.Color}
+     * This color with modifications.
+     */
+    brighten(alpha: number): this;
+    /**
+     * Set the color's opacity to a given alpha value.
+     *
+     * @function Highcharts.Color#setOpacity
+     *
+     * @param {number} alpha
+     *        Opacity between 0 and 1.
+     *
+     * @return {Highcharts.Color}
+     *         Color with modifications.
+     */
+    setOpacity(alpha: number): this;
+    /**
+     * Return an intermediate color between two colors.
+     *
+     * @function Highcharts.Color#tweenTo
+     *
+     * @param {Highcharts.Color} to
+     * The color object to tween to.
+     *
+     * @param {number} pos
+     * The intermediate position, where 0 is the from color (current color
+     * item), and 1 is the `to` color.
+     *
+     * @return {Highcharts.ColorType}
+     * The intermediate color in rgba notation, or unsupported type.
+     */
+    tweenTo(to: Color, pos: number): ColorType;
+}
+declare namespace Color {
+    interface Parser {
+        regex: RegExp;
+        parse: (result: RegExpExecArray) => RGBA;
+    }
+    type RGBA = [number, number, number, number];
+}
+export default Color;

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

@@ -0,0 +1,418 @@
+/* *
+ *
+ *  (c) 2010-2025 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+'use strict';
+import H from '../Globals.js';
+const { win } = H;
+import U from '../Utilities.js';
+const { isNumber, isString, merge, pInt, defined } = U;
+/* *
+ *
+ *  Helpers
+ *
+ * */
+const colorMix = (color1, color2, weight) => `color-mix(in srgb,${color1},${color2} ${weight * 100}%)`;
+const isStringColor = (color) => isString(color) && !!color && color !== 'none';
+/* *
+ *
+ *  Class
+ *
+ * */
+/* eslint-disable valid-jsdoc */
+/**
+ * Handle color operations. Some object methods are chainable.
+ *
+ * @class
+ * @name Highcharts.Color
+ *
+ * @param {Highcharts.ColorType} input
+ * The input color.
+ */
+class Color {
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
+    /**
+     * Creates a color instance out of a color string or object.
+     *
+     * @function Highcharts.Color.parse
+     *
+     * @param {Highcharts.ColorType} [input]
+     * The input color.
+     *
+     * @return {Highcharts.Color}
+     * Color instance.
+     */
+    static parse(input) {
+        return input ? new Color(input) : Color.None;
+    }
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    constructor(input) {
+        this.rgba = [NaN, NaN, NaN, NaN];
+        this.input = input;
+        const GlobalColor = H.Color;
+        // Backwards compatibility, allow class overwrite
+        if (GlobalColor && GlobalColor !== Color) {
+            return new GlobalColor(input);
+        }
+        let result, rgba, i, parser;
+        // Gradients
+        if (typeof input === 'object' &&
+            typeof input.stops !== 'undefined') {
+            this.stops = input.stops.map((stop) => new Color(stop[1]));
+            // Solid colors
+        }
+        else if (typeof input === 'string') {
+            this.input = input = (Color.names[input.toLowerCase()] || input);
+            i = Color.parsers.length;
+            while (i-- && !rgba) {
+                parser = Color.parsers[i];
+                result = parser.regex.exec(input);
+                if (result) {
+                    rgba = parser.parse(result);
+                }
+            }
+        }
+        if (rgba) {
+            this.rgba = rgba;
+        }
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Return the color or gradient stops in the specified format
+     *
+     * @function Highcharts.Color#get
+     *
+     * @param {string} [format]
+     * Possible values are 'a', 'rgb', 'rgba' (default).
+     *
+     * @return {Highcharts.ColorType}
+     * This color as a string or gradient stops.
+     */
+    get(format) {
+        const input = this.input, rgba = this.rgba;
+        if (this.output) {
+            return this.output;
+        }
+        if (typeof input === 'object' &&
+            typeof this.stops !== 'undefined') {
+            const ret = merge(input);
+            ret.stops = [].slice.call(ret.stops);
+            this.stops.forEach((stop, i) => {
+                ret.stops[i] = [
+                    ret.stops[i][0],
+                    stop.get(format)
+                ];
+            });
+            return ret;
+        }
+        // It's NaN if gradient colors on a column chart
+        if (rgba && isNumber(rgba[0])) {
+            if (format === 'rgb' || (!format && rgba[3] === 1)) {
+                return 'rgb(' + rgba[0] + ',' + rgba[1] + ',' + rgba[2] + ')';
+            }
+            if (format === 'a') {
+                return `${rgba[3]}`;
+            }
+            return 'rgba(' + rgba.join(',') + ')';
+        }
+        return input;
+    }
+    /**
+     * Brighten the color instance.
+     *
+     * @function Highcharts.Color#brighten
+     *
+     * @param {number} alpha
+     * The alpha value.
+     *
+     * @return {Highcharts.Color}
+     * This color with modifications.
+     */
+    brighten(alpha) {
+        const rgba = this.rgba;
+        if (this.stops) {
+            this.stops.forEach(function (stop) {
+                stop.brighten(alpha);
+            });
+        }
+        else if (isNumber(alpha) && alpha !== 0) {
+            if (isNumber(rgba[0])) {
+                for (let i = 0; i < 3; i++) {
+                    rgba[i] += pInt(alpha * 255);
+                    if (rgba[i] < 0) {
+                        rgba[i] = 0;
+                    }
+                    if (rgba[i] > 255) {
+                        rgba[i] = 255;
+                    }
+                }
+            }
+            else if (Color.useColorMix && isStringColor(this.input)) {
+                this.output = colorMix(this.input, alpha > 0 ? 'white' : 'black', Math.abs(alpha));
+            }
+        }
+        return this;
+    }
+    /**
+     * Set the color's opacity to a given alpha value.
+     *
+     * @function Highcharts.Color#setOpacity
+     *
+     * @param {number} alpha
+     *        Opacity between 0 and 1.
+     *
+     * @return {Highcharts.Color}
+     *         Color with modifications.
+     */
+    setOpacity(alpha) {
+        this.rgba[3] = alpha;
+        return this;
+    }
+    /**
+     * Return an intermediate color between two colors.
+     *
+     * @function Highcharts.Color#tweenTo
+     *
+     * @param {Highcharts.Color} to
+     * The color object to tween to.
+     *
+     * @param {number} pos
+     * The intermediate position, where 0 is the from color (current color
+     * item), and 1 is the `to` color.
+     *
+     * @return {Highcharts.ColorType}
+     * The intermediate color in rgba notation, or unsupported type.
+     */
+    tweenTo(to, pos) {
+        const fromRgba = this.rgba, toRgba = to.rgba;
+        // Unsupported color, return to-color (#3920, #7034)
+        if (!isNumber(fromRgba[0]) || !isNumber(toRgba[0])) {
+            if (Color.useColorMix &&
+                isStringColor(this.input) &&
+                isStringColor(to.input) &&
+                pos < 0.99) {
+                return colorMix(this.input, to.input, pos);
+            }
+            return to.input || 'none';
+        }
+        // Check for has alpha, because rgba colors perform worse due to
+        // lack of support in WebKit.
+        const hasAlpha = (toRgba[3] !== 1 || fromRgba[3] !== 1), channel = (to, i) => to + (fromRgba[i] - to) * (1 - pos), rgba = toRgba.slice(0, 3).map(channel).map(Math.round);
+        if (hasAlpha) {
+            rgba.push(channel(toRgba[3], 3));
+        }
+        return (hasAlpha ? 'rgba(' : 'rgb(') + rgba.join(',') + ')';
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Collection of named colors. Can be extended from the outside by adding
+ * colors to Highcharts.Color.names.
+ * @private
+ */
+Color.names = {
+    white: '#ffffff',
+    black: '#000000'
+};
+/**
+ * Collection of parsers. This can be extended from the outside by pushing
+ * parsers to `Color.parsers`.
+ * @private
+ */
+Color.parsers = [{
+        // RGBA color
+        // eslint-disable-next-line max-len
+        regex: /rgba\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d?(?:\.\d+)?)\s*\)/,
+        parse: function (result) {
+            return [
+                pInt(result[1]),
+                pInt(result[2]),
+                pInt(result[3]),
+                parseFloat(result[4], 10)
+            ];
+        }
+    }, {
+        // RGB color
+        regex: /rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)/,
+        parse: function (result) {
+            return [pInt(result[1]), pInt(result[2]), pInt(result[3]), 1];
+        }
+    }, {
+        // RGBA 3 & 4 digit hex color, e.g. #F0F, #F0FA
+        regex: /^#([a-f0-9])([a-f0-9])([a-f0-9])([a-f0-9])?$/i,
+        parse: function (result) {
+            // #abcd => #aabbccdd, hence result + result.
+            return [
+                (pInt(result[1] + result[1], 16)),
+                (pInt(result[2] + result[2], 16)),
+                (pInt(result[3] + result[3], 16)),
+                !defined(result[4]) ?
+                    1 :
+                    (pInt(result[4] + result[4], 16) / 255)
+            ];
+        }
+    }, {
+        // RGBA 6 & 8 digit hex color, e.g. #FFCC00, #FFCC00FF
+        regex: /^#([a-f0-9]{2})([a-f0-9]{2})([a-f0-9]{2})([a-f0-9]{2})?$/i,
+        parse: function (result) {
+            return [
+                pInt(result[1], 16),
+                pInt(result[2], 16),
+                pInt(result[3], 16),
+                !defined(result[4]) ?
+                    1 :
+                    (pInt(result[4], 16) / 255)
+            ];
+        }
+    }];
+/**
+ * Whether to use CSS `color-mix` for color handling (brightening,
+ * tweening). This can be disabled from the outside.
+ * @private
+ */
+Color.useColorMix = win.CSS?.supports('color', 'color-mix(in srgb,red,blue 9%)');
+// Must be last static member for init cycle
+Color.None = new Color('');
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default Color;
+/* *
+ *
+ *  API Declarations
+ *
+ * */
+/**
+ * A valid color to be parsed and handled by Highcharts.
+ *
+ * @typedef {string} Highcharts.ColorString
+ */
+/**
+ * A valid color type than can be parsed and handled by Highcharts. It can be a
+ * color string, a gradient object, or a pattern object.
+ *
+ * @typedef {Highcharts.ColorString|Highcharts.GradientColorObject|Highcharts.PatternObject} Highcharts.ColorType
+ */
+/**
+ * Gradient options instead of a solid color.
+ *
+ * @example
+ * // Linear gradient used as a color option
+ * color: {
+ *     linearGradient: { x1: 0, x2: 0, y1: 0, y2: 1 },
+ *     stops: [
+ *         [0, '#003399'], // start
+ *         [0.5, '#ffffff'], // middle
+ *         [1, '#3366AA'] // end
+ *     ]
+ * }
+ *
+ * @interface Highcharts.GradientColorObject
+ */ /**
+* Holds an object that defines the start position and the end position relative
+* to the shape.
+* @name Highcharts.GradientColorObject#linearGradient
+* @type {Highcharts.LinearGradientColorObject|undefined}
+*/ /**
+* Holds an object that defines the center position and the radius.
+* @name Highcharts.GradientColorObject#radialGradient
+* @type {Highcharts.RadialGradientColorObject|undefined}
+*/ /**
+* The first item in each tuple is the position in the gradient, where 0 is the
+* start of the gradient and 1 is the end of the gradient. Multiple stops can be
+* applied. The second item is the color for each stop. This color can also be
+* given in the rgba format.
+* @name Highcharts.GradientColorObject#stops
+* @type {Array<Highcharts.GradientColorStopObject>}
+*/
+/**
+ * Color stop tuple.
+ *
+ * @see Highcharts.GradientColorObject
+ *
+ * @interface Highcharts.GradientColorStopObject
+ */ /**
+* @name Highcharts.GradientColorStopObject#0
+* @type {number}
+*/ /**
+* @name Highcharts.GradientColorStopObject#1
+* @type {Highcharts.ColorString}
+*/ /**
+* @name Highcharts.GradientColorStopObject#color
+* @type {Highcharts.Color|undefined}
+*/
+/**
+ * Defines the start position and the end position for a gradient relative
+ * to the shape. Start position (x1, y1) and end position (x2, y2) are relative
+ * to the shape, where 0 means top/left and 1 is bottom/right.
+ *
+ * @interface Highcharts.LinearGradientColorObject
+ */ /**
+* Start horizontal position of the gradient. Float ranges 0-1.
+* @name Highcharts.LinearGradientColorObject#x1
+* @type {number}
+*/ /**
+* End horizontal position of the gradient. Float ranges 0-1.
+* @name Highcharts.LinearGradientColorObject#x2
+* @type {number}
+*/ /**
+* Start vertical position of the gradient. Float ranges 0-1.
+* @name Highcharts.LinearGradientColorObject#y1
+* @type {number}
+*/ /**
+* End vertical position of the gradient. Float ranges 0-1.
+* @name Highcharts.LinearGradientColorObject#y2
+* @type {number}
+*/
+/**
+ * Defines the center position and the radius for a gradient.
+ *
+ * @interface Highcharts.RadialGradientColorObject
+ */ /**
+* Center horizontal position relative to the shape. Float ranges 0-1.
+* @name Highcharts.RadialGradientColorObject#cx
+* @type {number}
+*/ /**
+* Center vertical position relative to the shape. Float ranges 0-1.
+* @name Highcharts.RadialGradientColorObject#cy
+* @type {number}
+*/ /**
+* Radius relative to the shape. Float ranges 0-1.
+* @name Highcharts.RadialGradientColorObject#r
+* @type {number}
+*/
+/**
+ * Creates a color instance out of a color string.
+ *
+ * @function Highcharts.color
+ *
+ * @param {Highcharts.ColorType} input
+ *        The input color.
+ *
+ * @return {Highcharts.Color}
+ *         Color instance
+ */
+(''); // Detach doclets above

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

@@ -0,0 +1,84 @@
+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;

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

@@ -0,0 +1,23 @@
+/**
+ * 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
+ */
+const SeriesPalettes = {
+    /**
+     * Colors for data series and points
+     */
+    colors: [
+        '#2caffe',
+        '#544fc5',
+        '#00e272',
+        '#fe6a35',
+        '#6b8abc',
+        '#d568fb',
+        '#2ee0ca',
+        '#fa4b42',
+        '#feb56a',
+        '#91e8e1'
+    ],
+};
+export default SeriesPalettes;

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

@@ -0,0 +1,42 @@
+import type { DeepPartial } from '../Shared/Types';
+import type { DefaultOptions, Options } from './Options';
+import Time from './Time.js';
+declare module './GlobalsBase' {
+    interface GlobalsBase {
+        defaultOptions: DefaultOptions;
+        time: Time;
+    }
+}
+/**
+ * Get the updated default options. Until 3.0.7, merely exposing defaultOptions
+ * for outside modules wasn't enough because the setOptions method created a new
+ * object.
+ *
+ * @function Highcharts.getOptions
+ *
+ * @return {Highcharts.Options}
+ * Default options.
+ */
+declare function getOptions(): DefaultOptions;
+/**
+ * Merge the default options with custom options and return the new options
+ * structure. Commonly used for defining reusable templates.
+ *
+ * @sample highcharts/members/setoptions Applying a global theme
+ *
+ * @function Highcharts.setOptions
+ *
+ * @param {Highcharts.Options} options
+ * The new custom chart options.
+ *
+ * @return {Highcharts.Options}
+ * Updated options.
+ */
+declare function setOptions(options: DeepPartial<DefaultOptions>): Options;
+declare const DefaultOptions: {
+    defaultOptions: DefaultOptions;
+    defaultTime: Time;
+    getOptions: typeof getOptions;
+    setOptions: typeof setOptions;
+};
+export default DefaultOptions;