@highcharts/grid-pro 2.1.1 → 2.3.0

package/es-modules/Data/DataEvent.d.ts

@@ -1,11 +1,11 @@
 /**
  * The event object to pass to a callback.
  */
-interface DataEvent {
+export interface DataEvent {
     /**
      * Additional event detail
      */
-    detail?: DataEvent.Detail;
+    detail?: DataEventDetail;
     /**
      * The event type
      */
@@ -14,68 +14,66 @@ interface DataEvent {
 /**
  * Additional types for the event object and the event callback.
  */
-declare namespace DataEvent {
-    /**
-     * Describes the callbacks expected types. This generic interface can be
-     * extended by implementing classes.
-     */
-    interface Callback<T, E extends DataEvent> {
-        /**
-         *
-         * @param this
-         * Event scope pointing to the class instance, where the event happens.
-         *
-         * @param e
-         * Event object with additional event information.
-         */
-        (this: T, e: E): void;
-    }
+/**
+ * Describes the callbacks expected types. This generic interface can be
+ * extended by implementing classes.
+ */
+export interface DataEventCallback<T, E extends DataEvent> {
     /**
-     * Additional detail of the event object.
+     *
+     * @param this
+     * Event scope pointing to the class instance, where the event happens.
+     *
+     * @param e
+     * Event object with additional event information.
      */
-    type Detail = Record<string, (boolean | number | string | null | undefined)>;
+    (this: T, e: E): void;
+}
+/**
+ * Additional detail of the event object.
+ */
+export type DataEventDetail = Record<string, (boolean | number | string | null | undefined)>;
+/**
+ * Describes methods to attach callbacks to events of a class instance.
+ */
+export interface DataEventEmitter<E extends DataEvent> {
     /**
-     * Describes methods to attach callbacks to events of a class instance.
+     * Registered events managed by Highcharts utility functions.
      */
-    interface Emitter<E extends DataEvent> {
-        /**
-         * Registered events managed by Highcharts utility functions.
-         */
-        hcEvents?: HCEventsCollection;
-        /**
-         * Emits an event on the class instance to all registered callbacks of
-         * this event.
-         *
-         * @param e
-         * Event object containing additional event information.
-         */
-        emit(e: E): void;
-        /**
-         * Registers a callback for a specific event.
-         *
-         * @param {string} type
-         * Event type as a string.
-         *
-         * @param {DataEvent.Callback} callback
-         * Function to register for an event callback.
-         *
-         * @return {Function}
-         * Function to unregister callback from the event.
-         */
-        on<T extends E['type']>(type: T, callback: Callback<this, Extract<E, {
-            type: T;
-        }>>): Function;
-    }
+    hcEvents?: DataEventHCEventsCollection;
     /**
-     * Object to manage an event.
+     * Emits an event on the class instance to all registered callbacks of
+     * this event.
+     *
+     * @param e
+     * Event object containing additional event information.
      */
-    interface HCEventObject {
-        fn: Callback<unknown, DataEvent>;
-        order?: number;
-    }
+    emit(e: E): void;
     /**
-     * Collection of events managed by Highcharts utility functions.
+     * Registers a callback for a specific event.
+     *
+     * @param {string} type
+     * Event type as a string.
+     *
+     * @param {DataEventCallback} callback
+     * Function to register for an event callback.
+     *
+     * @return {Function}
+     * Function to unregister callback from the event.
      */
-    type HCEventsCollection = (Record<string, Array<HCEventObject>>);
+    on<T extends E['type']>(type: T, callback: DataEventCallback<this, Extract<E, {
+        type: T;
+    }>>): Function;
 }
+/**
+ * Object to manage an event.
+ */
+export interface DataEventHCEventObject {
+    fn: DataEventCallback<unknown, DataEvent>;
+    order?: number;
+}
+/**
+ * Collection of events managed by Highcharts utility functions.
+ */
+export type DataEventHCEventsCollection = (Record<string, Array<DataEventHCEventObject>>);
 export default DataEvent;

package/es-modules/Data/DataEvent.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

package/es-modules/Data/DataPool.d.ts

@@ -1,4 +1,4 @@
-import type DataEvent from './DataEvent';
+import type { DataEventCallback, DataEventEmitter } from './DataEvent';
 import type DataConnectorType from './Connectors/DataConnectorType';
 import type { DataConnectorTypeOptions } from './Connectors/DataConnectorType';
 import type DataPoolOptions from './DataPoolOptions';
@@ -11,7 +11,7 @@ import type DataPoolOptions from './DataPoolOptions';
  * @param {DataPoolOptions} options
  * Pool options with all connectors.
  */
-declare class DataPool implements DataEvent.Emitter<DataPool.Event> {
+declare class DataPool implements DataEventEmitter<Event> {
     protected static readonly defaultOptions: DataPoolOptions;
     /**
      * Internal dictionary with the connectors and their IDs.
@@ -31,10 +31,10 @@ declare class DataPool implements DataEvent.Emitter<DataPool.Event> {
      * Emits an event on this data pool to all registered callbacks of the given
      * event.
      *
-     * @param {DataTable.Event} e
+     * @param {DataTableEvent} e
      * Event object with event information.
      */
-    emit(e: DataPool.Event): void;
+    emit(e: Event): void;
     /**
      * Loads the connector.
      *
@@ -110,21 +110,14 @@ declare class DataPool implements DataEvent.Emitter<DataPool.Event> {
      * @return {Function}
      * Function to unregister callback from the event.
      */
-    on<T extends DataPool.Event['type']>(type: T, callback: DataEvent.Callback<this, Extract<DataPool.Event, {
+    on<T extends Event['type']>(type: T, callback: DataEventCallback<this, Extract<Event, {
         type: T;
     }>>): Function;
-    /**
-     * Sets connector options under the specified `options.id`.
-     *
-     * @param options
-     * Connector options to set.
-     */
-    setConnectorOptions(options: DataConnectorTypeOptions): void;
+    setConnectorOptions(options: DataConnectorTypeOptions, update?: boolean): void;
+    setConnectorOptions(options: DataConnectorTypeOptions, update: true): Promise<void>;
 }
-declare namespace DataPool {
-    interface Event {
-        type: ('load' | 'afterLoad' | 'setConnectorOptions' | 'afterSetConnectorOptions');
-        options: DataConnectorTypeOptions;
-    }
+export interface Event {
+    type: ('load' | 'afterLoad' | 'setConnectorOptions' | 'afterSetConnectorOptions');
+    options: DataConnectorTypeOptions;
 }
 export default DataPool;

package/es-modules/Data/DataPool.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
@@ -12,8 +12,7 @@
  * */
 'use strict';
 import DataConnector from './Connectors/DataConnector.js';
-import U from '../Core/Utilities.js';
-const { addEvent, fireEvent, merge } = U;
+import { addEvent, fireEvent, merge } from '../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -48,7 +47,7 @@ class DataPool {
      * Emits an event on this data pool to all registered callbacks of the given
      * event.
      *
-     * @param {DataTable.Event} e
+     * @param {DataTableEvent} e
      * Event object with event information.
      */
     emit(e) {
@@ -215,8 +214,12 @@ class DataPool {
      *
      * @param options
      * Connector options to set.
+     *
+     * @param update
+     * Whether to update the existing connector with the new options and reload
+     * it (`true`) or replace it with a new connector instance (`false`).
      */
-    setConnectorOptions(options) {
+    async setConnectorOptions(options, update) {
         const connectorsOptions = this.options.connectors;
         const connectorsInstances = this.connectors;
         this.emit({
@@ -229,12 +232,20 @@ class DataPool {
                 break;
             }
         }
-        // TODO: Check if can be refactored
-        if (connectorsInstances[options.id]) {
-            connectorsInstances[options.id].stopPolling();
-            delete connectorsInstances[options.id];
+        let existingConnector = connectorsInstances[options.id];
+        if (existingConnector) {
+            if (update) {
+                await existingConnector.update(options, true);
+            }
+            else {
+                existingConnector.stopPolling();
+                existingConnector = void 0;
+                delete connectorsInstances[options.id];
+            }
+        }
+        if (!existingConnector) {
+            connectorsOptions.push(options);
         }
-        connectorsOptions.push(options);
         this.emit({
             type: 'afterSetConnectorOptions',
             options

package/es-modules/Data/DataPoolOptions.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