@highcharts/grid-pro 2.0.0

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

@@ -0,0 +1,65 @@
+import type DataEvent from '../DataEvent';
+import type GoogleSheetsConnectorOptions from './GoogleSheetsConnectorOptions';
+import DataConnector from './DataConnector.js';
+import GoogleSheetsConverter from '../Converters/GoogleSheetsConverter.js';
+/**
+ * @private
+ * @todo implement save, requires oauth2
+ */
+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.
+     */
+    constructor(options: Partial<GoogleSheetsConnectorOptions>);
+    readonly options: GoogleSheetsConnectorOptions;
+    /**
+     * 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;
+    /**
+     * 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>;
+}
+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;
+}
+declare module './DataConnectorType' {
+    interface DataConnectorTypes {
+        GoogleSheets: typeof GoogleSheetsConnector;
+    }
+}
+export default GoogleSheetsConnector;

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

@@ -0,0 +1,226 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Torstein Hønsi
+ *  - Gøran Slettemark
+ *  - Wojciech Chmiel
+ *  - Sophie Bremer
+ *  - Jomar Hønsi
+ *  - Kamil Kubik
+ *
+ * */
+'use strict';
+import DataConnector from './DataConnector.js';
+import GoogleSheetsConverter from '../Converters/GoogleSheetsConverter.js';
+import U from '../../Core/Utilities.js';
+const { merge, pick, fireEvent } = U;
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * Tests Google's response for error.
+ * @private
+ */
+function isGoogleError(json) {
+    return (typeof json === 'object' && json &&
+        typeof json.error === 'object' && json.error &&
+        typeof json.error.code === 'number' &&
+        typeof json.error.message === 'string' &&
+        typeof json.error.status === 'string');
+}
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * @private
+ * @todo implement save, requires oauth2
+ */
+class GoogleSheetsConnector extends DataConnector {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * 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
+     *
+     * */
+    /**
+     * 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) {
+        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.
+     */
+    load(eventDetail) {
+        const connector = this;
+        const options = connector.options;
+        const { dataRefreshRate, enablePolling, googleAPIKey, googleSpreadsheetKey, dataTables } = options;
+        const url = GoogleSheetsConnector.buildFetchURL(googleAPIKey, googleSpreadsheetKey, options);
+        connector.emit({
+            type: 'load',
+            detail: eventDetail,
+            url
+        });
+        if (!URL.canParse(url)) {
+            throw new Error('Invalid URL: ' + url);
+        }
+        return fetch(url, { signal: connector?.pollingController?.signal })
+            .then((response) => (response.json()))
+            .then((json) => {
+            if (isGoogleError(json)) {
+                throw new Error(json.error.message);
+            }
+            this.initConverters(json, (key) => {
+                const tableOptions = dataTables?.find((dataTable) => dataTable.key === key);
+                // The data table options takes precedence over the
+                // connector options.
+                const { firstRowAsNames = options.firstRowAsNames, beforeParse = options.beforeParse } = tableOptions || {};
+                const converterOptions = {
+                    firstRowAsNames,
+                    beforeParse
+                };
+                return new GoogleSheetsConverter(converterOptions);
+            }, (converter, data) => converter.parse({ json: data }));
+            return connector.applyTableModifiers();
+        })
+            .then(() => {
+            connector.emit({
+                type: 'afterLoad',
+                detail: eventDetail,
+                url
+            });
+            // Polling
+            if (enablePolling) {
+                setTimeout(() => connector.load(), Math.max(dataRefreshRate || 0, 1) * 1000);
+            }
+            return connector;
+        })['catch']((error) => {
+            connector.emit({
+                type: 'loadError',
+                detail: eventDetail,
+                error
+            });
+            throw error;
+        });
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+GoogleSheetsConnector.defaultOptions = {
+    id: 'google-sheets-connector',
+    type: 'GoogleSheets',
+    googleAPIKey: '',
+    googleSpreadsheetKey: '',
+    enablePolling: false,
+    dataRefreshRate: 2,
+    firstRowAsNames: true
+};
+/* *
+ *
+ *  Class Namespace
+ *
+ * */
+(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'));
+    }
+    GoogleSheetsConnector.buildQueryRange = buildQueryRange;
+})(GoogleSheetsConnector || (GoogleSheetsConnector = {}));
+/* *
+ *
+ *  Registry
+ *
+ * */
+DataConnector.registerType('GoogleSheets', GoogleSheetsConnector);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default GoogleSheetsConnector;

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

@@ -0,0 +1,167 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Karol Kolodziej
+ *  - Kamil Kubik
+ *
+ * */
+
+/* *
+ *
+ *  Imports
+ *
+ * */
+
+import type DataConnectorOptions from './DataConnectorOptions';
+import type DataTable from '../DataTable';
+import type { DataTableConnectorOptions } from './DataConnectorOptions';
+
+/* *
+ *
+ *  Declarations
+ *
+ * */
+
+/**
+ * Options of the GoogleSheetsConnector.
+ */
+export interface GoogleSheetsConnectorOptions extends DataConnectorOptions {
+    /**
+     * The corresponding connector type.
+     */
+    type: 'GoogleSheets';
+    /**
+     * The rate in seconds for polling for live data.
+     * Note that polling requires the option `enablePolling` to be true.
+     */
+    dataRefreshRate?: number;
+    /**
+     * Whether to enable polling for live data.
+     */
+    enablePolling?: boolean;
+    /**
+     * The number of the last column to load.
+     */
+    endColumn?: number;
+    /**
+     * The number of the last row to load.
+     */
+    endRow?: number;
+    /**
+     * Whether to treat the first row of the data set as series names.
+     */
+    firstRowAsNames?: boolean;
+    /**
+     * The API key for a Google Spreadsheet (user's credentials).
+     * See [general information on GS](https://developers.google.com/sheets/api/quickstart/js#create_an_api_key).
+     */
+    googleAPIKey: string;
+    /**
+     * The Google Spreadsheet key that identifies the sheet to use. See
+     * [general information on googleSpreadsheetKey](#data.googleSpreadsheetKey).
+     * The key for a sheet can be extracted from the sheet's URL
+     * `https://docs.google.com/spreadsheets/d/{key}`.
+     */
+    googleSpreadsheetKey: string;
+    /**
+     * The Google Spreadsheet `range` to use in combination with
+     * [googleSpreadsheetKey](#data.googleSpreadsheetKey). See
+     * [developers.google.com](https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get)
+     * for details.
+     *
+     * If given, it takes precedence over `startColumn`, `endColumn`, `startRow` and
+     * `endRow`.
+     */
+    googleSpreadsheetRange?: string;
+    /**
+     * The number of the first column to load.
+     */
+    startColumn?: number;
+    /**
+     * The number of the first row to load.
+     */
+    startRow?: number;
+
+    /**
+     * Allows defining multiple data tables within a single connector to adjust
+     * options or data parsing in various ways based on the same data source.
+     *
+     * @example
+     * dataPool: {
+     *     connectors: [{
+     *         id: 'data-connector',
+     *         type: 'JSON',
+     *         data: {
+     *             kpis: { a: 1, b: 2 },
+     *             more: {
+     *                 alpha: [1, 2, 3, 4, 5],
+     *                 beta: [10, 20, 30, 40, 50]
+     *             }
+     *         },
+     *         dataTables: [{
+     *             key: 'more',
+     *             beforeParse: function ({ more }) {
+     *                 const keys = Object.keys(more);
+     *                 return [
+     *                     keys,
+     *                     ...more[keys[0]].map((_, index) =>
+     *                         keys.map(key => more[key][index])
+     *                     )
+     *                 ];
+     *             }
+     *         }, {
+     *             key: 'kpis',
+     *             firstRowAsNames: false,
+     *             columnIds: ['a', 'b'],
+     *             beforeParse: function ({ kpis }) {
+     *                 return [[kpis.a, kpis.b]];
+     *             },
+     *             dataModifier: {
+     *                 type: 'Math',
+     *                 columnFormulas: [{
+     *                     column: 'c',
+     *                     formula: 'A1+B1'
+     *                 }]
+     *             }
+     *         }]
+     *     }]
+     * }
+     **/
+    dataTables?: GoogleSheetsDataTableConnectorOptions[];
+
+    /**
+     * A custom callback function that parses the data before it's being parsed
+     * to the data table format inside the converter.
+     */
+    beforeParse?: GoogleSheetsBeforeParseCallbackFunction;
+}
+
+/**
+ * Options of the GoogleSheetsConnector dataTable.
+ */
+export interface GoogleSheetsDataTableConnectorOptions extends DataTableConnectorOptions {
+    beforeParse?: GoogleSheetsBeforeParseCallbackFunction;
+}
+
+/**
+ * Callback function allowing modification of the GoogleSheets data
+ * before parsing it. Must return an array of DataTable columns.
+ *
+ */
+export interface GoogleSheetsBeforeParseCallbackFunction {
+    (data: DataTable.BasicColumn[]): DataTable.BasicColumn[];
+}
+
+/* *
+ *
+ *  Default Export
+ *
+ * */
+
+export default GoogleSheetsConnectorOptions;

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

@@ -0,0 +1,77 @@
+import type DataEvent from '../DataEvent';
+import type HTMLTableConnectorOptions from './HTMLTableConnectorOptions';
+import type HTMLTableConverterOptions from '../Converters/HTMLTableConverterOptions';
+import DataConnector from './DataConnector.js';
+import HTMLTableConverter from '../Converters/HTMLTableConverter.js';
+/**
+ * Class that handles creating a data connector from an HTML table.
+ *
+ * @private
+ */
+declare class HTMLTableConnector extends DataConnector {
+    protected static readonly defaultOptions: HTMLTableConnectorOptions;
+    /**
+     * Constructs an instance of HTMLTableConnector.
+     *
+     * @param {HTMLTableConnector.CombinedHTMLTableConnectorOptions} [options]
+     * Options for the connector and converter.
+     */
+    constructor(options?: HTMLTableConnector.CombinedHTMLTableConnectorOptions);
+    /**
+     * Options for the HTMLTable dataconnector
+     * @todo this should not include parsing options
+     */
+    readonly options: HTMLTableConnectorOptions;
+    /**
+     * The attached parser, which can be replaced in the constructor
+     */
+    converter: HTMLTableConverter;
+    /**
+     * The table element to create the connector from. Is either supplied
+     * directly or is fetched by an ID.
+     */
+    tableElement?: HTMLElement;
+    tableID?: string;
+    /**
+     * Initiates creating the dataconnector from the HTML table
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits HTMLTableConnector#load
+     * @emits HTMLTableConnector#afterLoad
+     * @emits HTMLTableConnector#loadError
+     */
+    load(eventDetail?: DataEvent.Detail): Promise<this>;
+}
+/**
+ * Types for class-specific options and events
+ */
+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;
+}
+declare module './DataConnectorType' {
+    interface DataConnectorTypes {
+        HTMLTable: typeof HTMLTableConnector;
+    }
+}
+export default HTMLTableConnector;

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

@@ -0,0 +1,119 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Torstein Hønsi
+ *  - Gøran Slettemark
+ *  - Wojciech Chmiel
+ *  - Sophie Bremer
+ *  - Kamil Kubik
+ *
+ * */
+'use strict';
+import DataConnector from './DataConnector.js';
+import HTMLTableConverter from '../Converters/HTMLTableConverter.js';
+import H from '../../Core/Globals.js';
+const { win } = H;
+import U from '../../Core/Utilities.js';
+const { merge } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Class that handles creating a data connector from an HTML table.
+ *
+ * @private
+ */
+class HTMLTableConnector extends DataConnector {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of HTMLTableConnector.
+     *
+     * @param {HTMLTableConnector.CombinedHTMLTableConnectorOptions} [options]
+     * Options for the connector and converter.
+     */
+    constructor(options) {
+        const mergedOptions = merge(HTMLTableConnector.defaultOptions, options);
+        super(mergedOptions);
+        this.options = mergedOptions;
+        this.converter = new HTMLTableConverter(mergedOptions);
+    }
+    /**
+     * Initiates creating the dataconnector from the HTML table
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits HTMLTableConnector#load
+     * @emits HTMLTableConnector#afterLoad
+     * @emits HTMLTableConnector#loadError
+     */
+    async load(eventDetail) {
+        const connector = this;
+        const options = connector.options;
+        const converter = connector.converter;
+        const table = connector.getTable();
+        const htmlTable = options.htmlTable;
+        connector.emit({
+            type: 'load',
+            detail: eventDetail
+        });
+        let tableElement;
+        if (typeof htmlTable === 'string') {
+            connector.tableID = htmlTable;
+            tableElement = win.document.getElementById(htmlTable);
+        }
+        else {
+            tableElement = htmlTable;
+            connector.tableID = tableElement.id;
+        }
+        connector.tableElement = tableElement || void 0;
+        if (!connector.tableElement) {
+            const error = 'HTML table not provided, or element with ID not found';
+            connector.emit({
+                type: 'loadError',
+                detail: eventDetail,
+                error
+            });
+            return Promise.reject(new Error(error));
+        }
+        const columns = converter.parse(merge({ tableElement: connector.tableElement }, options), eventDetail);
+        // If already loaded, clear the current rows
+        table.deleteColumns();
+        table.setColumns(columns);
+        await connector.applyTableModifiers();
+        connector.emit({
+            type: 'afterLoad',
+            detail: eventDetail
+        });
+        return connector;
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+HTMLTableConnector.defaultOptions = {
+    id: 'HTML-table-connector',
+    type: 'HTMLTable',
+    htmlTable: ''
+};
+DataConnector.registerType('HTMLTable', HTMLTableConnector);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default HTMLTableConnector;

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

@@ -0,0 +1,49 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Karol Kolodziej
+ *
+ * */
+
+/* *
+ *
+ *  Imports
+ *
+ * */
+
+import type DataConnectorOptions from './DataConnectorOptions';
+
+
+/* *
+ *
+ *  Declarations
+ *
+ * */
+
+/**
+ * Options of the GoogleSheetsConnector.
+ */
+export interface HTMLTableConnectorOptions extends DataConnectorOptions {
+    /**
+     * The corresponding connector type.
+     */
+    type: 'HTMLTable';
+    /**
+     * The id of the HTML data table element to load or a reference to the HTML.
+     */
+    htmlTable: string | HTMLElement;
+}
+
+/* *
+ *
+ *  Default Export
+ *
+ * */
+
+export default HTMLTableConnectorOptions;