@highcharts/grid-pro 2.1.1 → 2.3.0

package/es-modules/Data/Connectors/DataConnector.d.ts

@@ -1,13 +1,36 @@
 import type { DataConnectorTypes } from './DataConnectorType';
 import type { DataConnectorOptions, MetaColumn, Metadata } from './DataConnectorOptions';
-import type DataEvent from '../DataEvent';
+import type { DataEvent, DataEventCallback, DataEventEmitter } from '../DataEvent';
 import type DataConverterType from '../Converters/DataConverterType';
 import DataConverter from '../Converters/DataConverter.js';
-import DataTable from '../DataTable.js';
+import DataTable, { type ColumnCollection as DataTableColumnCollection } from '../DataTable.js';
+import { DeepPartial } from '../../Shared/Types';
 /**
  * Abstract class providing an interface for managing a DataConnector.
  */
-declare abstract class DataConnector implements DataEvent.Emitter<DataConnector.Event> {
+declare abstract class DataConnector implements DataEventEmitter<Event> {
+    /**
+     * Registry as a record object with connector names and their class.
+     */
+    static types: DataConnectorTypes;
+    /**
+     * Adds a connector class to the registry. The connector has to provide the
+     * `DataConnector.options` property and the `DataConnector.load` method to
+     * modify the table.
+     *
+     * @private
+     *
+     * @param {string} key
+     * Registry key of the connector class.
+     *
+     * @param {DataConnectorType} DataConnectorClass
+     * Connector class (aka class constructor) to register.
+     *
+     * @return {boolean}
+     * Returns true, if the registration was successful. False is returned, if
+     * their is already a connector registered with this key.
+     */
+    static registerType<T extends keyof DataConnectorTypes>(key: T, DataConnectorClass: DataConnectorTypes[T]): boolean;
     /**
      * The DataConverter responsible for handling conversion of provided data to
      * a DataConnector.
@@ -62,14 +85,14 @@ declare abstract class DataConnector implements DataEvent.Emitter<DataConnector.
      * @param {string} name
      * The name of the column to be described.
      *
-     * @param {DataConnector.MetaColumn} columnMeta
+     * @param {MetaColumn} columnMeta
      * The metadata to apply to the column.
      */
     describeColumn(name: string, columnMeta: MetaColumn): void;
     /**
      * Method for applying columns meta information to the whole DataConnector.
      *
-     * @param {Highcharts.Dictionary<DataConnector.MetaColumn>} columns
+     * @param {Record<string, MetaColumn>} columns
      * Pairs of column names and MetaColumn objects.
      */
     describeColumns(columns: Record<string, MetaColumn>): void;
@@ -87,7 +110,7 @@ declare abstract class DataConnector implements DataEvent.Emitter<DataConnector.
      * @return {Highcharts.DataTableColumnCollection}
      * An object with the properties `columnIds` and `columnValues`
      */
-    getSortedColumns(): DataTable.ColumnCollection;
+    getSortedColumns(): DataTableColumnCollection;
     /**
      * Sets the index and order of columns.
      *
@@ -95,6 +118,16 @@ declare abstract class DataConnector implements DataEvent.Emitter<DataConnector.
      * Order of columns.
      */
     setColumnOrder(columnIds: Array<string>): void;
+    /**
+     * Updates the connector with new options.
+     *
+     * @param newOptions
+     * The new options to be applied to the connector.
+     *
+     * @param reload
+     * Whether to reload the connector after applying the new options.
+     */
+    update(newOptions: DeepPartial<typeof this.options>, reload?: boolean): Promise<void>;
     /**
      * The default load method, which fires the `afterLoad` event
      *
@@ -124,10 +157,10 @@ declare abstract class DataConnector implements DataEvent.Emitter<DataConnector.
      * Emits an event on the connector to all registered callbacks of this
      * event.
      *
-     * @param {DataConnector.Event} e
+     * @param {Event} e
      * Event object containing additional event information.
      */
-    emit(e: DataConnector.Event): void;
+    emit(e: Event): void;
     /**
      * Registers a callback for a specific connector event.
      *
@@ -140,7 +173,7 @@ declare abstract class DataConnector implements DataEvent.Emitter<DataConnector.
      * @return {Function}
      * Function to unregister callback from the connector event.
      */
-    on<T extends DataConnector.Event['type']>(type: T, callback: DataEvent.Callback<this, Extract<DataConnector.Event, {
+    on<T extends Event['type']>(type: T, callback: DataEventCallback<this, Extract<Event, {
         type: T;
     }>>): Function;
     /**
@@ -150,55 +183,31 @@ declare abstract class DataConnector implements DataEvent.Emitter<DataConnector.
      * @param {T}[data]
      * Data specific to the corresponding converter.
      *
-     * @param {DataConnector.CreateConverterFunction}[createConverter]
+     * @param {CreateConverterFunction}[createConverter]
      * Creates a specific converter combining the dataTable options.
      *
-     * @param {DataConnector.ParseDataFunction<T>}[parseData]
+     * @param {ParseDataFunction<T>}[parseData]
      * Runs the converter parse method with the specific data type.
      */
-    initConverters<T>(data: T, createConverter: DataConnector.CreateConverterFunction, parseData: DataConnector.ParseDataFunction<T>): void;
+    initConverters<T>(data: T, createConverter: CreateConverterFunction, parseData: ParseDataFunction<T>): void;
 }
-declare namespace DataConnector {
-    /**
-     * The event type that is provided on events within DataConnector.
-     */
-    interface Event extends DataEvent {
-        readonly type: 'loadError' | 'load' | 'afterLoad';
-        readonly error?: string | Error;
-    }
-    /**
-     * Creates a specific converter combining the dataTable options.
-     */
-    interface CreateConverterFunction {
-        (key: string): DataConverterType;
-    }
-    /**
-     * Runs the converter parse method with the specific data type.
-     */
-    interface ParseDataFunction<T> {
-        (converter: DataConverterType, data: T): DataTable.ColumnCollection;
-    }
-    /**
-     * Registry as a record object with connector names and their class.
-     */
-    const types: DataConnectorTypes;
-    /**
-     * Adds a connector class to the registry. The connector has to provide the
-     * `DataConnector.options` property and the `DataConnector.load` method to
-     * modify the table.
-     *
-     * @private
-     *
-     * @param {string} key
-     * Registry key of the connector class.
-     *
-     * @param {DataConnectorType} DataConnectorClass
-     * Connector class (aka class constructor) to register.
-     *
-     * @return {boolean}
-     * Returns true, if the registration was successful. False is returned, if
-     * their is already a connector registered with this key.
-     */
-    function registerType<T extends keyof DataConnectorTypes>(key: T, DataConnectorClass: DataConnectorTypes[T]): boolean;
+/**
+ * The event type that is provided on events within DataConnector.
+ */
+export interface Event extends DataEvent {
+    readonly type: ('loadError' | 'load' | 'afterLoad' | 'beforeUpdate' | 'afterUpdate');
+    readonly error?: string | Error;
+}
+/**
+ * Creates a specific converter combining the dataTable options.
+ */
+export interface CreateConverterFunction {
+    (key: string): DataConverterType;
+}
+/**
+ * Runs the converter parse method with the specific data type.
+ */
+export interface ParseDataFunction<T> {
+    (converter: DataConverterType, data: T): DataTableColumnCollection;
 }
 export default DataConnector;

package/es-modules/Data/Connectors/DataConnector.js

@@ -1,10 +1,10 @@
 /* *
  *
- *  (c) 2009-2025 Highsoft AS
+ *  (c) 2009-2026 Highsoft AS
  *
- *  License: www.highcharts.com/license
+ *  A commercial license may be required depending on use.
+ *  See www.highcharts.com/license
  *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  *
  *  Authors:
  *  - Sophie Bremer
@@ -17,8 +17,7 @@
 'use strict';
 import DataModifier from '../Modifiers/DataModifier.js';
 import DataTable from '../DataTable.js';
-import U from '../../Core/Utilities.js';
-const { addEvent, fireEvent, merge, pick } = U;
+import { addEvent, fireEvent, merge, pick } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -28,6 +27,28 @@ const { addEvent, fireEvent, merge, pick } = U;
  * Abstract class providing an interface for managing a DataConnector.
  */
 class DataConnector {
+    /**
+     * Adds a connector class to the registry. The connector has to provide the
+     * `DataConnector.options` property and the `DataConnector.load` method to
+     * modify the table.
+     *
+     * @private
+     *
+     * @param {string} key
+     * Registry key of the connector class.
+     *
+     * @param {DataConnectorType} DataConnectorClass
+     * Connector class (aka class constructor) to register.
+     *
+     * @return {boolean}
+     * Returns true, if the registration was successful. False is returned, if
+     * their is already a connector registered with this key.
+     */
+    static registerType(key, DataConnectorClass) {
+        return (!!key &&
+            !DataConnector.types[key] &&
+            !!(DataConnector.types[key] = DataConnectorClass));
+    }
     /**
      * Whether the connector is currently polling for new data.
      */
@@ -110,7 +131,7 @@ class DataConnector {
      * @param {string} name
      * The name of the column to be described.
      *
-     * @param {DataConnector.MetaColumn} columnMeta
+     * @param {MetaColumn} columnMeta
      * The metadata to apply to the column.
      */
     describeColumn(name, columnMeta) {
@@ -121,7 +142,7 @@ class DataConnector {
     /**
      * Method for applying columns meta information to the whole DataConnector.
      *
-     * @param {Highcharts.Dictionary<DataConnector.MetaColumn>} columns
+     * @param {Record<string, MetaColumn>} columns
      * Pairs of column names and MetaColumn objects.
      */
     describeColumns(columns) {
@@ -166,6 +187,34 @@ class DataConnector {
             connector.describeColumn(columnIds[i], { index: i });
         }
     }
+    /**
+     * Updates the connector with new options.
+     *
+     * @param newOptions
+     * The new options to be applied to the connector.
+     *
+     * @param reload
+     * Whether to reload the connector after applying the new options.
+     */
+    async update(newOptions, reload = true) {
+        this.emit({ type: 'beforeUpdate' });
+        merge(true, this.options, newOptions);
+        const { options } = this;
+        if ('enablePolling' in newOptions || 'dataRefreshRate' in newOptions) {
+            if ('enablePolling' in options && options.enablePolling) {
+                this.stopPolling();
+                this.startPolling(('dataRefreshRate' in options &&
+                    typeof options.dataRefreshRate === 'number') ? Math.max(options.dataRefreshRate, 1) * 1000 : 1000);
+            }
+            else {
+                this.stopPolling();
+            }
+        }
+        if (reload) {
+            await this.load();
+        }
+        this.emit({ type: 'afterUpdate' });
+    }
     /**
      * The default load method, which fires the `afterLoad` event
      *
@@ -209,7 +258,9 @@ class DataConnector {
         this.pollingController = new AbortController();
         // Clear the polling timeout.
         window.clearTimeout(connector._polling);
-        connector._polling = window.setTimeout(() => connector
+        connector._polling = window.setTimeout(
+        // eslint-disable-next-line @typescript-eslint/no-misused-promises
+        () => connector
             .load()['catch']((error) => connector.emit({
             type: 'loadError',
             error
@@ -238,7 +289,7 @@ class DataConnector {
      * Emits an event on the connector to all registered callbacks of this
      * event.
      *
-     * @param {DataConnector.Event} e
+     * @param {Event} e
      * Event object containing additional event information.
      */
     emit(e) {
@@ -266,10 +317,10 @@ class DataConnector {
      * @param {T}[data]
      * Data specific to the corresponding converter.
      *
-     * @param {DataConnector.CreateConverterFunction}[createConverter]
+     * @param {CreateConverterFunction}[createConverter]
      * Creates a specific converter combining the dataTable options.
      *
-     * @param {DataConnector.ParseDataFunction<T>}[parseData]
+     * @param {ParseDataFunction<T>}[parseData]
      * Runs the converter parse method with the specific data type.
      */
     initConverters(data, createConverter, parseData) {
@@ -291,53 +342,13 @@ class DataConnector {
 }
 /* *
  *
- *  Class Namespace
+ *  Static Properties
  *
  * */
-(function (DataConnector) {
-    /* *
-     *
-     *  Declarations
-     *
-     * */
-    /* *
-     *
-     *  Constants
-     *
-     * */
-    /**
-     * Registry as a record object with connector names and their class.
-     */
-    DataConnector.types = {};
-    /* *
-     *
-     *  Functions
-     *
-     * */
-    /**
-     * Adds a connector class to the registry. The connector has to provide the
-     * `DataConnector.options` property and the `DataConnector.load` method to
-     * modify the table.
-     *
-     * @private
-     *
-     * @param {string} key
-     * Registry key of the connector class.
-     *
-     * @param {DataConnectorType} DataConnectorClass
-     * Connector class (aka class constructor) to register.
-     *
-     * @return {boolean}
-     * Returns true, if the registration was successful. False is returned, if
-     * their is already a connector registered with this key.
-     */
-    function registerType(key, DataConnectorClass) {
-        return (!!key &&
-            !DataConnector.types[key] &&
-            !!(DataConnector.types[key] = DataConnectorClass));
-    }
-    DataConnector.registerType = registerType;
-})(DataConnector || (DataConnector = {}));
+/**
+ * Registry as a record object with connector names and their class.
+ */
+DataConnector.types = {};
 /* *
  *
  *  Default Export

package/es-modules/Data/Connectors/DataConnectorOptions.d.ts

@@ -1,10 +1,10 @@
 /* *
  *
- *  (c) 2009-2025 Highsoft AS
+ *  (c) 2009-2026 Highsoft AS
  *
- *  License: www.highcharts.com/license
+ *  A commercial license may be required depending on use.
+ *  See www.highcharts.com/license
  *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  *
  *  Authors:
  *  - Sophie Bremer

package/es-modules/Data/Connectors/DataConnectorType.d.ts

@@ -1,10 +1,10 @@
 /* *
  *
- *  (c) 2009-2025 Highsoft AS
+ *  (c) 2009-2026 Highsoft AS
  *
- *  License: www.highcharts.com/license
+ *  A commercial license may be required depending on use.
+ *  See www.highcharts.com/license
  *
- *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
  *
  *  Authors:
  *  - Sophie Bremer

package/es-modules/Data/Connectors/GoogleSheetsConnector.d.ts

@@ -1,6 +1,6 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventDetail } from '../DataEvent';
 import type GoogleSheetsConnectorOptions from './GoogleSheetsConnectorOptions';
-import DataConnector from './DataConnector.js';
+import DataConnector, { type Event as DataConnectorEvent } from './DataConnector.js';
 import GoogleSheetsConverter from '../Converters/GoogleSheetsConverter.js';
 /**
  * @private
@@ -9,54 +9,52 @@ import GoogleSheetsConverter from '../Converters/GoogleSheetsConverter.js';
 declare class GoogleSheetsConnector extends DataConnector {
     protected static readonly defaultOptions: GoogleSheetsConnectorOptions;
     /**
-     * Constructs an instance of GoogleSheetsConnector
-     *
-     * @param {Partial<GoogleSheetsConnectorOptions>} [options]
-     * Options for the connector and converter.
-     */
+ * Constructs an instance of GoogleSheetsConnector
+ *
+ * @param {Partial<GoogleSheetsConnectorOptions>} [options]
+ * Options for the connector and converter.
+ */
     constructor(options: Partial<GoogleSheetsConnectorOptions>);
     readonly options: GoogleSheetsConnectorOptions;
     /**
-     * The attached converter, which can be replaced in the constructor
-     */
+ * The attached converter, which can be replaced in the constructor
+ */
     converter?: GoogleSheetsConverter;
     /**
-     * Overrides the DataConnector method. Emits an event on the connector to
-     * all registered callbacks of this event.
-     *
-     * @param {GoogleSheetsConnector.Event} e
-     * Event object containing additional event information.
-     */
-    emit(e: GoogleSheetsConnector.Event): void;
+ * Overrides the DataConnector method. Emits an event on the connector to
+ * all registered callbacks of this event.
+ *
+ * @param {Event} e
+ * Event object containing additional event information.
+ */
+    emit(e: Event): void;
     /**
-     * Loads data from a Google Spreadsheet.
-     *
-     * @param {DataEvent.Detail} [eventDetail]
-     * Custom information for pending events.
-     *
-     * @return {Promise<this>}
-     * Same connector instance with modified table.
-     */
-    load(eventDetail?: DataEvent.Detail): Promise<this>;
+ * Loads data from a Google Spreadsheet.
+ *
+ * @param {DataEventDetail} [eventDetail]
+ * Custom information for pending events.
+ *
+ * @return {Promise<this>}
+ * Same connector instance with modified table.
+ */
+    load(eventDetail?: DataEventDetail): Promise<this>;
 }
-declare namespace GoogleSheetsConnector {
-    interface Event extends DataConnector.Event {
-        readonly url?: string;
-    }
-    interface FetchURLOptions {
-        onlyColumnIds?: boolean;
-    }
-    /**
-     * Creates GoogleSheets API v4 URL.
-     * @private
-     */
-    function buildFetchURL(apiKey: string, sheetKey: string, options?: Partial<(FetchURLOptions & GoogleSheetsConnectorOptions)>): string;
-    /**
-     * Creates sheets range.
-     * @private
-     */
-    function buildQueryRange(options?: Partial<GoogleSheetsConnectorOptions>): string;
+export interface Event extends DataConnectorEvent {
+    readonly url?: string;
 }
+export interface FetchURLOptions {
+    onlyColumnIds?: boolean;
+}
+/**
+ * Creates GoogleSheets API v4 URL.
+ * @private
+ */
+export declare function buildFetchURL(apiKey: string, sheetKey: string, options?: Partial<(FetchURLOptions & GoogleSheetsConnectorOptions)>): string;
+/**
+ * Creates sheets range.
+ * @private
+ */
+export declare function buildQueryRange(options?: Partial<GoogleSheetsConnectorOptions>): string;
 declare module './DataConnectorType' {
     interface DataConnectorTypes {
         GoogleSheets: typeof GoogleSheetsConnector;