@highcharts/grid-pro 2.0.0 → 2.1.0

package/es-modules/Grid/Pro/ColumnTypes/Validator.js

@@ -181,87 +181,72 @@ class Validator {
         this.notifContainer.remove();
     }
 }
-/* *
- *
- *  Namespace
- *
- * */
 /**
- * Namespace for Validation functionality.
+ * The class names used by the validator functionality.
  */
-(function (Validator) {
-    /**
-     * The class names used by the validator functionality.
-     */
-    Validator.classNames = {
-        notifContainer: Globals.classNamePrefix + 'notification',
-        notifError: Globals.classNamePrefix + 'notification-error',
-        notifAnimation: Globals.classNamePrefix + 'notification-animation',
-        editedCellError: Globals.classNamePrefix + 'edited-cell-error'
-    };
-    /* *
-     *
-     *  Variables
-     *
-     * */
-    /**
-     * Definition of default validation rules.
-     */
-    Validator.rulesRegistry = {
-        notEmpty: {
-            validate: ({ value, rawValue }) => (defined(value) && rawValue.length > 0),
-            notification: 'Value cannot be empty.'
-        },
-        number: {
-            validate: ({ rawValue }) => !isNaN(+rawValue),
-            notification: 'Value has to be a number.'
-        },
-        datetime: {
-            validate: ({ value }) => !defined(value) || !isNaN(+value),
-            notification: 'Value has to be parsed to a valid timestamp.'
-        },
-        'boolean': {
-            validate: ({ rawValue }) => (rawValue === 'true' || rawValue === 'false' ||
-                Number(rawValue) === 1 || Number(rawValue) === 0),
-            notification: 'Value has to be a boolean.'
+Validator.classNames = {
+    notifContainer: Globals.classNamePrefix + 'notification',
+    notifError: Globals.classNamePrefix + 'notification-error',
+    notifAnimation: Globals.classNamePrefix + 'notification-animation',
+    editedCellError: Globals.classNamePrefix + 'edited-cell-error'
+};
+/**
+ * Definition of default validation rules.
+ */
+Validator.rulesRegistry = {
+    notEmpty: {
+        validate: ({ value, rawValue }) => (defined(value) && rawValue.length > 0),
+        notification: 'Value cannot be empty.'
+    },
+    number: {
+        validate: ({ rawValue }) => !isNaN(+rawValue),
+        notification: 'Value has to be a number.'
+    },
+    datetime: {
+        validate: ({ value }) => !defined(value) || !isNaN(+value),
+        notification: 'Value has to be parsed to a valid timestamp.'
+    },
+    'boolean': {
+        validate: ({ rawValue }) => (rawValue === 'true' || rawValue === 'false' ||
+            Number(rawValue) === 1 || Number(rawValue) === 0),
+        notification: 'Value has to be a boolean.'
+    },
+    ignoreCaseUnique: {
+        validate: function ({ rawValue }) {
+            const oldValue = String(this.value).toLowerCase();
+            const rowValueString = rawValue.toLowerCase();
+            if (oldValue === rowValueString) {
+                return true;
+            }
+            const columnData = this.column.data;
+            const isDuplicate = columnData?.some((value) => String(value).toLowerCase() ===
+                rowValueString);
+            return !isDuplicate;
         },
-        ignoreCaseUnique: {
-            validate: function ({ rawValue }) {
-                const oldValue = String(this.value).toLowerCase();
-                const rowValueString = rawValue.toLowerCase();
-                if (oldValue === rowValueString) {
-                    return true;
-                }
-                const columnData = this.column.data;
-                const isDuplicate = columnData?.some((value) => String(value).toLowerCase() ===
-                    rowValueString);
-                return !isDuplicate;
-            },
-            notification: 'Value must be unique within this column (case-insensitive).'
+        notification: 'Value must be unique within this column (case-insensitive).'
+    },
+    unique: {
+        validate: function ({ rawValue }) {
+            const oldValue = this.value;
+            if (oldValue === rawValue) {
+                return true;
+            }
+            const columnData = this.column.data;
+            const isDuplicate = columnData?.some((value) => value === rawValue);
+            return !isDuplicate;
         },
-        unique: {
-            validate: function ({ rawValue }) {
-                const oldValue = this.value;
-                if (oldValue === rawValue) {
-                    return true;
-                }
-                const columnData = this.column.data;
-                const isDuplicate = columnData?.some((value) => value === rawValue);
-                return !isDuplicate;
-            },
-            notification: 'Value must be unique within this column (case-sensitive).'
-        }
-    };
-    /**
-     * Default validation rules for each dataType.
-     */
-    Validator.predefinedRules = {
-        'boolean': ['boolean'],
-        datetime: ['datetime'],
-        number: ['number'],
-        string: []
-    };
-})(Validator || (Validator = {}));
+        notification: 'Value must be unique within this column (case-sensitive).'
+    }
+};
+/**
+ * Default validation rules for each dataType.
+ */
+Validator.predefinedRules = {
+    'boolean': ['boolean'],
+    datetime: ['datetime'],
+    number: ['number'],
+    string: []
+};
 /* *
  *
  *  Default Export

package/es-modules/Grid/Pro/ColumnTypes/ValidatorComposition.d.ts

@@ -1,4 +1,14 @@
+import type Table from '../../Core/Table/Table';
+import type { RuleKey, RuleDefinition, RulesRegistryType } from './Validator';
 import Validator from './Validator.js';
+/**
+ * Extends the grid classes with cell editing functionality.
+ *
+ * @param TableClass
+ * The class to extend.
+ *
+ */
+export declare function compose(TableClass: typeof Table): void;
 declare module '../../Core/Table/Table' {
     export default interface Table {
         /**
@@ -15,7 +25,7 @@ declare module '../../Pro/CellEditing/CellEditingComposition' {
          * If not set, the validation rules are applied according to the data
          * type.
          */
-        validationRules?: (Validator.RuleKey | Validator.RuleDefinition)[];
+        validationRules?: (RuleKey | RuleDefinition)[];
     }
 }
 declare module '../../Core/Options' {
@@ -26,7 +36,10 @@ declare module '../../Core/Options' {
          * If not set, the validation rules are applied according to the data
          * type.
          */
-        validationErrors?: Validator.RulesRegistryType;
+        validationErrors?: RulesRegistryType;
     }
 }
-export default ValidatorComposition;
+declare const _default: {
+    readonly compose: typeof compose;
+};
+export default _default;

package/es-modules/Grid/Pro/ColumnTypes/ValidatorComposition.js

@@ -23,41 +23,36 @@ const { addEvent, pushUnique } = U;
  *
  * */
 /**
- * @internal
+ * Extends the grid classes with cell editing functionality.
+ *
+ * @param TableClass
+ * The class to extend.
+ *
  */
-var ValidatorComposition;
-(function (ValidatorComposition) {
-    /**
-     * Extends the grid classes with cell editing functionality.
-     *
-     * @param TableClass
-     * The class to extend.
-     *
-     */
-    function compose(TableClass) {
-        if (!pushUnique(Globals.composed, 'Validator')) {
-            return;
-        }
-        addEvent(TableClass, 'afterInit', initValidatorComposition);
-        addEvent(TableClass, 'afterDestroy', destroy);
-    }
-    ValidatorComposition.compose = compose;
-    /**
-     * Callback function called after table initialization.
-     */
-    function initValidatorComposition() {
-        this.validator = new Validator(this);
-    }
-    /**
-     * Callback function called after table destroy.
-     */
-    function destroy() {
-        this.validator.destroy();
+export function compose(TableClass) {
+    if (!pushUnique(Globals.composed, 'Validator')) {
+        return;
     }
-})(ValidatorComposition || (ValidatorComposition = {}));
+    addEvent(TableClass, 'afterInit', initValidatorComposition);
+    addEvent(TableClass, 'afterDestroy', destroy);
+}
+/**
+ * Callback function called after table initialization.
+ */
+function initValidatorComposition() {
+    this.validator = new Validator(this);
+}
+/**
+ * Callback function called after table destroy.
+ */
+function destroy() {
+    this.validator.destroy();
+}
 /* *
  *
  *  Default Export
  *
  * */
-export default ValidatorComposition;
+export default {
+    compose
+};

package/es-modules/Grid/Pro/Credits/CreditsPro.d.ts

@@ -30,6 +30,4 @@ declare class CreditsPro extends Credits {
     render(): void;
     destroy(): void;
 }
-declare namespace CreditsPro {
-}
 export default CreditsPro;

package/es-modules/Grid/Pro/Credits/CreditsProComposition.d.ts

@@ -1,15 +1,13 @@
 import type Grid from '../../Core/Grid';
 import CreditsPro from './CreditsPro.js';
-declare namespace CreditsProComposition {
-    /**
-     * Extends the grid classes with customizable credits.
-     *
-     * @param GridClass
-     * The class to extend.
-     *
-     */
-    function compose(GridClass: typeof Grid): void;
-}
+/**
+ * Extends the grid classes with customizable credits.
+ *
+ * @param GridClass
+ * The class to extend.
+ *
+ */
+export declare function compose(GridClass: typeof Grid): void;
 declare module '../../Core/Options' {
     interface Options {
         /**
@@ -25,4 +23,7 @@ declare module '../../Core/Grid' {
         credits?: CreditsPro;
     }
 }
-export default CreditsProComposition;
+declare const _default: {
+    readonly compose: typeof compose;
+};
+export default _default;

package/es-modules/Grid/Pro/Credits/CreditsProComposition.js

@@ -17,45 +17,43 @@
 import CreditsPro from './CreditsPro.js';
 import Globals from '../../Core/Globals.js';
 import U from '../../../Core/Utilities.js';
-import Defaults from '../../Core/Defaults.js';
+import { defaultOptions } from '../../Core/Defaults.js';
 const { addEvent, merge, pushUnique } = U;
 /* *
  *
- *  Class Namespace
+ *  Composition
  *
  * */
-var CreditsProComposition;
-(function (CreditsProComposition) {
-    /**
-     * Extends the grid classes with customizable credits.
-     *
-     * @param GridClass
-     * The class to extend.
-     *
-     */
-    function compose(GridClass) {
-        if (!pushUnique(Globals.composed, 'CreditsPro')) {
-            return;
-        }
-        merge(true, Defaults.defaultOptions, {
-            credits: CreditsPro.defaultOptions
-        });
-        // TODO: Change to `beforeLoad` after upgrading grid update.
-        addEvent(GridClass, 'afterRenderViewport', initCredits);
-    }
-    CreditsProComposition.compose = compose;
-    /**
-     * Init configurable credits.
-     * @param this
-     * Reference to Grid.
-     */
-    function initCredits() {
-        this.credits = new CreditsPro(this, this.options?.credits);
+/**
+ * Extends the grid classes with customizable credits.
+ *
+ * @param GridClass
+ * The class to extend.
+ *
+ */
+export function compose(GridClass) {
+    if (!pushUnique(Globals.composed, 'CreditsPro')) {
+        return;
     }
-})(CreditsProComposition || (CreditsProComposition = {}));
+    merge(true, defaultOptions, {
+        credits: CreditsPro.defaultOptions
+    });
+    // TODO: Change to `beforeLoad` after upgrading grid update.
+    addEvent(GridClass, 'afterRenderViewport', initCredits);
+}
+/**
+ * Init configurable credits.
+ * @param this
+ * Reference to Grid.
+ */
+function initCredits() {
+    this.credits = new CreditsPro(this, this.options?.credits);
+}
 /* *
  *
  *  Default Export
  *
  * */
-export default CreditsProComposition;
+export default {
+    compose
+};

package/es-modules/Grid/Pro/Export/Exporting.d.ts

@@ -36,11 +36,11 @@ declare class Exporting {
      */
     downloadJSON(modified?: boolean): void;
     /**
-     * Creates a CSV string from the data table.
+     * Creates a CSV string from the data grid.
      *
      * @param modified
-     * Whether to return the modified data table (after filtering/sorting/etc.)
-     * or the unmodified, original one. Default value is set to `true`.
+     * Whether to return the data including the modifiers (filtering, sorting,
+     * etc.) or the original data. Default value is set to `true`.
      *
      * @return
      * CSV string representing the data table.

package/es-modules/Grid/Pro/Export/Exporting.js

@@ -14,7 +14,9 @@
  * */
 'use strict';
 import DownloadURL from '../../../Shared/DownloadURL.js';
+import U from '../../../Core/Utilities.js';
 const { downloadURL, getBlobFromContent } = DownloadURL;
+const { defined } = U;
 /* *
  *
  *  Class
@@ -68,19 +70,18 @@ class Exporting {
             'data:application/json,\uFEFF' + encodeURIComponent(json), this.getFilename() + '.json');
     }
     /**
-     * Creates a CSV string from the data table.
+     * Creates a CSV string from the data grid.
      *
      * @param modified
-     * Whether to return the modified data table (after filtering/sorting/etc.)
-     * or the unmodified, original one. Default value is set to `true`.
+     * Whether to return the data including the modifiers (filtering, sorting,
+     * etc.) or the original data. Default value is set to `true`.
      *
      * @return
      * CSV string representing the data table.
      */
     getCSV(modified = true) {
-        const dataTable = modified ?
-            this.grid.viewport?.dataTable :
-            this.grid.dataTable;
+        const { grid } = this;
+        const dataTable = modified ? grid.presentationTable : grid.dataTable;
         if (!dataTable) {
             return '';
         }
@@ -96,49 +97,54 @@ class Exporting {
         if (!itemDelimiter) {
             itemDelimiter = (decimalPoint === ',' ? ';' : ',');
         }
-        const columns = dataTable.getColumns();
-        const columnIds = Object.keys(columns);
+        const columnIds = grid.enabledColumns ?? [];
+        const columnsCount = columnIds?.length;
         const csvRows = [];
-        const columnsCount = columnIds.length;
         const rowArray = [];
         // Add the names as the first row if they should be exported
         if (exportNames) {
             csvRows.push(columnIds.map((columnId) => `"${columnId}"`).join(itemDelimiter));
         }
+        const typeParser = (type) => {
+            switch (type) {
+                case 'number':
+                case 'datetime':
+                    return (val) => (defined(val) ?
+                        String(val).replace('.', decimalPoint) :
+                        '');
+                case 'string':
+                    return (val) => (defined(val) ?
+                        `"${val}"` :
+                        '');
+                case 'boolean':
+                    return (val) => (defined(val) ?
+                        (val ? 'TRUE' : 'FALSE') :
+                        '');
+            }
+        };
         for (let columnIndex = 0; columnIndex < columnsCount; columnIndex++) {
-            const columnId = columnIds[columnIndex], column = columns[columnId], columnLength = column.length;
-            let columnDataType;
+            const columnId = columnIds[columnIndex], column = grid.viewport?.getColumn(columnId), colType = column?.dataType, columnArray = dataTable.getColumn(columnId) ?? [], columnLength = columnArray?.length, parser = typeParser(colType ?? 'string');
             for (let rowIndex = 0; rowIndex < columnLength; rowIndex++) {
-                let cellValue = column[rowIndex];
-                if (!rowArray[rowIndex]) {
-                    rowArray[rowIndex] = [];
-                }
-                // Prefer datatype from metadata
-                if (columnDataType === 'string') {
-                    cellValue = '"' + cellValue + '"';
-                }
-                else if (typeof cellValue === 'number') {
-                    cellValue = String(cellValue).replace('.', decimalPoint);
-                }
-                else if (typeof cellValue === 'string') {
-                    cellValue = `"${cellValue}"`;
+                let row = rowArray[rowIndex];
+                if (!row) {
+                    row = rowArray[rowIndex] = [];
                 }
-                rowArray[rowIndex][columnIndex] = cellValue;
+                row[columnIndex] = parser(columnArray[rowIndex]);
                 // On the final column, push the row to the CSV
                 if (columnIndex === columnsCount - 1) {
                     // Trim repeated undefined values starting at the end
                     // Currently, we export the first "comma" even if the
                     // second value is undefined
                     let i = columnIndex;
-                    while (rowArray[rowIndex].length > 2) {
-                        const cellVal = rowArray[rowIndex][i];
+                    while (row.length > 2) {
+                        const cellVal = row[i];
                         if (cellVal !== void 0) {
                             break;
                         }
-                        rowArray[rowIndex].pop();
+                        row.pop();
                         i--;
                     }
-                    csvRows.push(rowArray[rowIndex].join(itemDelimiter));
+                    csvRows.push(row.join(itemDelimiter));
                 }
             }
         }

package/es-modules/Grid/Pro/Export/ExportingComposition.d.ts

@@ -1,15 +1,13 @@
 import type Grid from '../../Core/Grid';
 import Exporting from './Exporting.js';
-declare namespace ExportingComposition {
-    /**
-     * Extends the grid classes with exporting.
-     *
-     * @param GridClass
-     * The class to extend.
-     *
-     */
-    function compose(GridClass: typeof Grid): void;
-}
+/**
+ * Extends the grid classes with exporting.
+ *
+ * @param GridClass
+ * The class to extend.
+ *
+ */
+export declare function compose(GridClass: typeof Grid): void;
 declare module '../../Core/Options' {
     interface Options {
         /**
@@ -65,4 +63,7 @@ declare module '../../Core/Grid' {
         exporting?: Exporting;
     }
 }
-export default ExportingComposition;
+declare const _default: {
+    readonly compose: typeof compose;
+};
+export default _default;

package/es-modules/Grid/Pro/Export/ExportingComposition.js

@@ -13,43 +13,41 @@
  *
  * */
 'use strict';
-import Defaults from '../../Core/Defaults.js';
+import { defaultOptions } from '../../Core/Defaults.js';
 import Exporting from './Exporting.js';
 import Globals from '../../Core/Globals.js';
 import U from '../../../Core/Utilities.js';
 const { addEvent, pushUnique } = U;
 /* *
  *
- *  Class Namespace
+ *  Composition
  *
  * */
-var ExportingComposition;
-(function (ExportingComposition) {
-    /**
-     * Extends the grid classes with exporting.
-     *
-     * @param GridClass
-     * The class to extend.
-     *
-     */
-    function compose(GridClass) {
-        if (!pushUnique(Globals.composed, 'Exporting')) {
-            return;
-        }
-        Defaults.defaultOptions.exporting = Exporting.defaultOptions;
-        addEvent(GridClass, 'beforeLoad', initExporting);
-    }
-    ExportingComposition.compose = compose;
-    /**
-     * Init exporting
-     */
-    function initExporting() {
-        this.exporting = new Exporting(this);
+/**
+ * Extends the grid classes with exporting.
+ *
+ * @param GridClass
+ * The class to extend.
+ *
+ */
+export function compose(GridClass) {
+    if (!pushUnique(Globals.composed, 'Exporting')) {
+        return;
     }
-})(ExportingComposition || (ExportingComposition = {}));
+    defaultOptions.exporting = Exporting.defaultOptions;
+    addEvent(GridClass, 'beforeLoad', initExporting);
+}
+/**
+ * Init exporting
+ */
+function initExporting() {
+    this.exporting = new Exporting(this);
+}
 /* *
  *
  *  Default Export
  *
  * */
-export default ExportingComposition;
+export default {
+    compose
+};

package/es-modules/Grid/Pro/GridEvents.d.ts

@@ -12,7 +12,7 @@ export type ColumnEventCallback = (this: Column) => void;
 /**
  * Callback function to be called when a grid event is triggered.
  */
-export type GridEventCallback = (this: Grid) => void;
+export type GridEventCallback = (this: Grid, e: AnyRecord) => void;
 /**
  * Events related to the cells.
  */
@@ -90,6 +90,24 @@ export interface GridEvents {
      * Callback function to be called after the grid is loaded.
      */
     afterLoad?: GridEventCallback;
+    /**
+     * Callback function to be called before the grid options are updated.
+     */
+    beforeUpdate?: GridEventCallback;
+    /**
+     * Callback function to be called after the grid options are updated.
+     */
+    afterUpdate?: GridEventCallback;
+    /**
+     * Callback function to be called before the grid is redrawn after an
+     * update.
+     */
+    beforeRedraw?: GridEventCallback;
+    /**
+     * Callback function to be called after the grid is redrawn after an
+     * update.
+     */
+    afterRedraw?: GridEventCallback;
 }
 declare module '../Core/Options' {
     interface Options {

package/es-modules/Grid/Pro/GridEvents.js

@@ -54,11 +54,15 @@ function compose(GridClass, ColumnClass, HeaderCellClass, TableCellClass) {
     }
     [
         'beforeLoad',
-        'afterLoad'
+        'afterLoad',
+        'beforeUpdate',
+        'afterUpdate',
+        'beforeRedraw',
+        'afterRedraw'
     ].forEach((name) => {
         addEvent(GridClass, name, (e) => {
             const grid = e.target;
-            grid.options?.events?.[name]?.call(grid);
+            grid.options?.events?.[name]?.call(grid, e);
         });
     });
     [