@highcharts/grid-pro 2.0.0

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

@@ -0,0 +1,231 @@
+/* *
+ *
+ *  (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 { addEvent, fireEvent, merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Modifies a table with the help of modifiers in an ordered chain.
+ *
+ */
+class ChainModifier extends DataModifier {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the modifier chain.
+     *
+     * @param {Partial<ChainModifier.Options>} [options]
+     * Options to configure the modifier chain.
+     *
+     * @param {...DataModifier} [chain]
+     * Ordered chain of modifiers.
+     */
+    constructor(options, ...chain) {
+        super();
+        this.chain = chain;
+        this.options = merge(ChainModifier.defaultOptions, options);
+        const optionsChain = this.options.chain || [];
+        for (let i = 0, iEnd = optionsChain.length, modifierOptions, ModifierClass; i < iEnd; ++i) {
+            modifierOptions = optionsChain[i];
+            if (!modifierOptions.type) {
+                continue;
+            }
+            ModifierClass = DataModifier.types[modifierOptions.type];
+            if (ModifierClass) {
+                chain.push(new ModifierClass(modifierOptions));
+            }
+        }
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Adds a configured modifier to the end of the modifier chain. Please note,
+     * that the modifier can be added multiple times.
+     *
+     * @param {DataModifier} modifier
+     * Configured modifier to add.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     */
+    add(modifier, eventDetail) {
+        this.emit({
+            type: 'addModifier',
+            detail: eventDetail,
+            modifier
+        });
+        this.chain.push(modifier);
+        this.emit({
+            type: 'addModifier',
+            detail: eventDetail,
+            modifier
+        });
+    }
+    /**
+     * Clears all modifiers from the chain.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     */
+    clear(eventDetail) {
+        this.emit({
+            type: 'clearChain',
+            detail: eventDetail
+        });
+        this.chain.length = 0;
+        this.emit({
+            type: 'afterClearChain',
+            detail: eventDetail
+        });
+    }
+    /**
+     * Sequentially applies all modifiers in the chain to the given table,
+     * updating its `modified` property with the final result.
+     *
+     * *Note:* The `modified` property reference of the table gets replaced.
+     *
+     * @param {Highcharts.DataTable} table
+     * Table to modify.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {Promise<Highcharts.DataTable>}
+     * Table with `modified` property as a reference.
+     */
+    async modify(table, eventDetail) {
+        const modifiers = (this.options.reverse ?
+            this.chain.slice().reverse() :
+            this.chain.slice());
+        if (!table.modified) {
+            table.modified = table.clone(false, eventDetail);
+        }
+        let modified = table;
+        for (let i = 0, iEnd = modifiers.length; i < iEnd; ++i) {
+            try {
+                await modifiers[i].modify(modified, eventDetail);
+            }
+            catch (error) {
+                this.emit({
+                    type: 'error',
+                    detail: eventDetail,
+                    table
+                });
+                throw error;
+            }
+            modified = modified.getModified();
+        }
+        table.modified = modified;
+        return table;
+    }
+    /**
+     * Applies several modifications to the table.
+     *
+     * *Note:* The `modified` property reference of the table gets replaced.
+     *
+     * @param {DataTable} table
+     * Table to modify.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {DataTable}
+     * Table as a reference.
+     *
+     * @emits ChainDataModifier#execute
+     * @emits ChainDataModifier#afterExecute
+     */
+    modifyTable(table, eventDetail) {
+        const chain = this;
+        chain.emit({
+            type: 'modify',
+            detail: eventDetail,
+            table
+        });
+        const modifiers = (chain.options.reverse ?
+            chain.chain.reverse() :
+            chain.chain.slice());
+        let modified = table.getModified();
+        for (let i = 0, iEnd = modifiers.length, modifier; i < iEnd; ++i) {
+            modifier = modifiers[i];
+            modified =
+                modifier.modifyTable(modified, eventDetail).getModified();
+        }
+        table.modified = modified;
+        chain.emit({
+            type: 'afterModify',
+            detail: eventDetail,
+            table
+        });
+        return table;
+    }
+    /**
+     * Removes a configured modifier from all positions in the modifier chain.
+     *
+     * @param {DataModifier} modifier
+     * Configured modifier to remove.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     */
+    remove(modifier, eventDetail) {
+        const modifiers = this.chain;
+        this.emit({
+            type: 'removeModifier',
+            detail: eventDetail,
+            modifier
+        });
+        modifiers.splice(modifiers.indexOf(modifier), 1);
+        this.emit({
+            type: 'afterRemoveModifier',
+            detail: eventDetail,
+            modifier
+        });
+    }
+    emit(e) {
+        fireEvent(this, e.type, e);
+    }
+    on(type, callback) {
+        return addEvent(this, type, callback);
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Default option for the ordered modifier chain.
+ */
+ChainModifier.defaultOptions = {
+    type: 'Chain'
+};
+DataModifier.registerType('Chain', ChainModifier);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default ChainModifier;

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

@@ -0,0 +1,20 @@
+import type DataModifierOptions from './DataModifierOptions';
+import type { DataModifierTypeOptions } from './DataModifierType';
+/**
+ * Options to configure the chain modifier.
+ */
+export interface ChainModifierOptions extends DataModifierOptions {
+    /**
+     * Name of the related modifier for these options.
+     */
+    type: 'Chain';
+    /**
+     * Array of options of the chain modifiers.
+     */
+    chain?: Array<Partial<DataModifierTypeOptions>>;
+    /**
+     * Whether to revert the order before execution.
+     */
+    reverse?: boolean;
+}
+export default ChainModifierOptions;

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

@@ -0,0 +1,117 @@
+import type DataEvent from '../DataEvent';
+import type DataModifierEvent from './DataModifierEvent';
+import type DataModifierOptions from './DataModifierOptions';
+import type DataTable from '../DataTable';
+import type { DataModifierTypes } from './DataModifierType';
+/**
+ * Abstract class to provide an interface for modifying a table.
+ */
+declare abstract class DataModifier implements DataEvent.Emitter<DataModifierEvent> {
+    /**
+     * Modifier options.
+     */
+    abstract readonly options: DataModifierOptions;
+    /**
+     * Runs a timed execution of the modifier on the given datatable.
+     * Can be configured to run multiple times.
+     *
+     * @param {DataTable} dataTable
+     * The datatable to execute
+     *
+     * @param {DataModifier.BenchmarkOptions} options
+     * Options. Currently supports `iterations` for number of iterations.
+     *
+     * @return {Array<number>}
+     * An array of times in milliseconds
+     *
+     */
+    benchmark(dataTable: DataTable, options?: DataModifier.BenchmarkOptions): Array<number>;
+    /**
+     * Emits an event on the modifier to all registered callbacks of this event.
+     *
+     * @param {DataModifier.Event} [e]
+     * Event object containing additonal event information.
+     */
+    emit<E extends DataModifierEvent>(e: E): void;
+    /**
+     * Modifies the given table and sets its `modified` property as a reference
+     * to the modified table. If `modified` property does not exist on the
+     * original table, it's always created.
+     *
+     * @param {Highcharts.DataTable} table
+     * Table to modify.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {Promise<Highcharts.DataTable>}
+     * Table with `modified` property as a reference.
+     */
+    modify(table: DataTable, eventDetail?: DataEvent.Detail): Promise<DataTable>;
+    /**
+     * Creates a modified copy of the given table and sets its `modified`
+     * property as a reference to the modified table. If `modified` property
+     * does not exist, the original table is changed.
+     *
+     * @param {Highcharts.DataTable} table
+     * Table to modify.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {Highcharts.DataTable}
+     * Table with `modified` property as a reference or modified table, if
+     * `modified` property of the original table is undefined.
+     */
+    abstract modifyTable(table: DataTable, eventDetail?: DataEvent.Detail): DataTable;
+    /**
+     * Registers a callback for a specific modifier event.
+     *
+     * @param {string} type
+     * Event type as a string.
+     *
+     * @param {DataEventEmitter.Callback} callback
+     * Function to register for an modifier callback.
+     *
+     * @return {Function}
+     * Function to unregister callback from the modifier event.
+     */
+    on<T extends DataModifierEvent['type']>(type: T, callback: DataEvent.Callback<this, Extract<DataModifierEvent, {
+        type: T;
+    }>>): Function;
+}
+/**
+ * Additionally provided types for modifier events and options.
+ */
+declare namespace DataModifier {
+    /**
+     * Benchmark options.
+     */
+    interface BenchmarkOptions {
+        iterations: number;
+    }
+    /**
+     * Registry as a record object with modifier names and their class
+     * constructor.
+     */
+    const types: DataModifierTypes;
+    /**
+     * Adds a modifier class to the registry. The modifier class has to provide
+     * the `DataModifier.options` property and the `DataModifier.modifyTable`
+     * method to modify the table.
+     *
+     * @private
+     *
+     * @param {string} key
+     * Registry key of the modifier class.
+     *
+     * @param {DataModifierType} DataModifierClass
+     * Modifier class (aka class constructor) to register.
+     *
+     * @return {boolean}
+     * Returns true, if the registration was successful. False is returned, if
+     * their is already a modifier registered with this key.
+     */
+    function registerType<T extends keyof DataModifierTypes>(key: T, DataModifierClass: DataModifierTypes[T]): boolean;
+}
+export default DataModifier;

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

@@ -0,0 +1,202 @@
+/* *
+ *
+ *  (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
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+import U from '../../Core/Utilities.js';
+const { addEvent, fireEvent, merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Abstract class to provide an interface for modifying a table.
+ */
+class DataModifier {
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Runs a timed execution of the modifier on the given datatable.
+     * Can be configured to run multiple times.
+     *
+     * @param {DataTable} dataTable
+     * The datatable to execute
+     *
+     * @param {DataModifier.BenchmarkOptions} options
+     * Options. Currently supports `iterations` for number of iterations.
+     *
+     * @return {Array<number>}
+     * An array of times in milliseconds
+     *
+     */
+    benchmark(dataTable, options) {
+        const results = [];
+        const modifier = this;
+        const execute = () => {
+            modifier.modifyTable(dataTable);
+            modifier.emit({
+                type: 'afterBenchmarkIteration'
+            });
+        };
+        const defaultOptions = {
+            iterations: 1
+        };
+        const { iterations } = merge(defaultOptions, options);
+        modifier.on('afterBenchmarkIteration', () => {
+            if (results.length === iterations) {
+                modifier.emit({
+                    type: 'afterBenchmark',
+                    results
+                });
+                return;
+            }
+            // Run again
+            execute();
+        });
+        const times = {
+            startTime: 0,
+            endTime: 0
+        };
+        // Add timers
+        modifier.on('modify', () => {
+            times.startTime = window.performance.now();
+        });
+        modifier.on('afterModify', () => {
+            times.endTime = window.performance.now();
+            results.push(times.endTime - times.startTime);
+        });
+        // Initial run
+        execute();
+        return results;
+    }
+    /**
+     * Emits an event on the modifier to all registered callbacks of this event.
+     *
+     * @param {DataModifier.Event} [e]
+     * Event object containing additonal event information.
+     */
+    emit(e) {
+        fireEvent(this, e.type, e);
+    }
+    /**
+     * Modifies the given table and sets its `modified` property as a reference
+     * to the modified table. If `modified` property does not exist on the
+     * original table, it's always created.
+     *
+     * @param {Highcharts.DataTable} table
+     * Table to modify.
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @return {Promise<Highcharts.DataTable>}
+     * Table with `modified` property as a reference.
+     */
+    modify(table, eventDetail) {
+        const modifier = this;
+        return new Promise((resolve, reject) => {
+            if (!table.modified) {
+                table.modified = table.clone(false, eventDetail);
+            }
+            try {
+                resolve(modifier.modifyTable(table, eventDetail));
+            }
+            catch (e) {
+                modifier.emit({
+                    type: 'error',
+                    detail: eventDetail,
+                    table
+                });
+                reject(e instanceof Error ? e : new Error('' + e));
+            }
+        });
+    }
+    /**
+     * Registers a callback for a specific modifier event.
+     *
+     * @param {string} type
+     * Event type as a string.
+     *
+     * @param {DataEventEmitter.Callback} callback
+     * Function to register for an modifier callback.
+     *
+     * @return {Function}
+     * Function to unregister callback from the modifier event.
+     */
+    on(type, callback) {
+        return addEvent(this, type, callback);
+    }
+}
+/* *
+ *
+ *  Class Namespace
+ *
+ * */
+/**
+ * Additionally provided types for modifier events and options.
+ */
+(function (DataModifier) {
+    /* *
+     *
+     *  Declarations
+     *
+     * */
+    /* *
+     *
+     *  Constants
+     *
+     * */
+    /**
+     * Registry as a record object with modifier names and their class
+     * constructor.
+     */
+    DataModifier.types = {};
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Adds a modifier class to the registry. The modifier class has to provide
+     * the `DataModifier.options` property and the `DataModifier.modifyTable`
+     * method to modify the table.
+     *
+     * @private
+     *
+     * @param {string} key
+     * Registry key of the modifier class.
+     *
+     * @param {DataModifierType} DataModifierClass
+     * Modifier class (aka class constructor) to register.
+     *
+     * @return {boolean}
+     * Returns true, if the registration was successful. False is returned, if
+     * their is already a modifier registered with this key.
+     */
+    function registerType(key, DataModifierClass) {
+        return (!!key &&
+            !DataModifier.types[key] &&
+            !!(DataModifier.types[key] = DataModifierClass));
+    }
+    DataModifier.registerType = registerType;
+})(DataModifier || (DataModifier = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default DataModifier;

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

@@ -0,0 +1,28 @@
+import type DataEvent from '../DataEvent';
+import type DataTable from '../DataTable';
+/**
+ * Benchmark event with additional event information.
+ */
+export interface BenchmarkEvent extends DataEvent {
+    readonly type: ('afterBenchmark' | 'afterBenchmarkIteration');
+    readonly results?: Array<number>;
+}
+/**
+ * Error event with additional event information.
+ */
+export interface ErrorEvent extends DataEvent {
+    readonly type: ('error');
+    readonly table: DataTable;
+}
+/**
+ * Event information.
+ */
+export type DataModifierEvent = (BenchmarkEvent | ErrorEvent | ModifyEvent);
+/**
+ * Modify event with additional event information.
+ */
+export interface ModifyEvent extends DataEvent {
+    readonly type: ('modify' | 'afterModify');
+    readonly table: DataTable;
+}
+export default DataModifierEvent;

package/es-modules/Data/Modifiers/DataModifierEvent.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
+ *  - Gøran Slettemark
+ *
+ * */
+'use strict';
+export {};

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

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

package/es-modules/Data/Modifiers/DataModifierOptions.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
+ *  - Gøran Slettemark
+ *
+ * */
+'use strict';
+export {};

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

@@ -0,0 +1,44 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sophie Bremer
+ *
+ * */
+
+/* *
+ *
+ *  Declarations
+ *
+ * */
+
+/**
+ * Contains all possible types of the modifier registry.
+ */
+export type DataModifierType = DataModifierTypes[keyof DataModifierTypes];
+
+/**
+ * Contains all possible options of the modifier registry.
+ */
+export type DataModifierTypeOptions = DataModifierType['prototype']['options'];
+
+/**
+ * Describes the modifier registry as a record object with key and class
+ * constructor.
+ */
+export interface DataModifierTypes {
+    // Nothing here yet
+}
+
+/* *
+ *
+ *  Default Export
+ *
+ * */
+
+export default DataModifierType;