@highcharts/grid-pro 2.2.0 → 2.3.0

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

@@ -1,5 +1,5 @@
 import type ChainModifierOptions from './ChainModifierOptions';
-import type DataEvent from '../DataEvent';
+import type { DataEvent, DataEventCallback, DataEventDetail } from '../DataEvent';
 import type DataModifierEvent from './DataModifierEvent';
 import DataModifier from './DataModifier.js';
 import DataTable from '../DataTable.js';
@@ -15,7 +15,7 @@ declare class ChainModifier extends DataModifier {
     /**
      * Constructs an instance of the modifier chain.
      *
-     * @param {Partial<ChainModifier.Options>} [options]
+     * @param {Partial<ChainModifierOptions>} [options]
      * Options to configure the modifier chain.
      *
      * @param {...DataModifier} [chain]
@@ -37,17 +37,17 @@ declare class ChainModifier extends DataModifier {
      * @param {DataModifier} modifier
      * Configured modifier to add.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      */
-    add(modifier: DataModifier, eventDetail?: DataEvent.Detail): void;
+    add(modifier: DataModifier, eventDetail?: DataEventDetail): void;
     /**
      * Clears all modifiers from the chain.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      */
-    clear(eventDetail?: DataEvent.Detail): void;
+    clear(eventDetail?: DataEventDetail): void;
     /**
      * Sequentially applies all modifiers in the chain to the given table,
      * updating its `modified` property with the final result.
@@ -57,13 +57,13 @@ declare class ChainModifier extends DataModifier {
      * @param {Highcharts.DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [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>;
+    modify(table: DataTable, eventDetail?: DataEventDetail): Promise<DataTable>;
     /**
      * Applies several modifications to the table.
      *
@@ -72,7 +72,7 @@ declare class ChainModifier extends DataModifier {
      * @param {DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @return {DataTable}
@@ -81,44 +81,39 @@ declare class ChainModifier extends DataModifier {
      * @emits ChainDataModifier#execute
      * @emits ChainDataModifier#afterExecute
      */
-    modifyTable(table: DataTable, eventDetail?: DataEvent.Detail): DataTable;
+    modifyTable(table: DataTable, eventDetail?: DataEventDetail): DataTable;
     /**
      * Removes a configured modifier from all positions in the modifier chain.
      *
      * @param {DataModifier} modifier
      * Configured modifier to remove.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      */
-    remove(modifier: DataModifier, eventDetail?: DataEvent.Detail): void;
-    emit<E extends ChainModifier.Event>(e: E): void;
-    on<T extends ChainModifier.Event['type']>(type: T, callback: DataEvent.Callback<this, Extract<DataModifierEvent, {
+    remove(modifier: DataModifier, eventDetail?: DataEventDetail): void;
+    emit<E extends Event>(e: E): void;
+    on<T extends Event['type']>(type: T, callback: DataEventCallback<this, Extract<DataModifierEvent, {
         type: T;
     }>>): Function;
 }
 /**
- * Additionally provided types for modifier events and options.
+ * Event information.
  */
-declare namespace ChainModifier {
-    /**
-     * Event information.
-     */
-    type Event = ChainEvent | ModifierEvent;
-    /**
-     * Event object
-     */
-    interface ChainEvent extends DataEvent {
-        readonly type: ('clearChain' | 'afterClearChain' | DataModifierEvent['type']);
-        readonly table?: DataTable;
-    }
-    /**
-     * Event information for modifier operations.
-     */
-    interface ModifierEvent extends DataEvent {
-        readonly type: ('addModifier' | 'afterAddModifier' | 'removeModifier' | 'afterRemoveModifier');
-        readonly modifier: DataModifier;
-    }
+export type Event = ChainEvent | ModifierEvent;
+/**
+ * Event object
+ */
+export interface ChainEvent extends DataEvent {
+    readonly type: ('clearChain' | 'afterClearChain' | DataModifierEvent['type']);
+    readonly table?: DataTable;
+}
+/**
+ * Event information for modifier operations.
+ */
+export interface ModifierEvent extends DataEvent {
+    readonly type: ('addModifier' | 'afterAddModifier' | 'removeModifier' | 'afterRemoveModifier');
+    readonly modifier: DataModifier;
 }
 declare module './DataModifierType' {
     interface DataModifierTypes {

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

@@ -13,8 +13,7 @@
  * */
 'use strict';
 import DataModifier from './DataModifier.js';
-import U from '../../Core/Utilities.js';
-const { addEvent, fireEvent, merge } = U;
+import { addEvent, fireEvent, merge } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -33,7 +32,7 @@ class ChainModifier extends DataModifier {
     /**
      * Constructs an instance of the modifier chain.
      *
-     * @param {Partial<ChainModifier.Options>} [options]
+     * @param {Partial<ChainModifierOptions>} [options]
      * Options to configure the modifier chain.
      *
      * @param {...DataModifier} [chain]
@@ -67,7 +66,7 @@ class ChainModifier extends DataModifier {
      * @param {DataModifier} modifier
      * Configured modifier to add.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      */
     add(modifier, eventDetail) {
@@ -86,7 +85,7 @@ class ChainModifier extends DataModifier {
     /**
      * Clears all modifiers from the chain.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      */
     clear(eventDetail) {
@@ -109,7 +108,7 @@ class ChainModifier extends DataModifier {
      * @param {Highcharts.DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @return {Promise<Highcharts.DataTable>}
@@ -148,7 +147,7 @@ class ChainModifier extends DataModifier {
      * @param {DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @return {DataTable}
@@ -187,7 +186,7 @@ class ChainModifier extends DataModifier {
      * @param {DataModifier} modifier
      * Configured modifier to remove.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      */
     remove(modifier, eventDetail) {

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

@@ -1,4 +1,4 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventCallback, DataEventDetail, DataEventEmitter } from '../DataEvent';
 import type DataModifierEvent from './DataModifierEvent';
 import type DataModifierOptions from './DataModifierOptions';
 import type DataTable from '../DataTable';
@@ -6,7 +6,30 @@ import type { DataModifierTypes } from './DataModifierType';
 /**
  * Abstract class to provide an interface for modifying a table.
  */
-declare abstract class DataModifier implements DataEvent.Emitter<DataModifierEvent> {
+declare abstract class DataModifier implements DataEventEmitter<DataModifierEvent> {
+    /**
+     * Registry as a record object with modifier names and their class
+     * constructor.
+     */
+    static 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.
+     */
+    static registerType<T extends keyof DataModifierTypes>(key: T, DataModifierClass: DataModifierTypes[T]): boolean;
     /**
      * Modifier options.
      */
@@ -18,18 +41,18 @@ declare abstract class DataModifier implements DataEvent.Emitter<DataModifierEve
      * @param {DataTable} dataTable
      * The datatable to execute
      *
-     * @param {DataModifier.BenchmarkOptions} options
+     * @param {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>;
+    benchmark(dataTable: DataTable, options?: BenchmarkOptions): Array<number>;
     /**
      * Emits an event on the modifier to all registered callbacks of this event.
      *
-     * @param {DataModifier.Event} [e]
+     * @param {DataModifierEvent} [e]
      * Event object containing additonal event information.
      */
     emit<E extends DataModifierEvent>(e: E): void;
@@ -41,13 +64,13 @@ declare abstract class DataModifier implements DataEvent.Emitter<DataModifierEve
      * @param {Highcharts.DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [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>;
+    modify(table: DataTable, eventDetail?: DataEventDetail): 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
@@ -56,62 +79,34 @@ declare abstract class DataModifier implements DataEvent.Emitter<DataModifierEve
      * @param {Highcharts.DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [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;
+    abstract modifyTable(table: DataTable, eventDetail?: DataEventDetail): DataTable;
     /**
      * Registers a callback for a specific modifier event.
      *
      * @param {string} type
      * Event type as a string.
      *
-     * @param {DataEventEmitter.Callback} callback
+     * @param {DataEventCallback} 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, {
+    on<T extends DataModifierEvent['type']>(type: T, callback: DataEventCallback<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 interface BenchmarkOptions {
+    iterations: number;
 }
 export default DataModifier;

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

@@ -13,8 +13,7 @@
  *
  * */
 'use strict';
-import U from '../../Core/Utilities.js';
-const { addEvent, fireEvent, merge } = U;
+import { addEvent, fireEvent, merge } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -24,6 +23,28 @@ const { addEvent, fireEvent, merge } = U;
  * Abstract class to provide an interface for modifying a table.
  */
 class DataModifier {
+    /**
+     * 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.
+     */
+    static registerType(key, DataModifierClass) {
+        return (!!key &&
+            !DataModifier.types[key] &&
+            !!(DataModifier.types[key] = DataModifierClass));
+    }
     /* *
      *
      *  Functions
@@ -36,7 +57,7 @@ class DataModifier {
      * @param {DataTable} dataTable
      * The datatable to execute
      *
-     * @param {DataModifier.BenchmarkOptions} options
+     * @param {BenchmarkOptions} options
      * Options. Currently supports `iterations` for number of iterations.
      *
      * @return {Array<number>}
@@ -86,7 +107,7 @@ class DataModifier {
     /**
      * Emits an event on the modifier to all registered callbacks of this event.
      *
-     * @param {DataModifier.Event} [e]
+     * @param {DataModifierEvent} [e]
      * Event object containing additonal event information.
      */
     emit(e) {
@@ -100,7 +121,7 @@ class DataModifier {
      * @param {Highcharts.DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @return {Promise<Highcharts.DataTable>}
@@ -131,7 +152,7 @@ class DataModifier {
      * @param {string} type
      * Event type as a string.
      *
-     * @param {DataEventEmitter.Callback} callback
+     * @param {DataEventCallback} callback
      * Function to register for an modifier callback.
      *
      * @return {Function}
@@ -143,57 +164,14 @@ class DataModifier {
 }
 /* *
  *
- *  Class Namespace
+ *  Static Properties
  *
  * */
 /**
- * Additionally provided types for modifier events and options.
+ * Registry as a record object with modifier names and their class
+ * constructor.
  */
-(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 = {}));
+DataModifier.types = {};
 /* *
  *
  *  Default Export

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

@@ -1,4 +1,4 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventDetail } from '../DataEvent';
 import type { FilterModifierOptions } from './FilterModifierOptions';
 import DataModifier from './DataModifier.js';
 import DataTable from '../DataTable.js';
@@ -20,7 +20,7 @@ declare class FilterModifier extends DataModifier {
     /**
      * Constructs an instance of the filter modifier.
      *
-     * @param {Partial<FilterModifier.Options>} [options]
+     * @param {Partial<FilterModifierOptions>} [options]
      * Options to configure the filter modifier.
      */
     constructor(options?: Partial<FilterModifierOptions>);
@@ -36,14 +36,14 @@ declare class FilterModifier extends DataModifier {
      * @param {DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [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;
+    modifyTable(table: DataTable, eventDetail?: DataEventDetail): DataTable;
 }
 declare module './DataModifierType' {
     interface DataModifierTypes {

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

@@ -12,8 +12,7 @@
  * */
 'use strict';
 import DataModifier from './DataModifier.js';
-import U from '../../Core/Utilities.js';
-const { isFunction, merge } = U;
+import { isFunction, merge } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -96,7 +95,7 @@ class FilterModifier extends DataModifier {
     /**
      * Constructs an instance of the filter modifier.
      *
-     * @param {Partial<FilterModifier.Options>} [options]
+     * @param {Partial<FilterModifierOptions>} [options]
      * Options to configure the filter modifier.
      */
     constructor(options) {
@@ -116,7 +115,7 @@ class FilterModifier extends DataModifier {
      * @param {DataTable} table
      * Table to modify.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @return {DataTable}

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

@@ -1,5 +1,6 @@
 import type DataModifierOptions from './DataModifierOptions';
 import type DataTable from '../DataTable';
+import type { CellType as DataTableCellType, RowObject as DataTableRowObject } from '../DataTable';
 /**
  * Condition that uses an universal comparison operators.
  */
@@ -16,7 +17,7 @@ export interface ComparisonCondition {
     /**
      * Value to compare the cell with.
      */
-    value: DataTable.CellType;
+    value: DataTableCellType;
 }
 /**
  * Condition that uses string comparison operators.
@@ -80,7 +81,7 @@ export interface LogicalSingleCondition {
  * @param rowIndex
  * Index of the row in the table.
  */
-export type CallbackCondition = (row: DataTable.RowObject, table: DataTable, rowIndex: number) => boolean;
+export type CallbackCondition = (row: DataTableRowObject, table: DataTable, rowIndex: number) => boolean;
 /**
  * Serializable condition that can be used to filter rows in a table.
  */

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

@@ -1,4 +1,4 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventDetail } from '../DataEvent';
 import type InvertModifierOptions from './InvertModifierOptions';
 import DataModifier from './DataModifier.js';
 import DataTable from '../DataTable.js';
@@ -15,7 +15,7 @@ declare class InvertModifier extends DataModifier {
     /**
      * Constructs an instance of the invert modifier.
      *
-     * @param {Partial<InvertModifier.Options>} [options]
+     * @param {Partial<InvertModifierOptions>} [options]
      * Options to configure the invert modifier.
      */
     constructor(options?: Partial<InvertModifierOptions>);
@@ -31,14 +31,14 @@ declare class InvertModifier extends DataModifier {
      * @param {DataTable} table
      * Table to invert.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [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;
+    modifyTable(table: DataTable, eventDetail?: DataEventDetail): DataTable;
 }
 declare module './DataModifierType' {
     interface DataModifierTypes {

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

@@ -13,8 +13,7 @@
  * */
 'use strict';
 import DataModifier from './DataModifier.js';
-import U from '../../Core/Utilities.js';
-const { merge } = U;
+import { merge } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -34,7 +33,7 @@ class InvertModifier extends DataModifier {
     /**
      * Constructs an instance of the invert modifier.
      *
-     * @param {Partial<InvertModifier.Options>} [options]
+     * @param {Partial<InvertModifierOptions>} [options]
      * Options to configure the invert modifier.
      */
     constructor(options) {
@@ -54,7 +53,7 @@ class InvertModifier extends DataModifier {
      * @param {DataTable} table
      * Table to invert.
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @return {DataTable}

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

@@ -1,5 +1,6 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventDetail } from '../DataEvent';
 import type DataTable from '../DataTable';
+import type { Column as DataTableColumn } from '../DataTable';
 import type { Formula } from '../Formula/Formula';
 import type { MathModifierOptions } from './MathModifierOptions';
 import DataModifier from './DataModifier.js';
@@ -18,7 +19,7 @@ declare class MathModifier extends DataModifier {
     static readonly defaultOptions: MathModifierOptions;
     constructor(options: Partial<MathModifierOptions>);
     options: MathModifierOptions;
-    modifyTable(table: DataTable, eventDetail?: DataEvent.Detail): DataTable;
+    modifyTable(table: DataTable, eventDetail?: DataEventDetail): DataTable;
     /**
      * Process a column by replacing formula strings with calculated values.
      *
@@ -36,7 +37,7 @@ declare class MathModifier extends DataModifier {
      * @return {Highcharts.DataTableColumn}
      * Returns the processed table column.
      */
-    protected processColumn(table: DataTable, columnId: string, rowIndex?: number): DataTable.Column;
+    protected processColumn(table: DataTable, columnId: string, rowIndex?: number): DataTableColumn;
     /**
      * Process a column by replacing cell values with calculated values from a
      * given formula.
@@ -58,7 +59,7 @@ declare class MathModifier extends DataModifier {
      * @return {Highcharts.DataTableColumn}
      * Returns the processed table column.
      */
-    protected processColumnFormula(formula: Formula, table: DataTable, rowStart?: number, rowEnd?: number): DataTable.Column;
+    protected processColumnFormula(formula: Formula, table: DataTable, rowStart?: number, rowEnd?: number): DataTableColumn;
 }
 declare module './DataModifierType' {
     interface DataModifierTypes {