@highcharts/grid-pro 2.0.0

package/es-modules/Data/Modifiers/MathModifier.js

@@ -0,0 +1,165 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sophie Bremer
+ *
+ * */
+'use strict';
+import DataModifier from './DataModifier.js';
+import FormulaParser from '../Formula/FormulaParser.js';
+import FormulaProcessor from '../Formula/FormulaProcessor.js';
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Replaces formula strings in a table with calculated values.
+ *
+ * @class
+ * @name Highcharts.DataModifier.types.MathModifier
+ * @augments Highcharts.DataModifier
+ */
+class MathModifier extends DataModifier {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    constructor(options) {
+        super();
+        this.options = {
+            ...MathModifier.defaultOptions,
+            ...options
+        };
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    modifyTable(table, eventDetail) {
+        const modifier = this;
+        modifier.emit({ type: 'modify', detail: eventDetail, table });
+        const alternativeSeparators = modifier.options.alternativeSeparators, formulaColumns = (modifier.options.formulaColumns ||
+            table.getColumnIds()), modified = table.getModified();
+        for (let i = 0, iEnd = formulaColumns.length, columnId; i < iEnd; ++i) {
+            columnId = formulaColumns[i];
+            if (formulaColumns.indexOf(columnId) >= 0) {
+                modified.setColumn(columnId, modifier.processColumn(table, columnId));
+            }
+        }
+        const columnFormulas = (modifier.options.columnFormulas || []);
+        for (let i = 0, iEnd = columnFormulas.length, columnFormula, formula; i < iEnd; ++i) {
+            columnFormula = columnFormulas[i];
+            formula = FormulaParser.parseFormula(columnFormula.formula, alternativeSeparators);
+            modified.setColumn(columnFormula.column, modifier.processColumnFormula(formula, table, columnFormula.rowStart, columnFormula.rowEnd));
+        }
+        modifier.emit({ type: 'afterModify', detail: eventDetail, table });
+        return table;
+    }
+    /**
+     * Process a column by replacing formula strings with calculated values.
+     *
+     * @private
+     *
+     * @param {Highcharts.DataTable} table
+     * Table to extract column from and use as reference.
+     *
+     * @param {string} columnId
+     * Id of column to process.
+     *
+     * @param {number} rowIndex
+     * Row index to start the replacing process from.
+     *
+     * @return {Highcharts.DataTableColumn}
+     * Returns the processed table column.
+     */
+    processColumn(table, columnId, rowIndex = 0) {
+        const alternativeSeparators = this.options.alternativeSeparators, column = (table.getColumn(columnId, true) || [])
+            .slice(rowIndex > 0 ? rowIndex : 0);
+        for (let i = 0, iEnd = column.length, cacheFormula = [], cacheString = '', cell; i < iEnd; ++i) {
+            cell = column[i];
+            if (typeof cell === 'string' &&
+                cell[0] === '=') {
+                try {
+                    // Use cache while formula string is repetitive
+                    cacheFormula = (cacheString === cell ?
+                        cacheFormula :
+                        FormulaParser.parseFormula(cell.substring(1), alternativeSeparators));
+                    // Process parsed formula string
+                    column[i] =
+                        FormulaProcessor.processFormula(cacheFormula, table);
+                }
+                catch {
+                    column[i] = NaN;
+                }
+            }
+        }
+        return column;
+    }
+    /**
+     * Process a column by replacing cell values with calculated values from a
+     * given formula.
+     *
+     * @private
+     *
+     * @param {Highcharts.Formula} formula
+     * Formula to use for processing.
+     *
+     * @param {Highcharts.DataTable} table
+     * Table to extract column from and use as reference.
+     *
+     * @param {number} rowStart
+     * Row index to start the replacing process from.
+     *
+     * @param {number} rowEnd
+     * Row index to end the replacing process.
+     *
+     * @return {Highcharts.DataTableColumn}
+     * Returns the processed table column.
+     */
+    processColumnFormula(formula, table, rowStart = 0, rowEnd = table.getRowCount()) {
+        rowStart = rowStart >= 0 ? rowStart : 0;
+        rowEnd = rowEnd >= 0 ? rowEnd : table.getRowCount() + rowEnd;
+        const column = [], modified = table.getModified();
+        for (let i = 0, iEnd = (rowEnd - rowStart); i < iEnd; ++i) {
+            try {
+                column[i] = FormulaProcessor.processFormula(formula, modified);
+            }
+            catch {
+                column[i] = NaN;
+            }
+            finally {
+                formula = FormulaProcessor.translateReferences(formula, 0, 1);
+            }
+        }
+        return column;
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Default options of MathModifier.
+ * @private
+ */
+MathModifier.defaultOptions = {
+    type: 'Math',
+    alternativeSeparators: false
+};
+DataModifier.registerType('Math', MathModifier);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default MathModifier;

package/es-modules/Data/Modifiers/MathModifierOptions.d.ts

@@ -0,0 +1,50 @@
+import type DataModifierOptions from './DataModifierOptions';
+/**
+ * Options to configure a formula replacing column values.
+ */
+export interface MathModifierColumnFormulaOptions {
+    /**
+     * Column name in the DataTable to replace with values of the
+     * formula.
+     */
+    column: string;
+    /**
+     * Formula to use to replace column values.
+     */
+    formula: string;
+    /**
+     * Row index to end the replacing process.
+     */
+    rowEnd?: number;
+    /**
+     * Row index to start the replacing process from.
+     */
+    rowStart?: number;
+}
+/**
+ * Options to configure the MathModifier and Formula system.
+ */
+export interface MathModifierOptions extends DataModifierOptions {
+    /**
+     * Name of the related modifier for these options.
+     */
+    type: 'Math';
+    /**
+     * Whether to expect regular or alternative separators in formulas.
+     * * `false` to expect `,` between arguments and `.` in decimals.
+     * * `true` to expect `;` between arguments and `,` in decimals.
+     */
+    alternativeSeparators: boolean;
+    /**
+     * Array of column formulas that will be used to replace the column
+     * values in their columns.
+     */
+    columnFormulas?: Array<MathModifierColumnFormulaOptions>;
+    /**
+     * Array of column names to replace formula strings to
+     * replace with calculated values. By default all columns in a table
+     * will be processed.
+     */
+    formulaColumns?: Array<string>;
+}
+export default MathModifierOptions;

package/es-modules/Data/Modifiers/MathModifierOptions.js

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

package/es-modules/Data/Modifiers/RangeModifier.d.ts

@@ -0,0 +1,46 @@
+import type DataEvent from '../DataEvent';
+import type { RangeModifierOptions } from './RangeModifierOptions';
+import DataModifier from './DataModifier.js';
+import DataTable from '../DataTable.js';
+/**
+ * Slices the table rows based on the specified range.
+ */
+declare class RangeModifier extends DataModifier {
+    /**
+     * Default options for the range modifier.
+     */
+    static readonly defaultOptions: RangeModifierOptions;
+    /**
+     * Constructs an instance of the range modifier.
+     *
+     * @param {Partial<RangeModifier.Options>} [options]
+     * Options to configure the range modifier.
+     */
+    constructor(options?: Partial<RangeModifierOptions>);
+    /**
+     * Options of the range modifier.
+     */
+    readonly options: RangeModifierOptions;
+    /**
+     * Replaces table rows with ranged rows. If the given table does not have
+     * defined a `modified` property, the filtering is applied in-place on the
+     * original table rather than on a `modified` copy.
+     *
+     * @param {DataTable} table
+     * Table to modify.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {DataTable}
+     * Table with `modified` property as a reference or modified table, if
+     * `modified` property of the original table is undefined.
+     */
+    modifyTable(table: DataTable, eventDetail?: DataEvent.Detail): DataTable;
+}
+declare module './DataModifierType' {
+    interface DataModifierTypes {
+        Range: typeof RangeModifier;
+    }
+}
+export default RangeModifier;

package/es-modules/Data/Modifiers/RangeModifier.js

@@ -0,0 +1,96 @@
+/* *
+ *
+ *  (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';
+import DataModifier from './DataModifier.js';
+import U from '../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Slices the table rows based on the specified range.
+ */
+class RangeModifier extends DataModifier {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the range modifier.
+     *
+     * @param {Partial<RangeModifier.Options>} [options]
+     * Options to configure the range modifier.
+     */
+    constructor(options) {
+        super();
+        this.options = merge(RangeModifier.defaultOptions, options);
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Replaces table rows with ranged rows. If the given table does not have
+     * defined a `modified` property, the filtering is applied in-place on the
+     * original table rather than on a `modified` copy.
+     *
+     * @param {DataTable} table
+     * Table to modify.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {DataTable}
+     * Table with `modified` property as a reference or modified table, if
+     * `modified` property of the original table is undefined.
+     */
+    modifyTable(table, eventDetail) {
+        const modifier = this;
+        modifier.emit({ type: 'modify', detail: eventDetail, table });
+        let { start, end } = modifier.options;
+        start = Math.max(0, start || 0);
+        end = Math.min(end || Infinity, table.getRowCount());
+        const length = Math.max(end - start, 0);
+        const modified = table.getModified();
+        modified.deleteRows();
+        modified.setRows(table.getRows(start, length));
+        modified.setOriginalRowIndexes(Array.from({ length }, (_, i) => table.getOriginalRowIndex(start + i)));
+        modifier.emit({ type: 'afterModify', detail: eventDetail, table });
+        return table;
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Default options for the range modifier.
+ */
+RangeModifier.defaultOptions = {
+    type: 'Range',
+    start: 0,
+    end: Infinity
+};
+DataModifier.registerType('Range', RangeModifier);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default RangeModifier;

package/es-modules/Data/Modifiers/RangeModifierOptions.d.ts

@@ -0,0 +1,22 @@
+import type DataModifierOptions from './DataModifierOptions';
+/**
+ * Options to configure the modifier.
+ */
+export interface RangeModifierOptions extends DataModifierOptions {
+    /**
+     * Name of the related modifier for these options.
+     */
+    type: 'Range';
+    /**
+     * Zero-based index at which to start the range. If not set, the range
+     * starts at the beginning of the table.
+     */
+    start?: number;
+    /**
+     * Zero-based index at which to end the range. The row at this index
+     * is not included in the range. If not set, the range ends at the end of
+     * the table.
+     */
+    end?: number;
+}
+export default RangeModifierOptions;

package/es-modules/Data/Modifiers/RangeModifierOptions.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/Modifiers/SortModifier.d.ts

@@ -0,0 +1,54 @@
+import type DataEvent from '../DataEvent';
+import type SortModifierOptions from './SortModifierOptions';
+import DataModifier from './DataModifier.js';
+import DataTable from '../DataTable.js';
+/** @private */
+interface SortRowReference {
+    index: number;
+    row: DataTable.Row;
+}
+/**
+ * Sort table rows according to values of a column.
+ *
+ */
+declare class SortModifier extends DataModifier {
+    /**
+     * Default options to group table rows.
+     */
+    static readonly defaultOptions: SortModifierOptions;
+    private static ascending;
+    private static descending;
+    private static compareFactory;
+    /**
+     * Constructs an instance of the sort modifier.
+     *
+     * @param {Partial<SortDataModifier.Options>} [options]
+     * Options to configure the sort modifier.
+     */
+    constructor(options?: Partial<SortModifierOptions>);
+    options: SortModifierOptions;
+    /**
+     * Returns index and row for sort reference.
+     *
+     * @private
+     *
+     * @param {Highcharts.DataTable} table
+     * Table with rows to reference.
+     *
+     * @return {Array<SortModifier.RowReference>}
+     * Array of row references.
+     */
+    protected getRowReferences(table: DataTable): Array<SortRowReference>;
+    modifyTable(table: DataTable, eventDetail?: DataEvent.Detail): DataTable;
+}
+/**
+ * Additionally provided types for modifier events and options.
+ */
+declare namespace SortModifier {
+}
+declare module './DataModifierType' {
+    interface DataModifierTypes {
+        Sort: typeof SortModifier;
+    }
+}
+export default SortModifier;

package/es-modules/Data/Modifiers/SortModifier.js

@@ -0,0 +1,144 @@
+/* *
+ *
+ *  (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';
+import DataModifier from './DataModifier.js';
+import U from '../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Sort table rows according to values of a column.
+ *
+ */
+class SortModifier extends DataModifier {
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
+    static ascending(a, b) {
+        return ((a || 0) < (b || 0) ? -1 :
+            (a || 0) > (b || 0) ? 1 :
+                0);
+    }
+    static descending(a, b) {
+        return ((b || 0) < (a || 0) ? -1 :
+            (b || 0) > (a || 0) ? 1 :
+                0);
+    }
+    static compareFactory(direction, customCompare) {
+        if (customCompare) {
+            if (direction === 'desc') {
+                return (a, b) => -customCompare(a, b);
+            }
+            return customCompare;
+        }
+        return (direction === 'asc' ?
+            SortModifier.ascending :
+            SortModifier.descending);
+    }
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the sort modifier.
+     *
+     * @param {Partial<SortDataModifier.Options>} [options]
+     * Options to configure the sort modifier.
+     */
+    constructor(options) {
+        super();
+        this.options = merge(SortModifier.defaultOptions, options);
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Returns index and row for sort reference.
+     *
+     * @private
+     *
+     * @param {Highcharts.DataTable} table
+     * Table with rows to reference.
+     *
+     * @return {Array<SortModifier.RowReference>}
+     * Array of row references.
+     */
+    getRowReferences(table) {
+        const rows = table.getRows(), rowReferences = [];
+        for (let i = 0, iEnd = rows.length; i < iEnd; ++i) {
+            rowReferences.push({
+                index: i,
+                row: rows[i]
+            });
+        }
+        return rowReferences;
+    }
+    modifyTable(table, eventDetail) {
+        const modifier = this;
+        modifier.emit({ type: 'modify', detail: eventDetail, table });
+        const columnIds = table.getColumnIds(), rowCount = table.getRowCount(), rowReferences = this.getRowReferences(table), { direction, orderByColumn, orderInColumn, compare: customCompare } = modifier.options, compare = SortModifier.compareFactory(direction, customCompare), orderByColumnIndex = columnIds.indexOf(orderByColumn), modified = table.getModified();
+        if (orderByColumnIndex !== -1) {
+            rowReferences.sort((a, b) => compare(a.row[orderByColumnIndex], b.row[orderByColumnIndex]));
+        }
+        if (orderInColumn) {
+            const column = [];
+            for (let i = 0; i < rowCount; ++i) {
+                column[rowReferences[i].index] = i;
+            }
+            modified.setColumns({ [orderInColumn]: column });
+        }
+        else {
+            const originalIndexes = [];
+            const rows = [];
+            let rowReference;
+            for (let i = 0; i < rowCount; ++i) {
+                rowReference = rowReferences[i];
+                originalIndexes.push(table.getOriginalRowIndex(rowReference.index));
+                rows.push(rowReference.row);
+            }
+            modified.setRows(rows, 0);
+            modified.setOriginalRowIndexes(originalIndexes);
+        }
+        modifier.emit({ type: 'afterModify', detail: eventDetail, table });
+        return table;
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Default options to group table rows.
+ */
+SortModifier.defaultOptions = {
+    type: 'Sort',
+    direction: 'desc',
+    orderByColumn: 'y'
+};
+DataModifier.registerType('Sort', SortModifier);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default SortModifier;

package/es-modules/Data/Modifiers/SortModifierOptions.d.ts

@@ -0,0 +1,44 @@
+import type DataModifierOptions from './DataModifierOptions';
+import type DataTable from '../DataTable';
+/**
+ * Options to configure the modifier.
+ */
+export interface SortModifierOptions extends DataModifierOptions {
+    /**
+     * Name of the related modifier for these options.
+     */
+    type: 'Sort';
+    /**
+     * Direction of sorting.
+     *
+     * @default "desc"
+     */
+    direction: ('asc' | 'desc');
+    /**
+     * Custom compare function to sort the column values. It overrides the
+     * default sorting behavior. If not set, the default sorting behavior is
+     * used.
+     *
+     * @param a
+     * The first value to compare.
+     *
+     * @param b
+     * The second value to compare.
+     *
+     * @return
+     * A number indicating whether the first value (`a`) is less than (`-1`),
+     * equal to (`0`), or greater than (`1`) the second value (`b`).
+     */
+    compare?: (a: DataTable.CellType, b: DataTable.CellType) => number;
+    /**
+     * Column with values to order.
+     *
+     * @default "y"
+     */
+    orderByColumn: string;
+    /**
+     * Column to update with order index instead of change order of rows.
+     */
+    orderInColumn?: string;
+}
+export default SortModifierOptions;

package/es-modules/Data/Modifiers/SortModifierOptions.js

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