@highcharts/grid-pro 2.2.0 → 2.3.0

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

@@ -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) {
@@ -268,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) {
@@ -296,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) {
@@ -321,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/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;

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

@@ -18,8 +18,7 @@
 'use strict';
 import DataConnector from './DataConnector.js';
 import GoogleSheetsConverter from '../Converters/GoogleSheetsConverter.js';
-import U from '../../Core/Utilities.js';
-const { merge, pick, fireEvent } = U;
+import { fireEvent, merge, pick } from '../../Shared/Utilities.js';
 /* *
  *
  *  Functions
@@ -47,50 +46,50 @@ function isGoogleError(json) {
  */
 class GoogleSheetsConnector extends DataConnector {
     /* *
-     *
-     *  Constructor
-     *
-     * */
+ *
+ *  Constructor
+ *
+ * */
     /**
-     * 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) {
         const mergedOptions = merge(GoogleSheetsConnector.defaultOptions, options);
         super(mergedOptions);
         this.options = mergedOptions;
     }
     /* *
-     *
-     *  Functions
-     *
-     * */
+ *
+ *  Functions
+ *
+ * */
     /**
-     * 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.
-     */
+ * 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) {
         fireEvent(this, e.type, e);
     }
     /**
-     * Loads data from a Google Spreadsheet.
-     *
-     * @param {DataEvent.Detail} [eventDetail]
-     * Custom information for pending events.
-     *
-     * @return {Promise<this>}
-     * Same connector instance with modified table.
-     */
+ * 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) {
         const connector = this;
         const options = connector.options;
         const { dataRefreshRate, enablePolling, googleAPIKey, googleSpreadsheetKey, dataTables } = options;
-        const url = GoogleSheetsConnector.buildFetchURL(googleAPIKey, googleSpreadsheetKey, options);
+        const url = buildFetchURL(googleAPIKey, googleSpreadsheetKey, options);
         connector.emit({
             type: 'load',
             detail: eventDetail,
@@ -140,10 +139,10 @@ class GoogleSheetsConnector extends DataConnector {
     }
 }
 /* *
- *
- *  Static Properties
- *
- * */
+*
+*  Static Properties
+*
+* */
 GoogleSheetsConnector.defaultOptions = {
     id: 'google-sheets-connector',
     type: 'GoogleSheets',
@@ -155,63 +154,49 @@ GoogleSheetsConnector.defaultOptions = {
 };
 /* *
  *
- *  Class Namespace
+ *  Constants
  *
  * */
-(function (GoogleSheetsConnector) {
-    /* *
-     *
-     *  Declarations
-     *
-     * */
-    /* *
-     *
-     *  Constants
-     *
-     * */
-    const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
-    /* *
-     *
-     *  Functions
-     *
-     * */
-    /**
-     * Creates GoogleSheets API v4 URL.
-     * @private
-     */
-    function buildFetchURL(apiKey, sheetKey, options = {}) {
-        const url = new URL(`https://sheets.googleapis.com/v4/spreadsheets/${sheetKey}/values/`);
-        const range = options.onlyColumnIds ?
-            'A1:Z1' : buildQueryRange(options);
-        url.pathname += range;
-        const searchParams = url.searchParams;
-        searchParams.set('alt', 'json');
-        if (!options.onlyColumnIds) {
-            searchParams.set('dateTimeRenderOption', 'FORMATTED_STRING');
-            searchParams.set('majorDimension', 'COLUMNS');
-            searchParams.set('valueRenderOption', 'UNFORMATTED_VALUE');
-        }
-        searchParams.set('prettyPrint', 'false');
-        searchParams.set('key', apiKey);
-        return url.href;
-    }
-    GoogleSheetsConnector.buildFetchURL = buildFetchURL;
-    /**
-     * Creates sheets range.
-     * @private
-     */
-    function buildQueryRange(options = {}) {
-        const { endColumn, endRow, googleSpreadsheetRange, startColumn, startRow } = options;
-        return googleSpreadsheetRange || ((alphabet[startColumn || 0] || 'A') +
-            (Math.max((startRow || 0), 0) + 1) +
-            ':' +
-            (alphabet[pick(endColumn, 25)] || 'Z') +
-            (endRow ?
-                Math.max(endRow, 0) :
-                'Z'));
+const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * Creates GoogleSheets API v4 URL.
+ * @private
+ */
+export function buildFetchURL(apiKey, sheetKey, options = {}) {
+    const url = new URL(`https://sheets.googleapis.com/v4/spreadsheets/${sheetKey}/values/`);
+    const range = options.onlyColumnIds ?
+        'A1:Z1' : buildQueryRange(options);
+    url.pathname += range;
+    const searchParams = url.searchParams;
+    searchParams.set('alt', 'json');
+    if (!options.onlyColumnIds) {
+        searchParams.set('dateTimeRenderOption', 'FORMATTED_STRING');
+        searchParams.set('majorDimension', 'COLUMNS');
+        searchParams.set('valueRenderOption', 'UNFORMATTED_VALUE');
     }
-    GoogleSheetsConnector.buildQueryRange = buildQueryRange;
-})(GoogleSheetsConnector || (GoogleSheetsConnector = {}));
+    searchParams.set('prettyPrint', 'false');
+    searchParams.set('key', apiKey);
+    return url.href;
+}
+/**
+ * Creates sheets range.
+ * @private
+ */
+export function buildQueryRange(options = {}) {
+    const { endColumn, endRow, googleSpreadsheetRange, startColumn, startRow } = options;
+    return googleSpreadsheetRange || ((alphabet[startColumn || 0] || 'A') +
+        (Math.max((startRow || 0), 0) + 1) +
+        ':' +
+        (alphabet[pick(endColumn, 25)] || 'Z') +
+        (endRow ?
+            Math.max(endRow, 0) :
+            'Z'));
+}
 /* *
  *
  *  Registry

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

@@ -19,7 +19,9 @@
  * */
 
 import type DataConnectorOptions from './DataConnectorOptions';
-import type DataTable from '../DataTable';
+import type {
+    BasicColumn as DataTableBasicColumn
+} from '../DataTable';
 import type { DataTableConnectorOptions } from './DataConnectorOptions';
 
 /* *
@@ -155,7 +157,7 @@ export interface GoogleSheetsDataTableConnectorOptions extends DataTableConnecto
  *
  */
 export interface GoogleSheetsBeforeParseCallbackFunction {
-    (data: DataTable.BasicColumn[]): DataTable.BasicColumn[];
+    (data: DataTableBasicColumn[]): DataTableBasicColumn[];
 }
 
 /* *

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

@@ -1,7 +1,7 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventDetail } from '../DataEvent';
 import type HTMLTableConnectorOptions from './HTMLTableConnectorOptions';
 import type HTMLTableConverterOptions from '../Converters/HTMLTableConverterOptions';
-import DataConnector from './DataConnector.js';
+import DataConnector, { type Event as DataConnectorEvent } from './DataConnector.js';
 import HTMLTableConverter from '../Converters/HTMLTableConverter.js';
 /**
  * Class that handles creating a data connector from an HTML table.
@@ -13,10 +13,10 @@ declare class HTMLTableConnector extends DataConnector {
     /**
      * Constructs an instance of HTMLTableConnector.
      *
-     * @param {HTMLTableConnector.CombinedHTMLTableConnectorOptions} [options]
+     * @param {CombinedHTMLTableConnectorOptions} [options]
      * Options for the connector and converter.
      */
-    constructor(options?: HTMLTableConnector.CombinedHTMLTableConnectorOptions);
+    constructor(options?: CombinedHTMLTableConnectorOptions);
     /**
      * Options for the HTMLTable dataconnector
      * @todo this should not include parsing options
@@ -35,40 +35,35 @@ declare class HTMLTableConnector extends DataConnector {
     /**
      * Initiates creating the dataconnector from the HTML table
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @emits HTMLTableConnector#load
      * @emits HTMLTableConnector#afterLoad
      * @emits HTMLTableConnector#loadError
      */
-    load(eventDetail?: DataEvent.Detail): Promise<this>;
+    load(eventDetail?: DataEventDetail): Promise<this>;
 }
 /**
- * Types for class-specific options and events
+ * Type for event object fired from HTMLTableConnector
  */
-declare namespace HTMLTableConnector {
-    /**
-     * Type for event object fired from HTMLTableConnector
-     */
-    interface Event extends DataConnector.Event {
-    }
-    /**
-     * Options for exporting the connector as an HTML table
-     */
-    interface ExportOptions {
-        decimalPoint?: string | null;
-        exportIDColumn?: boolean;
-        tableCaption?: string;
-        useLocalDecimalPoint?: boolean;
-        useMultiLevelHeaders?: boolean;
-        useRowspanHeaders?: boolean;
-    }
-    /**
-     * Options of the HTMLTable connector and converter.
-     */
-    type CombinedHTMLTableConnectorOptions = Partial<HTMLTableConnectorOptions> & HTMLTableConverterOptions;
+export interface Event extends DataConnectorEvent {
+}
+/**
+ * Options for exporting the connector as an HTML table
+ */
+export interface ExportOptions {
+    decimalPoint?: string | null;
+    exportIDColumn?: boolean;
+    tableCaption?: string;
+    useLocalDecimalPoint?: boolean;
+    useMultiLevelHeaders?: boolean;
+    useRowspanHeaders?: boolean;
 }
+/**
+ * Options of the HTMLTable connector and converter.
+ */
+export type CombinedHTMLTableConnectorOptions = Partial<HTMLTableConnectorOptions> & HTMLTableConverterOptions;
 declare module './DataConnectorType' {
     interface DataConnectorTypes {
         HTMLTable: typeof HTMLTableConnector;

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

@@ -18,9 +18,8 @@
 import DataConnector from './DataConnector.js';
 import HTMLTableConverter from '../Converters/HTMLTableConverter.js';
 import H from '../../Core/Globals.js';
+import { merge } from '../../Shared/Utilities.js';
 const { win } = H;
-import U from '../../Core/Utilities.js';
-const { merge } = U;
 /* *
  *
  *  Class
@@ -40,7 +39,7 @@ class HTMLTableConnector extends DataConnector {
     /**
      * Constructs an instance of HTMLTableConnector.
      *
-     * @param {HTMLTableConnector.CombinedHTMLTableConnectorOptions} [options]
+     * @param {CombinedHTMLTableConnectorOptions} [options]
      * Options for the connector and converter.
      */
     constructor(options) {
@@ -52,7 +51,7 @@ class HTMLTableConnector extends DataConnector {
     /**
      * Initiates creating the dataconnector from the HTML table
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @emits HTMLTableConnector#load

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

@@ -1,7 +1,7 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventDetail } from '../DataEvent';
 import type JSONConnectorOptions from './JSONConnectorOptions';
 import type { JSONData } from '../Converters/JSONConverterOptions';
-import DataConnector from './DataConnector.js';
+import DataConnector, { type Event as DataConnectorEvent } from './DataConnector.js';
 import JSONConverter from '../Converters/JSONConverter.js';
 /**
  * Class that handles creating a DataConnector from JSON structure
@@ -30,31 +30,26 @@ declare class JSONConnector extends DataConnector {
      * Overrides the DataConnector method. Emits an event on the connector to
      * all registered callbacks of this event.
      *
-     * @param {JSONConnector.Event} e
+     * @param {Event} e
      * Event object containing additional event information.
      */
-    emit(e: JSONConnector.Event): void;
+    emit(e: Event): void;
     /**
      * Initiates the loading of the JSON source to the connector
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @emits JSONConnector#load
      * @emits JSONConnector#afterLoad
      */
-    load(eventDetail?: DataEvent.Detail): Promise<this>;
+    load(eventDetail?: DataEventDetail): Promise<this>;
 }
 /**
- * Types for class-specific options and events.
+ * Event objects fired from JSONConnector events.
  */
-declare namespace JSONConnector {
-    /**
-     * Event objects fired from JSONConnector events.
-     */
-    interface Event extends DataConnector.Event {
-        readonly data?: JSONData;
-    }
+export interface Event extends DataConnectorEvent {
+    readonly data?: JSONData;
 }
 declare module './DataConnectorType' {
     interface DataConnectorTypes {

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

@@ -14,8 +14,7 @@
 'use strict';
 import DataConnector from './DataConnector.js';
 import JSONConverter from '../Converters/JSONConverter.js';
-import U from '../../Core/Utilities.js';
-const { merge, fireEvent } = U;
+import { fireEvent, merge } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -55,7 +54,7 @@ class JSONConnector extends DataConnector {
      * Overrides the DataConnector method. Emits an event on the connector to
      * all registered callbacks of this event.
      *
-     * @param {JSONConnector.Event} e
+     * @param {Event} e
      * Event object containing additional event information.
      */
     emit(e) {
@@ -64,7 +63,7 @@ class JSONConnector extends DataConnector {
     /**
      * Initiates the loading of the JSON source to the connector
      *
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
      *
      * @emits JSONConnector#load