@highcharts/grid-pro 2.0.0

package/es-modules/Data/DataTableCore.d.ts

@@ -0,0 +1,165 @@
+import type DataEvent from './DataEvent.js';
+import type DataTable from './DataTable.js';
+import type DataTableOptions from './DataTableOptions.js';
+/**
+ * Class to manage columns and rows in a table structure. It provides methods
+ * to add, remove, and manipulate columns and rows, as well as to retrieve data
+ * from specific cells.
+ *
+ * @class
+ * @name Highcharts.DataTable
+ *
+ * @param {Highcharts.DataTableOptions} [options]
+ * Options to initialize the new DataTable instance.
+ */
+declare class DataTableCore {
+    /**
+     * Constructs an instance of the DataTable class.
+     *
+     * @example
+     * const dataTable = new Highcharts.DataTableCore({
+     *   columns: {
+     *     year: [2020, 2021, 2022, 2023],
+     *     cost: [11, 13, 12, 14],
+     *     revenue: [12, 15, 14, 18]
+     *   }
+     * });
+
+     *
+     * @param {Highcharts.DataTableOptions} [options]
+     * Options to initialize the new DataTable instance.
+     */
+    constructor(options?: DataTableOptions);
+    readonly autoId: boolean;
+    readonly columns: Record<string, DataTable.Column>;
+    readonly id: string;
+    modified?: this;
+    rowCount: number;
+    protected versionTag: string;
+    /**
+     * Applies a row count to the table by setting the `rowCount` property and
+     * adjusting the length of all columns.
+     *
+     * @private
+     * @param {number} rowCount The new row count.
+     */
+    protected applyRowCount(rowCount: number): void;
+    /**
+     * Delete rows. Simplified version of the full
+     * `DataTable.deleteRows` method.
+     *
+     * @param {number} rowIndex
+     * The start row index
+     *
+     * @param {number} [rowCount=1]
+     * The number of rows to delete
+     *
+     * @return {void}
+     *
+     * @emits #afterDeleteRows
+     */
+    deleteRows(rowIndex: number, rowCount?: number): void;
+    /**
+     * Fetches the given column by the canonical column name. Simplified version
+     * of the full `DataTable.getRow` method, always returning by reference.
+     *
+     * @param {string} columnId
+     * Name of the column to get.
+     *
+     * @return {Highcharts.DataTableColumn|undefined}
+     * A copy of the column, or `undefined` if not found.
+     */
+    getColumn(columnId: string, asReference?: true): (DataTable.Column | undefined);
+    /**
+     * Retrieves all or the given columns. Simplified version of the full
+     * `DataTable.getColumns` method, always returning by reference.
+     *
+     * @param {Array<string>} [columnIds]
+     * Column ids to retrieve.
+     *
+     * @return {Highcharts.DataTableColumnCollection}
+     * Collection of columns. If a requested column was not found, it is
+     * `undefined`.
+     */
+    getColumns(columnIds?: Array<string>, asReference?: true): DataTable.ColumnCollection;
+    /**
+     * Retrieves the row at a given index.
+     *
+     * @param {number} rowIndex
+     * Row index to retrieve. First row has index 0.
+     *
+     * @param {Array<string>} [columnIds]
+     * Column names to retrieve.
+     *
+     * @return {Record<string, number|string|undefined>|undefined}
+     * Returns the row values, or `undefined` if not found.
+     */
+    getRow(rowIndex: number, columnIds?: Array<string>): (DataTable.Row | undefined);
+    /**
+     * Sets cell values for a column. Will insert a new column, if not found.
+     *
+     * @param {string} columnId
+     * Column name to set.
+     *
+     * @param {Highcharts.DataTableColumn} [column]
+     * Values to set in the column.
+     *
+     * @param {number} [rowIndex]
+     * Index of the first row to change. (Default: 0)
+     *
+     * @param {Record<string, (boolean|number|string|null|undefined)>} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits #setColumns
+     * @emits #afterSetColumns
+     */
+    setColumn(columnId: string, column?: DataTable.Column, rowIndex?: number, eventDetail?: DataEvent.Detail): void;
+    /**
+     * Sets cell values for multiple columns. Will insert new columns, if not
+     * found. Simplified version of the full `DataTableCore.setColumns`, limited
+     * to full replacement of the columns (undefined `rowIndex`).
+     *
+     * @param {Highcharts.DataTableColumnCollection} columns
+     * Columns as a collection, where the keys are the column names.
+     *
+     * @param {number} [rowIndex]
+     * Index of the first row to change. Ignored in the `DataTableCore`, as it
+     * always replaces the full column.
+     *
+     * @param {Record<string, (boolean|number|string|null|undefined)>} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits #setColumns
+     * @emits #afterSetColumns
+     */
+    setColumns(columns: DataTable.ColumnCollection, rowIndex?: number, eventDetail?: DataEvent.Detail): void;
+    /**
+     * Sets cell values of a row. Will insert a new row if no index was
+     * provided, or if the index is higher than the total number of table rows.
+     * A simplified version of the full `DateTable.setRow`, limited to objects.
+     *
+     * @param {Record<string, number|string|undefined>} row
+     * Cell values to set.
+     *
+     * @param {number} [rowIndex]
+     * Index of the row to set. Leave `undefined` to add as a new row.
+     *
+     * @param {boolean} [insert]
+     * Whether to insert the row at the given index, or to overwrite the row.
+     *
+     * @param {Record<string, (boolean|number|string|null|undefined)>} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits #afterSetRows
+     */
+    setRow(row: DataTable.RowObject, rowIndex?: number, insert?: boolean, eventDetail?: DataEvent.Detail): void;
+    /**
+     * Returns the medified (clone) or the original data table if the modified
+     * one does not exist.
+     *
+     * @return {Highcharts.DataTableCore}
+     * The medified (clone) or the original data table.
+     */
+    getModified(): this;
+}
+export default DataTableCore;

package/es-modules/Data/DataTableCore.js

@@ -0,0 +1,316 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sophie Bremer
+ *  - Gøran Slettemark
+ *  - Torstein Hønsi
+ *
+ * */
+'use strict';
+import ColumnUtils from './ColumnUtils.js';
+const { setLength, splice } = ColumnUtils;
+import U from '../Core/Utilities.js';
+const { fireEvent, objectEach, uniqueKey } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Class to manage columns and rows in a table structure. It provides methods
+ * to add, remove, and manipulate columns and rows, as well as to retrieve data
+ * from specific cells.
+ *
+ * @class
+ * @name Highcharts.DataTable
+ *
+ * @param {Highcharts.DataTableOptions} [options]
+ * Options to initialize the new DataTable instance.
+ */
+class DataTableCore {
+    /**
+     * Constructs an instance of the DataTable class.
+     *
+     * @example
+     * const dataTable = new Highcharts.DataTableCore({
+     *   columns: {
+     *     year: [2020, 2021, 2022, 2023],
+     *     cost: [11, 13, 12, 14],
+     *     revenue: [12, 15, 14, 18]
+     *   }
+     * });
+
+     *
+     * @param {Highcharts.DataTableOptions} [options]
+     * Options to initialize the new DataTable instance.
+     */
+    constructor(options = {}) {
+        /**
+         * Whether the ID was automatic generated or given in the constructor.
+         *
+         * @name Highcharts.DataTable#autoId
+         * @type {boolean}
+         */
+        this.autoId = !options.id;
+        this.columns = {};
+        /**
+         * ID of the table for identification purposes.
+         *
+         * @name Highcharts.DataTable#id
+         * @type {string}
+         */
+        this.id = (options.id || uniqueKey());
+        this.rowCount = 0;
+        this.versionTag = uniqueKey();
+        let rowCount = 0;
+        objectEach(options.columns || {}, (column, columnId) => {
+            this.columns[columnId] = column.slice();
+            rowCount = Math.max(rowCount, column.length);
+        });
+        this.applyRowCount(rowCount);
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Applies a row count to the table by setting the `rowCount` property and
+     * adjusting the length of all columns.
+     *
+     * @private
+     * @param {number} rowCount The new row count.
+     */
+    applyRowCount(rowCount) {
+        this.rowCount = rowCount;
+        objectEach(this.columns, (column, columnId) => {
+            if (column.length !== rowCount) {
+                this.columns[columnId] = setLength(column, rowCount);
+            }
+        });
+    }
+    /**
+     * Delete rows. Simplified version of the full
+     * `DataTable.deleteRows` method.
+     *
+     * @param {number} rowIndex
+     * The start row index
+     *
+     * @param {number} [rowCount=1]
+     * The number of rows to delete
+     *
+     * @return {void}
+     *
+     * @emits #afterDeleteRows
+     */
+    deleteRows(rowIndex, rowCount = 1) {
+        if (rowCount > 0 && rowIndex < this.rowCount) {
+            let length = 0;
+            objectEach(this.columns, (column, columnId) => {
+                this.columns[columnId] =
+                    splice(column, rowIndex, rowCount).array;
+                length = column.length;
+            });
+            this.rowCount = length;
+        }
+        fireEvent(this, 'afterDeleteRows', { rowIndex, rowCount });
+        this.versionTag = uniqueKey();
+    }
+    /**
+     * Fetches the given column by the canonical column name. Simplified version
+     * of the full `DataTable.getRow` method, always returning by reference.
+     *
+     * @param {string} columnId
+     * Name of the column to get.
+     *
+     * @return {Highcharts.DataTableColumn|undefined}
+     * A copy of the column, or `undefined` if not found.
+     */
+    getColumn(columnId, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    asReference) {
+        return this.columns[columnId];
+    }
+    /**
+     * Retrieves all or the given columns. Simplified version of the full
+     * `DataTable.getColumns` method, always returning by reference.
+     *
+     * @param {Array<string>} [columnIds]
+     * Column ids to retrieve.
+     *
+     * @return {Highcharts.DataTableColumnCollection}
+     * Collection of columns. If a requested column was not found, it is
+     * `undefined`.
+     */
+    getColumns(columnIds, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    asReference) {
+        return (columnIds || Object.keys(this.columns)).reduce((columns, columnId) => {
+            columns[columnId] = this.columns[columnId];
+            return columns;
+        }, {});
+    }
+    /**
+     * Retrieves the row at a given index.
+     *
+     * @param {number} rowIndex
+     * Row index to retrieve. First row has index 0.
+     *
+     * @param {Array<string>} [columnIds]
+     * Column names to retrieve.
+     *
+     * @return {Record<string, number|string|undefined>|undefined}
+     * Returns the row values, or `undefined` if not found.
+     */
+    getRow(rowIndex, columnIds) {
+        return (columnIds || Object.keys(this.columns)).map((key) => this.columns[key]?.[rowIndex]);
+    }
+    /**
+     * Sets cell values for a column. Will insert a new column, if not found.
+     *
+     * @param {string} columnId
+     * Column name to set.
+     *
+     * @param {Highcharts.DataTableColumn} [column]
+     * Values to set in the column.
+     *
+     * @param {number} [rowIndex]
+     * Index of the first row to change. (Default: 0)
+     *
+     * @param {Record<string, (boolean|number|string|null|undefined)>} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits #setColumns
+     * @emits #afterSetColumns
+     */
+    setColumn(columnId, column = [], rowIndex = 0, eventDetail) {
+        this.setColumns({ [columnId]: column }, rowIndex, eventDetail);
+    }
+    /**
+     * Sets cell values for multiple columns. Will insert new columns, if not
+     * found. Simplified version of the full `DataTableCore.setColumns`, limited
+     * to full replacement of the columns (undefined `rowIndex`).
+     *
+     * @param {Highcharts.DataTableColumnCollection} columns
+     * Columns as a collection, where the keys are the column names.
+     *
+     * @param {number} [rowIndex]
+     * Index of the first row to change. Ignored in the `DataTableCore`, as it
+     * always replaces the full column.
+     *
+     * @param {Record<string, (boolean|number|string|null|undefined)>} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits #setColumns
+     * @emits #afterSetColumns
+     */
+    setColumns(columns, rowIndex, eventDetail) {
+        let rowCount = this.rowCount;
+        objectEach(columns, (column, columnId) => {
+            this.columns[columnId] = column.slice();
+            rowCount = column.length;
+        });
+        this.applyRowCount(rowCount);
+        if (!eventDetail?.silent) {
+            fireEvent(this, 'afterSetColumns');
+            this.versionTag = uniqueKey();
+        }
+    }
+    /**
+     * Sets cell values of a row. Will insert a new row if no index was
+     * provided, or if the index is higher than the total number of table rows.
+     * A simplified version of the full `DateTable.setRow`, limited to objects.
+     *
+     * @param {Record<string, number|string|undefined>} row
+     * Cell values to set.
+     *
+     * @param {number} [rowIndex]
+     * Index of the row to set. Leave `undefined` to add as a new row.
+     *
+     * @param {boolean} [insert]
+     * Whether to insert the row at the given index, or to overwrite the row.
+     *
+     * @param {Record<string, (boolean|number|string|null|undefined)>} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits #afterSetRows
+     */
+    setRow(row, rowIndex = this.rowCount, insert, eventDetail) {
+        const { columns } = this, indexRowCount = insert ? this.rowCount + 1 : rowIndex + 1;
+        objectEach(row, (cellValue, columnId) => {
+            let column = columns[columnId] ||
+                eventDetail?.addColumns !== false && new Array(indexRowCount);
+            if (column) {
+                if (insert) {
+                    column = splice(column, rowIndex, 0, true, [cellValue]).array;
+                }
+                else {
+                    column[rowIndex] = cellValue;
+                }
+                columns[columnId] = column;
+            }
+        });
+        if (indexRowCount > this.rowCount) {
+            this.applyRowCount(indexRowCount);
+        }
+        if (!eventDetail?.silent) {
+            fireEvent(this, 'afterSetRows');
+            this.versionTag = uniqueKey();
+        }
+    }
+    /**
+     * Returns the medified (clone) or the original data table if the modified
+     * one does not exist.
+     *
+     * @return {Highcharts.DataTableCore}
+     * The medified (clone) or the original data table.
+     */
+    getModified() {
+        return this.modified || this;
+    }
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default DataTableCore;
+/* *
+ *
+ *  API Declarations
+ *
+ * */
+/**
+ * A typed array.
+ * @typedef {Int8Array|Uint8Array|Uint8ClampedArray|Int16Array|Uint16Array|Int32Array|Uint32Array|Float32Array|Float64Array} Highcharts.TypedArray
+ * //**
+ * A column of values in a data table.
+ * @typedef {Array<boolean|null|number|string|undefined>|Highcharts.TypedArray} Highcharts.DataTableColumn
+ */ /**
+* A collection of data table columns defined by a object where the key is the
+* column name and the value is an array of the column values.
+* @typedef {Record<string, Highcharts.DataTableColumn>} Highcharts.DataTableColumnCollection
+*/
+/**
+ * Options for the `DataTable` or `DataTableCore` classes.
+ * @interface Highcharts.DataTableOptions
+ */ /**
+* The column options for the data table. The columns are defined by an object
+* where the key is the column ID and the value is an array of the column
+* values.
+*
+* @name Highcharts.DataTableOptions.columns
+* @type {Highcharts.DataTableColumnCollection|undefined}
+*/ /**
+* Custom ID to identify the new DataTable instance.
+*
+* @name Highcharts.DataTableOptions.id
+* @type {string|undefined}
+*/
+(''); // Keeps doclets above in JS file

package/es-modules/Data/DataTableOptions.d.ts

@@ -0,0 +1,25 @@
+import type { TypedArray } from '../Shared/Types';
+/**
+ * Options to initialize a new DataTable instance.
+ */
+export interface DataTableOptions {
+    /**
+     * Initial columns with their values.
+     */
+    columns?: Record<string, Array<DataTableValue> | TypedArray>;
+    /**
+     * Custom ID to identify the new DataTable instance.
+     */
+    id?: string;
+    /**
+     * A reference to the specific data table key defined in the component's
+     * connector options.
+     */
+    key?: string;
+    /**
+     * Metadata to describe the dataTable.
+     */
+    metadata?: Record<string, DataTableValue>;
+}
+export type DataTableValue = (boolean | null | number | string | undefined);
+export default DataTableOptions;

package/es-modules/Data/DataTableOptions.js

@@ -0,0 +1,15 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sophie Bremer
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+export {};

package/es-modules/Data/Formula/Formula.d.ts

@@ -0,0 +1,21 @@
+import './Functions/ABS.js';
+import './Functions/AND.js';
+import './Functions/AVERAGE.js';
+import './Functions/AVERAGEA.js';
+import './Functions/COUNT.js';
+import './Functions/COUNTA.js';
+import './Functions/IF.js';
+import './Functions/ISNA.js';
+import './Functions/MAX.js';
+import './Functions/MEDIAN.js';
+import './Functions/MIN.js';
+import './Functions/MOD.js';
+import './Functions/MODE.js';
+import './Functions/NOT.js';
+import './Functions/OR.js';
+import './Functions/PRODUCT.js';
+import './Functions/SUM.js';
+import './Functions/XOR.js';
+export type { FormulaParserError } from './FormulaParser';
+export type { Arguments, Formula, Function, Item, Operator, Range, Reference, Term, Value } from './FormulaTypes';
+export default Formula;

package/es-modules/Data/Formula/Formula.js

@@ -0,0 +1,54 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sophie Bremer
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  Imports
+ *
+ * */
+import FormulaParser from './FormulaParser.js';
+import FormulaProcessor from './FormulaProcessor.js';
+import FormulaType from './FormulaTypes.js';
+import './Functions/ABS.js';
+import './Functions/AND.js';
+import './Functions/AVERAGE.js';
+import './Functions/AVERAGEA.js';
+import './Functions/COUNT.js';
+import './Functions/COUNTA.js';
+import './Functions/IF.js';
+import './Functions/ISNA.js';
+import './Functions/MAX.js';
+import './Functions/MEDIAN.js';
+import './Functions/MIN.js';
+import './Functions/MOD.js';
+import './Functions/MODE.js';
+import './Functions/NOT.js';
+import './Functions/OR.js';
+import './Functions/PRODUCT.js';
+import './Functions/SUM.js';
+import './Functions/XOR.js';
+/* *
+ *
+ *  Default Export
+ *
+ * */
+/**
+ * Formula engine to make use of spreadsheet formula strings.
+ * @internal
+ */
+const Formula = {
+    ...FormulaParser,
+    ...FormulaProcessor,
+    ...FormulaType
+};
+export default Formula;

package/es-modules/Data/Formula/FormulaParser.d.ts

@@ -0,0 +1,31 @@
+import type { Formula } from './FormulaTypes.js';
+/**
+ * Formula parser might struggle over a syntax error.
+ * @private
+ */
+export interface FormulaParserError extends Error {
+    message: string;
+    name: 'FormulaParseError';
+}
+/**
+ * Converts a spreadsheet formula string into a formula array. Throws a
+ * `FormulaParserError` when the string can not be parsed.
+ *
+ * @private
+ * @function Formula.parseFormula
+ *
+ * @param {string} text
+ * Spreadsheet formula string, without the leading `=`.
+ *
+ * @param {boolean} alternativeSeparators
+ * * `false` to expect `,` between arguments and `.` in decimals.
+ * * `true` to expect `;` between arguments and `,` in decimals.
+ *
+ * @return {Formula.Formula}
+ * Formula array representing the string.
+ */
+declare function parseFormula(text: string, alternativeSeparators: boolean): Formula;
+declare const FormulaParser: {
+    parseFormula: typeof parseFormula;
+};
+export default FormulaParser;