@highcharts/grid-pro 2.0.0

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

@@ -0,0 +1,202 @@
+/* *
+ *
+ *  Grid Exporting class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Karol Kolodziej
+ *
+ * */
+'use strict';
+import DownloadURL from '../../../Shared/DownloadURL.js';
+const { downloadURL, getBlobFromContent } = DownloadURL;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Export the given table to CSV format.
+ */
+class Exporting {
+    /* *
+    *
+    *  Constructor
+    *
+    * */
+    /**
+     * Construct the exporting.
+     *
+     * @param grid
+     * The Grid instance.
+     */
+    constructor(grid) {
+        this.grid = grid;
+    }
+    /* *
+    *
+    *  Methods
+    *
+    * */
+    /**
+     * Downloads the CSV string as a file.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. Default value is set to `true`.
+     */
+    downloadCSV(modified = true) {
+        const csv = this.getCSV(modified);
+        downloadURL(getBlobFromContent(csv, 'text/csv') ||
+            'data:text/csv,\uFEFF' + encodeURIComponent(csv), this.getFilename() + '.csv');
+    }
+    /**
+     * Downloads the JSON string as a file.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. Default value is set to `true`.
+     */
+    downloadJSON(modified = true) {
+        const json = this.getJSON(modified);
+        downloadURL(getBlobFromContent(json, 'application/json') ||
+            'data:application/json,\uFEFF' + encodeURIComponent(json), this.getFilename() + '.json');
+    }
+    /**
+     * Creates a CSV string from the data table.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. 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;
+        if (!dataTable) {
+            return '';
+        }
+        const options = this.grid.options?.exporting || Exporting.defaultOptions;
+        const { useLocalDecimalPoint, lineDelimiter, firstRowAsNames } = options.csv ?? {};
+        const exportNames = firstRowAsNames !== false;
+        let { decimalPoint, itemDelimiter } = options.csv ?? {};
+        if (!decimalPoint) {
+            decimalPoint = (itemDelimiter !== ',' && useLocalDecimalPoint ?
+                (1.1).toLocaleString()[1] :
+                '.');
+        }
+        if (!itemDelimiter) {
+            itemDelimiter = (decimalPoint === ',' ? ';' : ',');
+        }
+        const columns = dataTable.getColumns();
+        const columnIds = Object.keys(columns);
+        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));
+        }
+        for (let columnIndex = 0; columnIndex < columnsCount; columnIndex++) {
+            const columnId = columnIds[columnIndex], column = columns[columnId], columnLength = column.length;
+            let columnDataType;
+            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}"`;
+                }
+                rowArray[rowIndex][columnIndex] = cellValue;
+                // 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];
+                        if (cellVal !== void 0) {
+                            break;
+                        }
+                        rowArray[rowIndex].pop();
+                        i--;
+                    }
+                    csvRows.push(rowArray[rowIndex].join(itemDelimiter));
+                }
+            }
+        }
+        return csvRows.join(lineDelimiter);
+    }
+    /**
+     * Returns the current grid data as a JSON string.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. Default value is set to `true`.
+     *
+     * @return
+     * JSON representation of the data
+     */
+    getJSON(modified = true) {
+        return this.grid.getData(modified);
+    }
+    /**
+     * Get the default file name used for exported the grid.
+     *
+     * @returns
+     * A file name without extension.
+     */
+    getFilename() {
+        let filename = this.grid.options?.exporting?.filename || 'Grid';
+        if (filename) {
+            return filename.replace(/\//g, '-');
+        }
+        if (typeof filename === 'string') {
+            filename = filename
+                .toLowerCase()
+                .replace(/<\/?[^>]+(>|$)/g, '') // Strip HTML tags
+                .replace(/[\s_]+/g, '-')
+                .replace(/[^a-z\d\-]/g, '') // Preserve only latin
+                .replace(/^[\-]+/g, '') // Dashes in the start
+                .replace(/[\-]+/g, '-') // Dashes in a row
+                .substr(0, 24)
+                .replace(/[\-]+$/g, ''); // Dashes in the end;
+        }
+        return filename;
+    }
+}
+/**
+ * Default options of the credits.
+ */
+Exporting.defaultOptions = {
+    filename: 'Grid',
+    csv: {
+        firstRowAsNames: true,
+        useLocalDecimalPoint: true,
+        itemDelimiter: ',',
+        lineDelimiter: '\n'
+    }
+};
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default Exporting;

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

@@ -0,0 +1,68 @@
+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;
+}
+declare module '../../Core/Options' {
+    interface Options {
+        /**
+         * Options for the exporting.
+         *
+         * Try it: {@link https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/grid-pro/basic/exporting | Export to CSV}
+         */
+        exporting?: ExportingOptions;
+    }
+    interface ExportingOptions {
+        /**
+         * The file name to use for exported the grid.
+         */
+        filename?: string;
+        /**
+         * Exporting options for the CSV.
+         */
+        csv?: {
+            /**
+             * The decimal point to use in the CSV string.
+             */
+            decimalPoint?: string;
+            /**
+             * Whether to export the first row as column names.
+             *
+             * @default true
+             */
+            firstRowAsNames?: boolean;
+            /**
+             * The delimiter used to separate the values in the CSV string.
+             *
+             * @default ','
+             * */
+            itemDelimiter?: string;
+            /**
+             * The delimiter used to separate the lines in the CSV string.
+             *
+             * @default '\n'
+             */
+            lineDelimiter?: string;
+            /**
+             * Whether to use the local decimal point as detected from the
+             * browser.
+             *
+             * @default true
+             */
+            useLocalDecimalPoint?: boolean;
+        };
+    }
+}
+declare module '../../Core/Grid' {
+    export default interface Grid {
+        exporting?: Exporting;
+    }
+}
+export default ExportingComposition;

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

@@ -0,0 +1,55 @@
+/* *
+ *
+ *  Grid Exporting composition
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Karol Kolodziej
+ *
+ * */
+'use strict';
+import Defaults 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
+ *
+ * */
+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);
+    }
+})(ExportingComposition || (ExportingComposition = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default ExportingComposition;

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

@@ -0,0 +1,119 @@
+import type Column from '../Core/Table/Column';
+import type TableCell from '../Core/Table/Body/TableCell';
+import type Grid from '../Core/Grid';
+/**
+ * Callback function to be called when a cell event is triggered.
+ */
+export type CellEventCallback = (this: TableCell) => void;
+/**
+ * Callback function to be called when a column event is triggered.
+ */
+export type ColumnEventCallback = (this: Column) => void;
+/**
+ * Callback function to be called when a grid event is triggered.
+ */
+export type GridEventCallback = (this: Grid) => void;
+/**
+ * Events related to the cells.
+ */
+export interface CellEvents {
+    /**
+     * Callback function to be called when the cell is clicked.
+     */
+    click?: CellEventCallback;
+    /**
+     * Callback function to be called when the cell is double clicked.
+     */
+    dblClick?: CellEventCallback;
+    /**
+     * Callback function to be called when the cell is hovered.
+     */
+    mouseOver?: CellEventCallback;
+    /**
+     * Callback function to be called when the cell is no longer hovered.
+     */
+    mouseOut?: CellEventCallback;
+    /**
+     * Callback function to be called after the cell value is set (on init or
+     * after editing).
+     */
+    afterRender?: CellEventCallback;
+}
+/**
+ * Event callbacks option group related to the column.
+ */
+export interface ColumnEvents {
+    /**
+     * Callback function to be called when the column is filtered, after input
+     * keypress or select change events, but before the filtering is applied.
+     */
+    beforeFilter?: ColumnEventCallback;
+    /**
+     * Callback function to be called when the column is filtered, after input
+     * keypress or select change events, and the filtering is applied.
+     */
+    afterFilter?: ColumnEventCallback;
+    /**
+     * Callback function to be called when the column is sorted,
+     * before clicking on header.
+     */
+    beforeSort?: ColumnEventCallback;
+    /**
+     * Callback function to be called when the column is sorted,
+     * after clicking on header.
+     */
+    afterSort?: ColumnEventCallback;
+    /**
+     * Callback function to be called when the column is resized.
+     */
+    afterResize?: ColumnEventCallback;
+}
+export interface HeaderEvents {
+    /**
+     * Callback function to be called when the header is clicked.
+     */
+    click?: ColumnEventCallback;
+    /**
+     * Callback function to be called after the header is initialized.
+     */
+    afterRender?: ColumnEventCallback;
+}
+/**
+ * Events options.
+ */
+export interface GridEvents {
+    /**
+     * Callback function to be called before the grid is loaded.
+     */
+    beforeLoad?: GridEventCallback;
+    /**
+     * Callback function to be called after the grid is loaded.
+     */
+    afterLoad?: GridEventCallback;
+}
+declare module '../Core/Options' {
+    interface Options {
+        /**
+         * Events options triggered by the grid.
+         */
+        events?: GridEvents;
+    }
+    interface ColumnCellOptions {
+        /**
+         * Events options triggered by the grid elements.
+         */
+        events?: CellEvents;
+    }
+    interface ColumnOptions {
+        /**
+         * Events options triggered by the grid elements.
+         */
+        events?: ColumnEvents;
+    }
+    interface ColumnHeaderOptions {
+        /**
+         * Events options triggered by the grid elements.
+         */
+        events?: HeaderEvents;
+    }
+}

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

@@ -0,0 +1,107 @@
+/* *
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+import U from '../../Core/Utilities.js';
+import Globals from '../../Core/Globals.js';
+const { addEvent, fireEvent, pushUnique } = U;
+const propagate = {
+    'cell_mouseOver': function () {
+        fireEvent(this.row.viewport.grid, 'cellMouseOver', {
+            target: this
+        });
+    },
+    'cell_mouseOut': function () {
+        fireEvent(this.row.viewport.grid, 'cellMouseOut', {
+            target: this
+        });
+    }
+};
+/* *
+ *
+ *  Functions
+ *
+ * */
+/**
+ * Composition to add events options to the Grid.
+ *
+ * @param GridClass
+ * The class to extend.
+ *
+ * @param ColumnClass
+ * The class to extend.
+ *
+ * @param HeaderCellClass
+ * The class to extend.
+ *
+ * @param TableCellClass
+ * The class to extend.
+ *
+ * @internal
+ */
+function compose(GridClass, ColumnClass, HeaderCellClass, TableCellClass) {
+    if (!pushUnique(Globals.composed, 'GridEvents')) {
+        return;
+    }
+    [
+        'beforeLoad',
+        'afterLoad'
+    ].forEach((name) => {
+        addEvent(GridClass, name, (e) => {
+            const grid = e.target;
+            grid.options?.events?.[name]?.call(grid);
+        });
+    });
+    [
+        'mouseOver',
+        'mouseOut',
+        'dblClick',
+        'click',
+        'afterRender'
+    ].forEach((name) => {
+        addEvent(TableCellClass, name, (e) => {
+            const cell = e.target;
+            cell.column.options.cells?.events?.[name]?.call(cell);
+            propagate['cell_' + name]?.call(cell);
+        });
+    });
+    [
+        'afterResize',
+        'beforeSort',
+        'afterSort',
+        'beforeFilter',
+        'afterFilter'
+    ].forEach((name) => {
+        addEvent(ColumnClass, name, (e) => {
+            const column = e.target;
+            column.options?.events?.[name]?.call(column);
+        });
+    });
+    [
+        'click',
+        'afterRender'
+    ].forEach((name) => {
+        addEvent(HeaderCellClass, name, (e) => {
+            const { column } = e;
+            column?.options?.header?.events?.[name]?.call(column);
+        });
+    });
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+/**
+ * @internal
+ */
+export default { compose };

package/es-modules/Grid/Pro/Pagination/PaginationComposition.d.ts

@@ -0,0 +1,75 @@
+import type Pagination from '../../Core/Pagination/Pagination';
+declare namespace PaginationComposition {
+    /**
+     * Extends the pagination class with events.
+     *
+     * @param PaginationClass
+     * The class to extend.
+     *
+     */
+    function compose(PaginationClass: typeof Pagination): void;
+}
+declare module '../../Core/Pagination/PaginationOptions' {
+    interface PaginationOptions {
+        /**
+         * Pagination events.
+         *
+         */
+        events?: PaginationEvents;
+    }
+}
+/**
+ * Pagination events for Pro version.
+ */
+export interface PaginationEvents {
+    /**
+     * Fired before a page change occurs.
+     *
+     * @param e
+     * The event object.
+     */
+    beforePageChange?: (e: BeforePageChangeEvent) => void;
+    /**
+     * Fired after a page change occurs.
+     *
+     * @param e
+     * The event object.
+     */
+    afterPageChange?: (e: AfterPageChangeEvent) => void;
+    /**
+     * Fired before the page size setting changes.
+     *
+     * @param e
+     * The event object.
+     */
+    beforePageSizeChange?: (e: BeforePageSizeChangeEvent) => void;
+    /**
+     * Fired after the page size setting changes.
+     *
+     * @param e
+     * The event object.
+     */
+    afterPageSizeChange?: (e: AfterPageSizeChangeEvent) => void;
+}
+export interface BeforePageChangeEvent {
+    currentPage: number;
+    nextPage: number;
+    pageSize: number;
+}
+export interface AfterPageChangeEvent {
+    currentPage: number;
+    previousPage: number;
+    pageSize: number;
+}
+export interface BeforePageSizeChangeEvent {
+    pageSize: number;
+    newPageSize: number;
+}
+export interface AfterPageSizeChangeEvent {
+    pageSize: number;
+    previousPageSize: number;
+}
+export type PaginationEvent = Record<string, number> & {
+    target: Pagination;
+};
+export default PaginationComposition;

package/es-modules/Grid/Pro/Pagination/PaginationComposition.js

@@ -0,0 +1,76 @@
+/* *
+ *
+ *  Grid Pro Pagination class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+import Utilities from '../../../Core/Utilities.js';
+import Globals from '../../../Core/Globals.js';
+const { addEvent, pushUnique } = Utilities;
+/* *
+ *
+ *  Class Namespace
+ *
+ * */
+var PaginationComposition;
+(function (PaginationComposition) {
+    /**
+     * Extends the pagination class with events.
+     *
+     * @param PaginationClass
+     * The class to extend.
+     *
+     */
+    function compose(PaginationClass) {
+        if (!pushUnique(Globals.composed, 'PaginationPro')) {
+            return;
+        }
+        // Register pagination events
+        addEvent(PaginationClass, 'beforePageChange', (e) => {
+            const { target, currentPage, nextPage, pageSize } = e;
+            target.options.events?.beforePageChange?.call(target, {
+                currentPage: currentPage,
+                nextPage: nextPage,
+                pageSize: pageSize
+            });
+        });
+        addEvent(PaginationClass, 'afterPageChange', (e) => {
+            const { target, currentPage, previousPage, pageSize } = e;
+            target.options.events?.afterPageChange?.call(target, {
+                currentPage: currentPage,
+                previousPage: previousPage,
+                pageSize: pageSize
+            });
+        });
+        addEvent(PaginationClass, 'beforePageSizeChange', (e) => {
+            const { target, newPageSize, pageSize } = e;
+            target.options.events?.beforePageSizeChange?.call(target, {
+                pageSize: pageSize,
+                newPageSize: newPageSize
+            });
+        });
+        addEvent(PaginationClass, 'afterPageSizeChange', (e) => {
+            const { target, previousPageSize, pageSize } = e;
+            target.options.events?.afterPageSizeChange?.call(target, {
+                pageSize: pageSize,
+                previousPageSize: previousPageSize
+            });
+        });
+    }
+    PaginationComposition.compose = compose;
+})(PaginationComposition || (PaginationComposition = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default PaginationComposition;