@highcharts/grid-pro 2.0.0

package/es-modules/Data/Converters/DataConverterUtils.js

@@ -0,0 +1,216 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Kamil Kubik
+ *
+ * */
+import U from '../../Core/Utilities.js';
+const { isNumber } = U;
+/* *
+ *
+ *  Namespace
+ *
+ * */
+var DataConverterUtils;
+(function (DataConverterUtils) {
+    /* *
+    *
+    *  Properties
+    *
+    * */
+    /* *
+    *
+    * Functions
+    *
+    * */
+    /**
+     * Converts a value to a Date.
+     *
+     * @param {DataConverter.Type} value
+     * Value to convert.
+     *
+     * @return {globalThis.Date}
+     * Converted value as a Date.
+     */
+    function asDate(value, converter) {
+        let timestamp;
+        if (typeof value === 'string') {
+            timestamp = converter.parseDate(value);
+        }
+        else if (typeof value === 'number') {
+            timestamp = value;
+        }
+        else if (value instanceof Date) {
+            return value;
+        }
+        else {
+            timestamp = converter.parseDate(asString(value));
+        }
+        return new Date(timestamp);
+    }
+    DataConverterUtils.asDate = asDate;
+    /**
+     * Converts a value to a number.
+     *
+     * @param {DataConverter.Type} value
+     * Value to convert.
+     *
+     * @return {number}
+     * Converted value as a number.
+     */
+    function asNumber(value, decimalRegExp) {
+        if (typeof value === 'number') {
+            return value;
+        }
+        if (typeof value === 'boolean') {
+            return value ? 1 : 0;
+        }
+        if (typeof value === 'string') {
+            const decimalRegex = decimalRegExp;
+            if (value.indexOf(' ') > -1) {
+                value = value.replace(/\s+/g, '');
+            }
+            if (decimalRegex) {
+                if (!decimalRegex.test(value)) {
+                    return NaN;
+                }
+                value = value.replace(decimalRegex, '$1.$2');
+            }
+            return parseFloat(value);
+        }
+        if (value instanceof Date) {
+            return value.getDate();
+        }
+        if (value) {
+            return value.getRowCount();
+        }
+        return NaN;
+    }
+    DataConverterUtils.asNumber = asNumber;
+    /**
+     * Converts a value to a string.
+     *
+     * @param {DataConverter.Type} value
+     * Value to convert.
+     *
+     * @return {string}
+     * Converted value as a string.
+     */
+    function asString(value) {
+        return '' + value;
+    }
+    DataConverterUtils.asString = asString;
+    /**
+     * Converts a value to a boolean.
+     *
+     * @param {DataConverter.Type} value
+     * Value to convert.
+     *
+     * @return {boolean}
+     * Converted value as a boolean.
+     */
+    function asBoolean(value) {
+        if (typeof value === 'boolean') {
+            return value;
+        }
+        if (typeof value === 'string') {
+            return value !== '' && value !== '0' && value !== 'false';
+        }
+        return !!asNumber(value);
+    }
+    DataConverterUtils.asBoolean = asBoolean;
+    /**
+     * Guesses the potential type of a string value for parsing CSV etc.
+     *
+     * @param {*} value
+     * The value to examine.
+     *
+     * @return {'number' | 'string' | 'Date'}
+     * Type string, either `string`, `Date`, or `number`.
+     */
+    function guessType(value, converter) {
+        let result = 'string';
+        if (typeof value === 'string') {
+            const trimedValue = DataConverterUtils.trim(`${value}`), decimalRegExp = converter.decimalRegExp;
+            let innerTrimedValue = DataConverterUtils.trim(trimedValue, true);
+            if (decimalRegExp) {
+                innerTrimedValue = (decimalRegExp.test(innerTrimedValue) ?
+                    innerTrimedValue.replace(decimalRegExp, '$1.$2') :
+                    '');
+            }
+            const floatValue = parseFloat(innerTrimedValue);
+            if (+innerTrimedValue === floatValue) {
+                // String is numeric
+                value = floatValue;
+            }
+            else {
+                // Determine if a date string
+                const dateValue = converter.parseDate(value);
+                result = isNumber(dateValue) ? 'Date' : 'string';
+            }
+        }
+        if (typeof value === 'number') {
+            // Greater than milliseconds in a year assumed timestamp
+            result = value > 365 * 24 * 3600 * 1000 ? 'Date' : 'number';
+        }
+        return result;
+    }
+    DataConverterUtils.guessType = guessType;
+    /**
+     * Trim a string from whitespaces.
+     *
+     * @param {string} str
+     * String to trim.
+     *
+     * @param {boolean} [inside=false]
+     * Remove all spaces between numbers.
+     *
+     * @return {string}
+     * Trimed string
+     */
+    function trim(str, inside) {
+        if (typeof str === 'string') {
+            str = str.replace(/^\s+|\s+$/g, '');
+            // Clear white space insdie the string, like thousands separators
+            if (inside && /^[\d\s]+$/.test(str)) {
+                str = str.replace(/\s/g, '');
+            }
+        }
+        return str;
+    }
+    DataConverterUtils.trim = trim;
+    /**
+     * Parses an array of columns to a column collection. If more headers are
+     * provided, the corresponding, empty columns are added.
+     *
+     * @param {DataTable.Column[]} [columnsArray]
+     * Array of columns.
+     *
+     * @param {string[]} [headers]
+     * Column ids to use.
+     *
+     * @return {DataTable.ColumnCollection}
+     * Parsed columns.
+     */
+    function getColumnsCollection(columnsArray = [], headers) {
+        const columns = {};
+        for (let i = 0, iEnd = Math.max(headers.length, columnsArray.length); i < iEnd; ++i) {
+            const columnId = headers[i] || `${i}`;
+            columns[columnId] = columnsArray[i] ? columnsArray[i].slice() : [];
+        }
+        return columns;
+    }
+    DataConverterUtils.getColumnsCollection = getColumnsCollection;
+})(DataConverterUtils || (DataConverterUtils = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default DataConverterUtils;

package/es-modules/Data/Converters/GoogleSheetsConverter.d.ts

@@ -0,0 +1,46 @@
+import type DataEvent from '../DataEvent';
+import type GoogleSheetsConverterOptions from './GoogleSheetsConverterOptions';
+import DataConverter from './DataConverter.js';
+import DataTable from '../DataTable.js';
+/**
+ * Handles parsing and transformation of an Google Sheets to a table.
+ *
+ * @private
+ */
+declare class GoogleSheetsConverter extends DataConverter {
+    /**
+     * Default options
+     */
+    protected static readonly defaultOptions: GoogleSheetsConverterOptions;
+    /**
+     * Constructs an instance of the GoogleSheetsConverter.
+     *
+     * @param {Partial<GoogleSheetsConverterOptions>} [options]
+     * Options for the GoogleSheetsConverter.
+     */
+    constructor(options?: Partial<GoogleSheetsConverterOptions>);
+    private header;
+    /**
+     * Options for the DataConverter.
+     */
+    readonly options: GoogleSheetsConverterOptions;
+    /**
+     * Initiates the parsing of the Google Sheet
+     *
+     * @param {Partial<GoogleSheetsConverterOptions>}[options]
+     * Options for the parser
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits GoogleSheetsParser#parse
+     * @emits GoogleSheetsParser#afterParse
+     */
+    parse(options: Partial<GoogleSheetsConverterOptions>, eventDetail?: DataEvent.Detail): DataTable.ColumnCollection;
+}
+declare module './DataConverterType' {
+    interface DataConverterTypes {
+        GoogleSheets: typeof GoogleSheetsConverter;
+    }
+}
+export default GoogleSheetsConverter;

package/es-modules/Data/Converters/GoogleSheetsConverter.js

@@ -0,0 +1,135 @@
+/* *
+ *
+ *  (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 DataConverter from './DataConverter.js';
+import DataConverterUtils from './DataConverterUtils.js';
+import U from '../../Core/Utilities.js';
+const { merge, uniqueKey } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Handles parsing and transformation of an Google Sheets to a table.
+ *
+ * @private
+ */
+class GoogleSheetsConverter extends DataConverter {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the GoogleSheetsConverter.
+     *
+     * @param {Partial<GoogleSheetsConverterOptions>} [options]
+     * Options for the GoogleSheetsConverter.
+     */
+    constructor(options) {
+        const mergedOptions = merge(GoogleSheetsConverter.defaultOptions, options);
+        super(mergedOptions);
+        this.header = [];
+        this.options = mergedOptions;
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Initiates the parsing of the Google Sheet
+     *
+     * @param {Partial<GoogleSheetsConverterOptions>}[options]
+     * Options for the parser
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits GoogleSheetsParser#parse
+     * @emits GoogleSheetsParser#afterParse
+     */
+    parse(options, eventDetail) {
+        const converter = this, parseOptions = merge(converter.options, options);
+        let columnsArray = ((parseOptions.json?.values) || []).map((column) => column.slice());
+        if (columnsArray.length === 0) {
+            return {};
+        }
+        converter.header = [];
+        converter.emit({
+            type: 'parse',
+            columns: [],
+            detail: eventDetail,
+            headers: converter.header
+        });
+        // If beforeParse is defined, use it to modify the data
+        const { beforeParse, json } = parseOptions;
+        if (beforeParse && json) {
+            columnsArray = beforeParse(json.values);
+        }
+        let column;
+        for (let i = 0, iEnd = columnsArray.length; i < iEnd; i++) {
+            column = columnsArray[i];
+            converter.header[i] = (parseOptions.firstRowAsNames ?
+                `${column.shift()}` :
+                uniqueKey());
+            for (let j = 0, jEnd = column.length; j < jEnd; ++j) {
+                let cellValue = column[j];
+                if (isDateObject(cellValue)) {
+                    cellValue = cellValue.getTime();
+                }
+                columnsArray[i][j] = cellValue;
+            }
+        }
+        converter.emit({
+            type: 'afterParse',
+            columns: columnsArray,
+            detail: eventDetail,
+            headers: converter.header
+        });
+        return DataConverterUtils.getColumnsCollection(columnsArray, converter.header);
+    }
+}
+/* *
+ *
+ *  Static Properties
+ *
+ * */
+/**
+ * Default options
+ */
+GoogleSheetsConverter.defaultOptions = {
+    ...DataConverter.defaultOptions
+};
+DataConverter.registerType('GoogleSheets', GoogleSheetsConverter);
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default GoogleSheetsConverter;
+/**
+ * Check if a value is a Date object
+ *
+ * @param {unknown} value to verify
+ * @return {boolean}
+ * True if the value is a Date object, false otherwise.
+ */
+function isDateObject(value) {
+    return Object.prototype.toString.call(value) === '[object Date]';
+}

package/es-modules/Data/Converters/GoogleSheetsConverterOptions.d.ts

@@ -0,0 +1,52 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Kamil Kubik
+ *
+ * */
+
+/* *
+ *
+ *  Imports
+ *
+ * */
+
+import type { GoogleSheetsBeforeParseCallbackFunction } from '../Connectors/GoogleSheetsConnectorOptions';
+
+import DataConverter from './DataConverter';
+
+/* *
+ *
+ *  Declarations
+ *
+ * */
+
+/**
+ * Options of the GoogleSheetsConverter.
+ */
+export interface GoogleSheetsConverterOptions extends DataConverter.Options {
+    json?: GoogleSpreadsheetJSON;
+    beforeParse?: GoogleSheetsBeforeParseCallbackFunction;
+}
+
+/**
+ * Google's spreadsheet format.
+ */
+export interface GoogleSpreadsheetJSON {
+    majorDimension: ('COLUMNS'|'ROWS');
+    values: Array<Array<(boolean|null|number|string|undefined)>>;
+}
+
+/* *
+ *
+ *  Default Export
+ *
+ * */
+
+export default GoogleSheetsConverterOptions;

package/es-modules/Data/Converters/HTMLTableConverter.d.ts

@@ -0,0 +1,72 @@
+import type DataEvent from '../DataEvent';
+import type DataConnector from '../Connectors/DataConnector';
+import type HTMLTableConverterOptions from './HTMLTableConverterOptions';
+import DataConverter from './DataConverter.js';
+import DataTable from '../DataTable.js';
+/**
+ * Handles parsing and transformation of an HTML table to a table.
+ *
+ * @private
+ */
+declare class HTMLTableConverter extends DataConverter {
+    /**
+     * Default options
+     */
+    protected static readonly defaultOptions: HTMLTableConverterOptions;
+    /**
+     * Constructs an instance of the HTMLTableConverter.
+     *
+     * @param {Partial<HTMLTableConverterOptions>} [options]
+     * Options for the HTMLTableConverter.
+     */
+    constructor(options?: Partial<HTMLTableConverterOptions>);
+    private headers;
+    /**
+     * Options for the DataConverter.
+     */
+    readonly options: HTMLTableConverterOptions;
+    tableElement?: HTMLElement;
+    tableElementID?: string;
+    /**
+     * Exports the dataconnector as an HTML string, using the options
+     * provided on import unless other options are provided.
+     *
+     * @param {DataConnector} connector
+     * Connector instance to export from.
+     *
+     * @param {HTMLTableConnector.ExportOptions} [options]
+     * Options that override default or existing export options.
+     *
+     * @return {string}
+     * HTML from the current dataTable.
+     */
+    export(connector: DataConnector, options?: Partial<HTMLTableConverterOptions>): string;
+    /**
+     * Get table cell markup from row data.
+     */
+    private getCellHTMLFromValue;
+    /**
+     * Get table header markup from row data.
+     */
+    private getTableHeaderHTML;
+    /**
+     * Initiates the parsing of the HTML table
+     *
+     * @param {Partial<HTMLTableConverterOptions>}[options]
+     * Options for the parser
+     *
+     * @param {DataEvent.Detail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits CSVDataParser#parse
+     * @emits CSVDataParser#afterParse
+     * @emits HTMLTableParser#parseError
+     */
+    parse(options: Partial<HTMLTableConverterOptions>, eventDetail?: DataEvent.Detail): DataTable.ColumnCollection;
+}
+declare module './DataConverterType' {
+    interface DataConverterTypes {
+        HTMLTable: typeof HTMLTableConverter;
+    }
+}
+export default HTMLTableConverter;