@highcharts/grid-pro 2.0.0

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

@@ -0,0 +1,53 @@
+import type DataEvent from '../DataEvent';
+import type { FilterModifierOptions } from './FilterModifierOptions';
+import DataModifier from './DataModifier.js';
+import DataTable from '../DataTable.js';
+/**
+ * Filters out table rows matching a given condition.
+ */
+declare class FilterModifier extends DataModifier {
+    /**
+     * Default options for the filter modifier.
+     */
+    static readonly defaultOptions: FilterModifierOptions;
+    /**
+     * Compiles a filter condition into a callback function.
+     *
+     * @param {FilterCondition} condition
+     * Condition to compile.
+     */
+    private static compile;
+    /**
+     * Constructs an instance of the filter modifier.
+     *
+     * @param {Partial<FilterModifier.Options>} [options]
+     * Options to configure the filter modifier.
+     */
+    constructor(options?: Partial<FilterModifierOptions>);
+    /**
+     * Options of the filter modifier.
+     */
+    readonly options: FilterModifierOptions;
+    /**
+     * Filters out table rows matching a given condition. 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 {
+        Filter: typeof FilterModifier;
+    }
+}
+export default FilterModifier;

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

@@ -0,0 +1,172 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+import DataModifier from './DataModifier.js';
+import U from '../../Core/Utilities.js';
+const { isFunction, merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Filters out table rows matching a given condition.
+ */
+class FilterModifier extends DataModifier {
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
+    /**
+     * Compiles a filter condition into a callback function.
+     *
+     * @param {FilterCondition} condition
+     * Condition to compile.
+     */
+    static compile(condition) {
+        if (isFunction(condition)) {
+            return condition;
+        }
+        const op = condition.operator;
+        switch (op) {
+            case 'and': {
+                const subs = condition.conditions.map((c) => this.compile(c));
+                return (row, table, i) => subs.every((cond) => cond(row, table, i));
+            }
+            case 'or': {
+                const subs = condition.conditions.map((c) => this.compile(c));
+                return (row, table, i) => subs.some((cond) => cond(row, table, i));
+            }
+            case 'not': {
+                const sub = this.compile(condition.condition);
+                return (row, table, i) => !sub(row, table, i);
+            }
+        }
+        const { columnId: col, value } = condition;
+        switch (op) {
+            case '==':
+                // eslint-disable-next-line eqeqeq
+                return (row) => row[col] == value;
+            case '===':
+                return (row) => row[col] === value;
+            case '!=':
+                // eslint-disable-next-line eqeqeq
+                return (row) => row[col] != value;
+            case '!==':
+                return (row) => row[col] !== value;
+            case '>':
+                return (row) => (row[col] || 0) > (value || 0);
+            case '>=':
+                return (row) => (row[col] || 0) >= (value || 0);
+            case '<':
+                return (row) => (row[col] || 0) < (value || 0);
+            case '<=':
+                return (row) => (row[col] || 0) <= (value || 0);
+            case 'empty':
+                return (row) => row[col] === null || row[col] === '';
+        }
+        const { ignoreCase } = condition;
+        const str = (val) => {
+            const s = '' + val;
+            return (ignoreCase ?? true) ? s.toLowerCase() : s;
+        };
+        switch (op) {
+            case 'contains':
+                return (row) => str(row[col]).includes(str(value));
+            default:
+                return (row) => str(row[col])[op](str(value));
+        }
+    }
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the filter modifier.
+     *
+     * @param {Partial<FilterModifier.Options>} [options]
+     * Options to configure the filter modifier.
+     */
+    constructor(options) {
+        super();
+        this.options = merge(FilterModifier.defaultOptions, options);
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Filters out table rows matching a given condition. 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 });
+        const { condition } = modifier.options;
+        if (!condition) {
+            // If no condition is set, return the unmodified table.
+            return table;
+        }
+        const matchRow = FilterModifier.compile(condition);
+        const modified = table.getModified();
+        const rows = [];
+        const indexes = [];
+        for (let i = 0, iEnd = table.getRowCount(); i < iEnd; ++i) {
+            const row = table.getRowObject(i);
+            if (!row) {
+                continue;
+            }
+            if (matchRow(row, table, i)) {
+                rows.push(row);
+                indexes.push(table.getOriginalRowIndex(i));
+            }
+        }
+        modified.deleteRows();
+        modified.setRows(rows);
+        modified.setOriginalRowIndexes(indexes);
+        modifier.emit({ type: 'afterModify', detail: eventDetail, table });
+        return table;
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Default options for the filter modifier.
+ */
+FilterModifier.defaultOptions = {
+    type: 'Filter'
+};
+DataModifier.registerType('Filter', FilterModifier);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default FilterModifier;

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

@@ -0,0 +1,110 @@
+import type DataModifierOptions from './DataModifierOptions';
+import type DataTable from '../DataTable';
+/**
+ * Condition that uses an universal comparison operators.
+ */
+export interface ComparisonCondition {
+    /**
+     * Type of the operator used in the condition, comparing the value of the
+     * cell with the provided value.
+     */
+    operator: '==' | '!=' | '===' | '!==' | '>' | '>=' | '<' | '<=' | 'empty';
+    /**
+     * Name of the column to compare the value of the cell with.
+     */
+    columnId: string;
+    /**
+     * Value to compare the cell with.
+     */
+    value: DataTable.CellType;
+}
+/**
+ * Condition that uses string comparison operators.
+ */
+export interface StringCondition {
+    /**
+     * Type of the operator used in the condition, comparing the value of the
+     * cell with the provided value. Non-string values are converted to
+     * strings before comparison.
+     */
+    operator: 'contains' | 'startsWith' | 'endsWith';
+    /**
+     * Name of the column to compare the value of the cell with.
+     */
+    columnId: string;
+    /**
+     * Whether the comparison should ignore case.
+     * @default true
+     */
+    ignoreCase?: boolean;
+    /**
+     * Value to compare the cell with.
+     */
+    value: string;
+}
+/**
+ * Condition that combines multiple conditions with logical operators.
+ */
+export interface LogicalMultipleCondition {
+    /**
+     * Type of the operator used to combine the conditions.
+     */
+    operator: 'and' | 'or';
+    /**
+     * Array of conditions that are combined with the logical operator.
+     */
+    conditions: FilterCondition[];
+}
+/**
+ * Condition that transforms a single condition with a logical operator.
+ */
+export interface LogicalSingleCondition {
+    /**
+     * Type of the operator used to transform the condition.
+     */
+    operator: 'not';
+    /**
+     * Condition that is transformed by the logical operator.
+     */
+    condition: FilterCondition;
+}
+/**
+ * Callback condition that is used to filter rows in a table.
+ *
+ * @param row
+ * Row object to check.
+ *
+ * @param table
+ * Data table that the row belongs to.
+ *
+ * @param rowIndex
+ * Index of the row in the table.
+ */
+export type CallbackCondition = (row: DataTable.RowObject, table: DataTable, rowIndex: number) => boolean;
+/**
+ * Serializable condition that can be used to filter rows in a table.
+ */
+export type SerializableCondition = ComparisonCondition | StringCondition | LogicalSingleCondition | LogicalMultipleCondition;
+/**
+ * Type of the operator used in a filter condition.
+ */
+export type FilterOperator = SerializableCondition['operator'];
+/**
+ * Type of the value used in a filter condition.
+ */
+export type FilterCondition = CallbackCondition | SerializableCondition;
+/**
+ * Options to configure the modifier.
+ */
+export interface FilterModifierOptions extends DataModifierOptions {
+    /**
+     * Name of the related modifier for these options.
+     */
+    type: 'Filter';
+    /**
+     * Condition that must be met for a row to be included in the modified
+     * table.
+     */
+    condition?: FilterCondition;
+}
+export default FilterModifierOptions;

package/es-modules/Data/Modifiers/FilterModifierOptions.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:
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+export {};

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

@@ -0,0 +1,48 @@
+import type DataEvent from '../DataEvent';
+import type InvertModifierOptions from './InvertModifierOptions';
+import DataModifier from './DataModifier.js';
+import DataTable from '../DataTable.js';
+/**
+ * Inverts columns and rows in a table.
+ *
+ * @private
+ */
+declare class InvertModifier extends DataModifier {
+    /**
+     * Default options for the invert modifier.
+     */
+    static readonly defaultOptions: InvertModifierOptions;
+    /**
+     * Constructs an instance of the invert modifier.
+     *
+     * @param {Partial<InvertModifier.Options>} [options]
+     * Options to configure the invert modifier.
+     */
+    constructor(options?: Partial<InvertModifierOptions>);
+    /**
+     * Options of the invert modifier.
+     */
+    options: InvertModifierOptions;
+    /**
+     * Inverts rows and columns in the table. 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 invert.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {DataTable}
+     * Table with inverted `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 {
+        Invert: typeof InvertModifier;
+    }
+}
+export default InvertModifier;

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

@@ -0,0 +1,116 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Wojciech Chmiel
+ *  - Sophie Bremer
+ *
+ * */
+'use strict';
+import DataModifier from './DataModifier.js';
+import U from '../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Inverts columns and rows in a table.
+ *
+ * @private
+ */
+class InvertModifier extends DataModifier {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the invert modifier.
+     *
+     * @param {Partial<InvertModifier.Options>} [options]
+     * Options to configure the invert modifier.
+     */
+    constructor(options) {
+        super();
+        this.options = merge(InvertModifier.defaultOptions, options);
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Inverts rows and columns in the table. 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 invert.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {DataTable}
+     * Table with inverted `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 });
+        const modified = table.getModified();
+        if (table.hasColumns(['columnIds'])) { // Inverted table
+            const columnIdsColumn = ((table.deleteColumns(['columnIds']) || {})
+                .columnIds || []), columns = {}, columnIds = [];
+            for (let i = 0, iEnd = columnIdsColumn.length; i < iEnd; ++i) {
+                columnIds.push('' + columnIdsColumn[i]);
+            }
+            for (let i = 0, iEnd = table.getRowCount(), row; i < iEnd; ++i) {
+                row = table.getRow(i);
+                if (row) {
+                    columns[columnIds[i]] = row;
+                }
+            }
+            modified.deleteColumns();
+            modified.setColumns(columns);
+        }
+        else { // Regular table
+            const columns = {};
+            for (let i = 0, iEnd = table.getRowCount(), row; i < iEnd; ++i) {
+                row = table.getRow(i);
+                if (row) {
+                    columns[`${i}`] = row;
+                }
+            }
+            columns.columnIds = table.getColumnIds();
+            modified.deleteColumns();
+            modified.setColumns(columns);
+        }
+        modifier.emit({ type: 'afterModify', detail: eventDetail, table });
+        return table;
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Default options for the invert modifier.
+ */
+InvertModifier.defaultOptions = {
+    type: 'Invert'
+};
+DataModifier.registerType('Invert', InvertModifier);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default InvertModifier;

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

@@ -0,0 +1,11 @@
+import type DataModifierOptions from './DataModifierOptions';
+/**
+ * Options to configure the modifier.
+ */
+export interface InvertModifierOptions extends DataModifierOptions {
+    /**
+     * Name of the related modifier for these options.
+     */
+    type: 'Invert';
+}
+export default InvertModifierOptions;

package/es-modules/Data/Modifiers/InvertModifierOptions.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:
+ *  - Wojciech Chmiel
+ *  - Sophie Bremer
+ *
+ * */
+'use strict';
+export {};

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

@@ -0,0 +1,68 @@
+import type DataEvent from '../DataEvent';
+import type DataTable from '../DataTable';
+import type { Formula } from '../Formula/Formula';
+import type { MathModifierOptions } from './MathModifierOptions';
+import DataModifier from './DataModifier.js';
+/**
+ * Replaces formula strings in a table with calculated values.
+ *
+ * @class
+ * @name Highcharts.DataModifier.types.MathModifier
+ * @augments Highcharts.DataModifier
+ */
+declare class MathModifier extends DataModifier {
+    /**
+     * Default options of MathModifier.
+     * @private
+     */
+    static readonly defaultOptions: MathModifierOptions;
+    constructor(options: Partial<MathModifierOptions>);
+    options: MathModifierOptions;
+    modifyTable(table: DataTable, eventDetail?: DataEvent.Detail): DataTable;
+    /**
+     * 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.
+     */
+    protected processColumn(table: DataTable, columnId: string, rowIndex?: number): DataTable.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.
+     */
+    protected processColumnFormula(formula: Formula, table: DataTable, rowStart?: number, rowEnd?: number): DataTable.Column;
+}
+declare module './DataModifierType' {
+    interface DataModifierTypes {
+        Math: typeof MathModifier;
+    }
+}
+export default MathModifier;