highcharts 9.2.1 → 9.3.2

package/es-modules/Data/Parsers/DataParser.js

@@ -0,0 +1,101 @@
+/* *
+ *
+ *  (c) 2020-2021 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sophie Bremer
+ *  - Sebastian Bochan
+ *  - Gøran Slettemark
+ *
+ * */
+'use strict';
+import DataTable from '../DataTable.js';
+import U from '../../Core/Utilities.js';
+var addEvent = U.addEvent, fireEvent = U.fireEvent, uniqueKey = U.uniqueKey;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Abstract class providing an interface and basic methods for a DataParser
+ *
+ * @private
+ */
+var DataParser = /** @class */ (function () {
+    function DataParser() {
+    }
+    /* *
+     *
+     *  Static Functions
+     *
+     * */
+    /**
+     * Converts an array of columns to a table instance. Second dimension of the
+     * array are the row cells.
+     *
+     * @param {Array<DataTable.Column>} [columns]
+     * Array to convert.
+     *
+     * @param {Array<string>} [headers]
+     * Column names to use.
+     *
+     * @return {DataTable}
+     * Table instance from the arrays.
+     */
+    DataParser.getTableFromColumns = function (columns, headers) {
+        if (columns === void 0) { columns = []; }
+        if (headers === void 0) { headers = []; }
+        var table = new DataTable();
+        for (var i = 0, iEnd = Math.max(headers.length, columns.length); i < iEnd; ++i) {
+            table.setColumn(headers[i] || "" + i, columns[i]);
+        }
+        return table;
+    };
+    /**
+     * Emits an event on the DataParser instance.
+     *
+     * @param {DataParser.Event} [e]
+     * Event object containing additional event data
+     */
+    DataParser.prototype.emit = function (e) {
+        fireEvent(this, e.type, e);
+    };
+    /**
+     * Registers a callback for a specific parser event.
+     *
+     * @param {string} type
+     * Event type as a string.
+     *
+     * @param {DataEventEmitter.EventCallback} callback
+     * Function to register for an modifier callback.
+     *
+     * @return {Function}
+     * Function to unregister callback from the modifier event.
+     */
+    DataParser.prototype.on = function (type, callback) {
+        return addEvent(this, type, callback);
+    };
+    /* *
+     *
+     *  Static Properties
+     *
+     * */
+    /**
+     * Default options
+     */
+    DataParser.defaultOptions = {
+        startColumn: 0,
+        endColumn: Number.MAX_VALUE,
+        startRow: 0,
+        endRow: Number.MAX_VALUE,
+        firstRowAsNames: true,
+        switchRowsAndColumns: false
+    };
+    return DataParser;
+}());
+export default DataParser;

package/es-modules/Data/Parsers/GoogleSheetsParser.js

@@ -0,0 +1,223 @@
+/* *
+ *
+ *  (c) 2012-2021 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
+ *
+ * */
+'use strict';
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import DataParser from './DataParser.js';
+import DataConverter from '../DataConverter.js';
+import U from '../../Core/Utilities.js';
+var merge = U.merge, uniqueKey = U.uniqueKey;
+/* eslint-disable no-invalid-this, require-jsdoc, valid-jsdoc */
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Handles parsing and transformation of an Google Sheets to a table.
+ *
+ * @private
+ */
+var GoogleSheetsParser = /** @class */ (function (_super) {
+    __extends(GoogleSheetsParser, _super);
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the GoogleSheetsParser.
+     *
+     * @param {GoogleSheetsParser.OptionsType} [options]
+     * Options for the Google Sheets parser.
+     *
+     * @param {DataConverter} converter
+     * Parser data converter.
+     */
+    function GoogleSheetsParser(options, converter) {
+        var _this = _super.call(this) || this;
+        _this.columns = [];
+        _this.headers = [];
+        _this.options = merge(GoogleSheetsParser.defaultOptions, options);
+        _this.converter = converter || new DataConverter();
+        return _this;
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    GoogleSheetsParser.prototype.getSheetColumns = function (json) {
+        var parser = this, _a = parser.options, startColumn = _a.startColumn, endColumn = _a.endColumn, startRow = _a.startRow, endRow = _a.endRow, columns = [], cells = json.feed.entry, cellCount = (cells || []).length;
+        var cell, colCount = 0, rowCount = 0, val, gr, gc, cellInner, i, j;
+        // First, find the total number of columns and rows that
+        // are actually filled with data
+        for (i = 0; i < cellCount; i++) {
+            cell = cells[i];
+            colCount = Math.max(colCount, cell.gs$cell.col);
+            rowCount = Math.max(rowCount, cell.gs$cell.row);
+        }
+        // Set up arrays containing the column data
+        for (i = 0; i < colCount; i++) {
+            if (i >= startColumn && i <= endColumn) {
+                // Create new columns with the length of either
+                // end-start or rowCount
+                columns[i - startColumn] = [];
+            }
+        }
+        // Loop over the cells and assign the value to the right
+        // place in the column arrays
+        for (i = 0; i < cellCount; i++) {
+            cell = cells[i];
+            gr = cell.gs$cell.row - 1; // rows start at 1
+            gc = cell.gs$cell.col - 1; // columns start at 1
+            // If both row and col falls inside start and end set the
+            // transposed cell value in the newly created columns
+            if (gc >= startColumn && gc <= endColumn &&
+                gr >= startRow && gr <= endRow) {
+                cellInner = cell.gs$cell || cell.content;
+                val = null;
+                if (cellInner.numericValue) {
+                    if (cellInner.$t.indexOf('/') >= 0 || (cellInner.$t.indexOf('-') >= 0 &&
+                        cellInner.$t.indexOf('.') === -1)) {
+                        // This is a date - for future reference.
+                        val = cellInner.$t;
+                    }
+                    else if (cellInner.$t.indexOf('%') > 0) {
+                        // Percentage
+                        val = parseFloat(cellInner.numericValue) * 100;
+                    }
+                    else {
+                        val = parseFloat(cellInner.numericValue);
+                    }
+                }
+                else if (cellInner.$t && cellInner.$t.length) {
+                    val = cellInner.$t;
+                }
+                columns[gc - startColumn][gr - startRow] = val;
+            }
+        }
+        // Insert null for empty spreadsheet cells (#5298)
+        for (i = 0; i < colCount; i++) {
+            var column = columns[i];
+            // TODO: should this check be necessary?
+            if (column.length) {
+                for (i = 0; i < column.length; i++) {
+                    if (typeof column[i] === 'undefined') {
+                        column[i] = null;
+                    }
+                }
+            }
+        }
+        return columns;
+    };
+    /**
+     * Initiates the parsing of the Google Sheet
+     *
+     * @param {GoogleSheetsParser.OptionsType}[options]
+     * Options for the parser
+     *
+     * @param {DataEventEmitter.EventDetail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits GoogleSheetsParser#parse
+     * @emits GoogleSheetsParser#afterParse
+     */
+    GoogleSheetsParser.prototype.parse = function (jsonProp, eventDetail) {
+        var parser = this, parserOptions = merge(true, parser.options, { json: jsonProp }), converter = parser.converter, json = parserOptions.json, cells = json.feed.entry, headers = parser.headers;
+        var column;
+        if (!cells || cells.length === 0) {
+            return false;
+        }
+        parser.headers = [];
+        parser.columns = [];
+        parser.emit({
+            type: 'parse',
+            columns: parser.columns,
+            detail: eventDetail,
+            headers: parser.headers
+        });
+        parser.columns = parser.getSheetColumns(json);
+        for (var i = 0, iEnd = parser.columns.length; i < iEnd; i++) {
+            column = parser.columns[i];
+            parser.headers[i] = parserOptions.firstRowAsNames ?
+                column.splice(0, 1).toString() :
+                uniqueKey();
+            for (var j = 0, jEnd = column.length; j < jEnd; ++j) {
+                if (column[j] && typeof column[j] === 'string') {
+                    var cellValue = converter.asGuessedType(column[j]);
+                    if (cellValue instanceof Date) {
+                        cellValue = cellValue.getTime();
+                    }
+                    parser.columns[i][j] = cellValue;
+                }
+            }
+        }
+        parser.emit({
+            type: 'afterParse',
+            columns: parser.columns,
+            detail: eventDetail,
+            headers: parser.headers
+        });
+    };
+    /**
+     * Handles converting the parsed data to a table.
+     *
+     * @return {DataTable}
+     * Table from the parsed Google Sheet
+     */
+    GoogleSheetsParser.prototype.getTable = function () {
+        return DataParser.getTableFromColumns(this.columns, this.headers);
+    };
+    /* *
+     *
+     *  Static Properties
+     *
+     * */
+    /**
+     * Default options
+     */
+    GoogleSheetsParser.defaultOptions = __assign(__assign({}, DataParser.defaultOptions), { json: {} });
+    return GoogleSheetsParser;
+}(DataParser));
+/* *
+ *
+ *  Export
+ *
+ * */
+export default GoogleSheetsParser;

package/es-modules/Data/Parsers/HTMLTableParser.js

@@ -0,0 +1,213 @@
+/* *
+ *
+ *  (c) 2012-2021 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
+ *
+ * */
+'use strict';
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import DataParser from './DataParser.js';
+import DataConverter from '../DataConverter.js';
+import U from '../../Core/Utilities.js';
+var merge = U.merge;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Handles parsing and transformation of an HTML table to a table.
+ *
+ * @private
+ */
+var HTMLTableParser = /** @class */ (function (_super) {
+    __extends(HTMLTableParser, _super);
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    /**
+     * Constructs an instance of the HTML table parser.
+     *
+     * @param {HTMLTableParser.OptionsType} [options]
+     * Options for the CSV parser.
+     *
+     * @param {HTMLElement | null} tableElement
+     * The HTML table to parse
+     *
+     * @param {DataConverter} converter
+     * Parser data converter.
+     */
+    function HTMLTableParser(options, tableElement, converter) {
+        if (tableElement === void 0) { tableElement = null; }
+        var _this = _super.call(this) || this;
+        _this.columns = [];
+        _this.headers = [];
+        _this.options = merge(HTMLTableParser.defaultOptions, options);
+        _this.converter = converter || new DataConverter();
+        if (tableElement) {
+            _this.tableElement = tableElement;
+            _this.tableElementID = tableElement.id;
+        }
+        else if (options && options.tableHTML) {
+            _this.tableElement = options.tableHTML;
+            _this.tableElementID = options.tableHTML.id;
+        }
+        return _this;
+    }
+    /* *
+     *
+     *  Functions
+     *
+     * */
+    /**
+     * Initiates the parsing of the HTML table
+     *
+     * @param {HTMLTableParser.OptionsType}[options]
+     * Options for the parser
+     *
+     * @param {DataEventEmitter.EventDetail} [eventDetail]
+     * Custom information for pending events.
+     *
+     * @emits CSVDataParser#parse
+     * @emits CSVDataParser#afterParse
+     * @emits HTMLTableParser#parseError
+     */
+    HTMLTableParser.prototype.parse = function (options, eventDetail) {
+        var parser = this, converter = this.converter, columns = [], headers = [], parseOptions = merge(parser.options, options), endRow = parseOptions.endRow, startColumn = parseOptions.startColumn, endColumn = parseOptions.endColumn, firstRowAsNames = parseOptions.firstRowAsNames, tableHTML = parseOptions.tableHTML || this.tableElement;
+        if (!(tableHTML instanceof HTMLElement)) {
+            parser.emit({
+                type: 'parseError',
+                columns: columns,
+                detail: eventDetail,
+                headers: headers,
+                error: 'Not a valid HTML Table'
+            });
+            return;
+        }
+        parser.tableElement = this.tableElement;
+        parser.tableElementID = tableHTML.id;
+        this.emit({
+            type: 'parse',
+            columns: parser.columns,
+            detail: eventDetail,
+            headers: parser.headers
+        });
+        var rows = tableHTML.getElementsByTagName('tr'), rowsCount = rows.length;
+        var rowIndex = 0, item, startRow = parseOptions.startRow;
+        // Insert headers from the first row
+        if (firstRowAsNames && rowsCount) {
+            var items = rows[0].children, itemsLength = items.length;
+            for (var i = startColumn; i < itemsLength; i++) {
+                if (i > endColumn) {
+                    break;
+                }
+                item = items[i];
+                if (item.tagName === 'TD' ||
+                    item.tagName === 'TH') {
+                    headers.push(item.innerHTML);
+                }
+            }
+            startRow++;
+        }
+        while (rowIndex < rowsCount) {
+            if (rowIndex >= startRow && rowIndex <= endRow) {
+                var columnsInRow = rows[rowIndex].children, columnsInRowLength = columnsInRow.length;
+                var columnIndex = 0;
+                while (columnIndex < columnsInRowLength) {
+                    var relativeColumnIndex = columnIndex - startColumn, row = columns[relativeColumnIndex];
+                    item = columnsInRow[columnIndex];
+                    if ((item.tagName === 'TD' ||
+                        item.tagName === 'TH') &&
+                        (columnIndex >= startColumn &&
+                            columnIndex <= endColumn)) {
+                        if (!columns[relativeColumnIndex]) {
+                            columns[relativeColumnIndex] = [];
+                        }
+                        var cellValue = converter.asGuessedType(item.innerHTML);
+                        if (cellValue instanceof Date) {
+                            cellValue = cellValue.getTime();
+                        }
+                        columns[relativeColumnIndex][rowIndex - startRow] = cellValue;
+                        // Loop over all previous indices and make sure
+                        // they are nulls, not undefined.
+                        var i = 1;
+                        while (rowIndex - startRow >= i &&
+                            row[rowIndex - startRow - i] === void 0) {
+                            row[rowIndex - startRow - i] = null;
+                            i++;
+                        }
+                    }
+                    columnIndex++;
+                }
+            }
+            rowIndex++;
+        }
+        this.columns = columns;
+        this.headers = headers;
+        this.emit({
+            type: 'afterParse',
+            columns: columns,
+            detail: eventDetail,
+            headers: headers
+        });
+    };
+    /**
+     * Handles converting the parsed data to a table.
+     *
+     * @return {DataTable}
+     * Table from the parsed HTML table
+     */
+    HTMLTableParser.prototype.getTable = function () {
+        return DataParser.getTableFromColumns(this.columns, this.headers);
+    };
+    /* *
+     *
+     *  Static Properties
+     *
+     * */
+    /**
+     * Default options
+     */
+    HTMLTableParser.defaultOptions = __assign({}, DataParser.defaultOptions);
+    return HTMLTableParser;
+}(DataParser));
+/* *
+ *
+ *  Export
+ *
+ * */
+export default HTMLTableParser;