@highcharts/grid-pro 2.0.0

package/es-modules/Grid/Core/Defaults.js

@@ -0,0 +1,148 @@
+/* *
+ *
+ *  Grid default options
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+import Utils from '../../Core/Utilities.js';
+const { merge } = Utils;
+/**
+ * Namespace for default options.
+ */
+var Defaults;
+(function (Defaults) {
+    /**
+     * Default options for the Grid.
+     */
+    Defaults.defaultOptions = {
+        accessibility: {
+            enabled: true,
+            highContrastMode: 'auto',
+            announcements: {
+                sorting: true,
+                filtering: true
+            }
+        },
+        lang: {
+            accessibility: {
+                sorting: {
+                    sortable: 'Sortable.',
+                    announcements: {
+                        ascending: 'Sorted ascending.',
+                        descending: 'Sorted descending.',
+                        none: 'Not sorted.'
+                    }
+                },
+                pagination: {
+                    announcements: {
+                        pageSizeChange: 'Page size changed to',
+                        pageChange: 'Page changed to'
+                    }
+                },
+                filtering: {
+                    announcements: {
+                        filterApplied: 'Filter applied for {columnId}, ' +
+                            '{condition} {value}. {rowsCount} results found.',
+                        emptyFilterApplied: 'Filter applied for {columnId}, ' +
+                            '{condition} values. {rowsCount} results found.',
+                        filterCleared: 'Filter cleared for {columnId}. ' +
+                            '{rowsCount} results found.'
+                    }
+                }
+            },
+            loading: 'Loading...',
+            noData: 'No data to display',
+            filter: 'Filter',
+            sortAscending: 'Sort ascending',
+            sortDescending: 'Sort descending',
+            column: 'Column',
+            setFilter: 'Set filter',
+            pagination: {
+                pageInfo: 'Showing {start} - {end} of {total} ' +
+                    '(page {currentPage} of {totalPages})',
+                pageSizeLabel: 'rows per page',
+                firstPage: 'First page',
+                previousPage: 'Previous page',
+                nextPage: 'Next page',
+                lastPage: 'Last page',
+                pageNumber: 'Page {page}',
+                ellipsis: 'More pages'
+            },
+            columnFilteringConditions: {
+                contains: 'Contains',
+                doesNotContain: 'Does not contain',
+                equals: 'Equals',
+                doesNotEqual: 'Does not equal',
+                beginsWith: 'Begins with',
+                endsWith: 'Ends with',
+                empty: 'Empty',
+                notEmpty: 'Not empty',
+                greaterThan: 'Greater than',
+                greaterThanOrEqualTo: 'Greater than or equal to',
+                lessThan: 'Less than',
+                lessThanOrEqualTo: 'Less than or equal to',
+                before: 'Before',
+                after: 'After',
+                all: 'All',
+                'true': 'True',
+                'false': 'False'
+            }
+        },
+        time: {
+            timezone: 'UTC'
+        },
+        rendering: {
+            rows: {
+                bufferSize: 10,
+                minVisibleRows: 2,
+                strictHeights: false,
+                virtualizationThreshold: 50
+            },
+            header: {
+                enabled: true
+            },
+            columns: {
+                resizing: {
+                    enabled: true,
+                    mode: 'adjacent'
+                }
+            },
+            theme: 'hcg-theme-default'
+        },
+        columnDefaults: {
+            sorting: {
+                sortable: true
+            },
+            filtering: {
+                inline: false
+            }
+        }
+    };
+    /**
+     * Merge the default options with custom options. Commonly used for defining
+     * reusable templates.
+     *
+     * @param options
+     * The new custom chart options.
+     */
+    function setOptions(options) {
+        merge(true, Defaults.defaultOptions, options);
+    }
+    Defaults.setOptions = setOptions;
+})(Defaults || (Defaults = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default Defaults;

package/es-modules/Grid/Core/Globals.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Globals Grid namespace.
+ */
+declare namespace Globals {
+    type DeepRequired<T> = {
+        [K in keyof T]-?: DeepRequired<T[K]>;
+    };
+    type ClassNameKey = keyof typeof rawClassNames;
+    const classNamePrefix: string;
+    const rawClassNames: {
+        readonly container: "container";
+        readonly tableElement: "table";
+        readonly captionElement: "caption";
+        readonly descriptionElement: "description";
+        readonly theadElement: "thead";
+        readonly tbodyElement: "tbody";
+        readonly rowElement: "row";
+        readonly rowEven: "row-even";
+        readonly rowOdd: "row-odd";
+        readonly hoveredRow: "hovered-row";
+        readonly columnElement: "column";
+        readonly hoveredCell: "hovered-cell";
+        readonly hoveredColumn: "hovered-column";
+        readonly syncedRow: "synced-row";
+        readonly syncedCell: "synced-cell";
+        readonly syncedColumn: "synced-column";
+        readonly editedCell: "edited-cell";
+        readonly mockedRow: "mocked-row";
+        readonly rowsContentNowrap: "rows-content-nowrap";
+        readonly virtualization: "virtualization";
+        readonly scrollableContent: "scrollable-content";
+        readonly headerCell: "header-cell";
+        readonly headerCellContainer: "header-cell-container";
+        readonly headerCellContent: "header-cell-content";
+        readonly headerCellFilterIcon: "header-cell-filter-icon";
+        readonly headerCellIcons: "header-cell-icons";
+        readonly headerCellSortIcon: "header-cell-sort-icon";
+        readonly headerCellMenuIcon: "header-cell-menu-icon";
+        readonly headerRow: "head-row-content";
+        readonly noData: "no-data";
+        readonly noPadding: "no-padding";
+        readonly columnFirst: "column-first";
+        readonly columnSortable: "column-sortable";
+        readonly columnSortableIcon: "column-sortable-icon";
+        readonly columnSortedAsc: "column-sorted-asc";
+        readonly columnSortedDesc: "column-sorted-desc";
+        readonly resizableContent: "resizable-content";
+        readonly resizerHandles: "column-resizer";
+        readonly resizedColumn: "column-resized";
+        readonly creditsContainer: "credits-container";
+        readonly creditsText: "credits";
+        readonly creditsPro: "credits-pro";
+        readonly visuallyHidden: "visually-hidden";
+        readonly lastHeaderCellInRow: "last-header-cell-in-row";
+        readonly loadingWrapper: "loading-wrapper";
+        readonly loadingSpinner: "spinner";
+        readonly loadingMessage: "loading-message";
+        readonly popup: "popup";
+        readonly button: "button";
+        readonly icon: "icon";
+        readonly iconSearch: "icon-search";
+        readonly popupContent: "popup-content";
+        readonly columnFilterWrapper: "column-filter-wrapper";
+        readonly toolbarButtonActiveIndicator: "active-indicator";
+        readonly menuContainer: "menu-container";
+        readonly menuItem: "menu-item";
+        readonly menuHeader: "menu-header";
+        readonly menuHeaderCategory: "menu-header-category";
+        readonly menuHeaderName: "menu-header-name";
+        readonly menuItemIcon: "menu-item-icon";
+        readonly menuItemLabel: "menu-item-label";
+        readonly menuDivider: "menu-divider";
+        readonly clearFilterButton: "clear-filter-button";
+        readonly paginationWrapper: "pagination-wrapper";
+        readonly paginationContainer: "pagination-container";
+        readonly paginationPageInfo: "pagination-info";
+        readonly paginationControls: "pagination-controls";
+        readonly paginationButton: "pagination-btn";
+        readonly paginationButtonDisabled: "pagination-btn-disabled";
+        readonly paginationFirstButton: "pagination-first";
+        readonly paginationPrevButton: "pagination-prev";
+        readonly paginationNextButton: "pagination-next";
+        readonly paginationLastButton: "pagination-last";
+        readonly paginationPageButton: "pagination-page";
+        readonly paginationPageButtonActive: "pagination-page-active";
+        readonly paginationEllipsis: "pagination-ellipsis";
+        readonly paginationMobileSelector: "pagination-mobile-selector";
+        readonly paginationMobilePageSizeSelector: "pagination-mobile-page-size-selector";
+        readonly paginationPageSizeContainer: "pagination-page-size-container";
+        readonly paginationPageSizeSelect: "pagination-page-size-select";
+        readonly noWidth: "no-width";
+        readonly rightAlign: "right";
+        readonly centerAlign: "center";
+        readonly leftAlign: "left";
+    };
+    const win: Window & typeof globalThis;
+    const composed: Array<string>;
+    const userAgent: string;
+    const isChrome: boolean;
+    const isSafari: boolean;
+    const getClassName: (classNameKey: ClassNameKey) => string;
+}
+export default Globals;

package/es-modules/Grid/Core/Globals.js

@@ -0,0 +1,134 @@
+/* *
+ *
+ *  (c) 2009-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Globals Grid namespace.
+ */
+var Globals;
+(function (Globals) {
+    /* *
+     *
+     *  Declarations
+     *
+     * */
+    /* *
+     *
+     *  Constants
+     *
+     * */
+    Globals.classNamePrefix = 'hcg-';
+    Globals.rawClassNames = {
+        container: 'container',
+        tableElement: 'table',
+        captionElement: 'caption',
+        descriptionElement: 'description',
+        theadElement: 'thead',
+        tbodyElement: 'tbody',
+        rowElement: 'row',
+        rowEven: 'row-even',
+        rowOdd: 'row-odd',
+        hoveredRow: 'hovered-row',
+        columnElement: 'column',
+        hoveredCell: 'hovered-cell',
+        hoveredColumn: 'hovered-column',
+        syncedRow: 'synced-row',
+        syncedCell: 'synced-cell',
+        syncedColumn: 'synced-column',
+        editedCell: 'edited-cell',
+        mockedRow: 'mocked-row',
+        rowsContentNowrap: 'rows-content-nowrap',
+        virtualization: 'virtualization',
+        scrollableContent: 'scrollable-content',
+        headerCell: 'header-cell',
+        headerCellContainer: 'header-cell-container',
+        headerCellContent: 'header-cell-content',
+        headerCellFilterIcon: 'header-cell-filter-icon',
+        headerCellIcons: 'header-cell-icons',
+        headerCellSortIcon: 'header-cell-sort-icon',
+        headerCellMenuIcon: 'header-cell-menu-icon',
+        headerRow: 'head-row-content',
+        noData: 'no-data',
+        noPadding: 'no-padding',
+        columnFirst: 'column-first',
+        columnSortable: 'column-sortable',
+        columnSortableIcon: 'column-sortable-icon',
+        columnSortedAsc: 'column-sorted-asc',
+        columnSortedDesc: 'column-sorted-desc',
+        resizableContent: 'resizable-content',
+        resizerHandles: 'column-resizer',
+        resizedColumn: 'column-resized',
+        creditsContainer: 'credits-container',
+        creditsText: 'credits',
+        creditsPro: 'credits-pro',
+        visuallyHidden: 'visually-hidden',
+        lastHeaderCellInRow: 'last-header-cell-in-row',
+        loadingWrapper: 'loading-wrapper',
+        loadingSpinner: 'spinner',
+        loadingMessage: 'loading-message',
+        popup: 'popup',
+        button: 'button',
+        icon: 'icon',
+        iconSearch: 'icon-search',
+        popupContent: 'popup-content',
+        columnFilterWrapper: 'column-filter-wrapper',
+        toolbarButtonActiveIndicator: 'active-indicator',
+        menuContainer: 'menu-container',
+        menuItem: 'menu-item',
+        menuHeader: 'menu-header',
+        menuHeaderCategory: 'menu-header-category',
+        menuHeaderName: 'menu-header-name',
+        menuItemIcon: 'menu-item-icon',
+        menuItemLabel: 'menu-item-label',
+        menuDivider: 'menu-divider',
+        clearFilterButton: 'clear-filter-button',
+        paginationWrapper: 'pagination-wrapper',
+        paginationContainer: 'pagination-container',
+        paginationPageInfo: 'pagination-info',
+        paginationControls: 'pagination-controls',
+        paginationButton: 'pagination-btn',
+        paginationButtonDisabled: 'pagination-btn-disabled',
+        paginationFirstButton: 'pagination-first',
+        paginationPrevButton: 'pagination-prev',
+        paginationNextButton: 'pagination-next',
+        paginationLastButton: 'pagination-last',
+        paginationPageButton: 'pagination-page',
+        paginationPageButtonActive: 'pagination-page-active',
+        paginationEllipsis: 'pagination-ellipsis',
+        paginationMobileSelector: 'pagination-mobile-selector',
+        paginationMobilePageSizeSelector: 'pagination-mobile-page-size-selector',
+        paginationPageSizeContainer: 'pagination-page-size-container',
+        paginationPageSizeSelect: 'pagination-page-size-select',
+        noWidth: 'no-width',
+        rightAlign: 'right',
+        centerAlign: 'center',
+        leftAlign: 'left'
+    };
+    Globals.win = window;
+    Globals.composed = [];
+    Globals.userAgent = (Globals.win.navigator && Globals.win.navigator.userAgent) || '';
+    Globals.isChrome = Globals.userAgent.indexOf('Chrome') !== -1;
+    Globals.isSafari = !Globals.isChrome && Globals.userAgent.indexOf('Safari') !== -1;
+    Globals.getClassName = (classNameKey) => Globals.classNamePrefix + Globals.rawClassNames[classNameKey];
+})(Globals || (Globals = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default Globals;

package/es-modules/Grid/Core/Grid.d.ts

@@ -0,0 +1,295 @@
+import type { Options, GroupedHeaderOptions } from './Options';
+import type Column from './Table/Column';
+import type Popup from './UI/Popup.js';
+import Accessibility from './Accessibility/Accessibility.js';
+import DataTable from '../../Data/DataTable.js';
+import Table from './Table/Table.js';
+import TimeBase from '../../Shared/TimeBase.js';
+import Pagination from './Pagination/Pagination.js';
+/**
+ * A base class for the Grid.
+ */
+declare class Grid {
+    /**
+     * Creates a new Grid.
+     *
+     * @param renderTo
+     * The render target (html element or id) of the Grid.
+     *
+     * @param options
+     * The options of the Grid.
+     *
+     * @param async
+     * Whether to initialize the dashboard asynchronously. When true, the
+     * function returns a promise that resolves with the dashboard instance.
+     *
+     * @return
+     * The new Grid.
+     */
+    static grid(renderTo: string | HTMLElement, options: Options, async?: boolean): Grid;
+    /**
+     * Creates a new Grid.
+     *
+     * @param renderTo
+     * The render target (html element or id) of the Grid.
+     *
+     * @param options
+     * The options of the Grid.
+     *
+     * @param async
+     * Whether to initialize the dashboard asynchronously. When true, the
+     * function returns a promise that resolves with the dashboard instance.
+     *
+     * @return
+     * Promise that resolves with the new Grid.
+     */
+    static grid(renderTo: string | HTMLElement, options: Options, async: true): Promise<Grid>;
+    /**
+     * An array containing the current Grid objects in the page.
+     * @private
+     */
+    static readonly grids: Array<(Grid | undefined)>;
+    /**
+     * The accessibility controller.
+     */
+    accessibility?: Accessibility;
+    /**
+     * The Pagination controller.
+     */
+    pagination?: Pagination;
+    /**
+     * The caption element of the Grid.
+     */
+    captionElement?: HTMLElement;
+    /**
+     * The container of the grid.
+     */
+    container?: HTMLElement;
+    /**
+     * The content container of the Grid.
+     */
+    contentWrapper?: HTMLElement;
+    /**
+     * The data source of the Grid. It contains the original data table
+     * that was passed to the Grid.
+     */
+    dataTable?: DataTable;
+    /**
+     * The description element of the Grid.
+     */
+    descriptionElement?: HTMLElement;
+    /**
+     * The container element of the loading indicator overlaying the Grid.
+     */
+    loadingWrapper?: HTMLElement;
+    /**
+     * The presentation table of the Grid. It contains a modified version
+     * of the data table that is used for rendering the Grid content. If
+     * not modified, just a reference to the original data table.
+     */
+    presentationTable?: DataTable;
+    /**
+     * The HTML element of the table.
+     */
+    tableElement?: HTMLTableElement;
+    /**
+     * The options of the Grid. Contains the options that were declared
+     * by the user and some of the default options.
+     */
+    options?: Options;
+    /**
+     * The options that were declared by the user when creating the Grid
+     * or when updating it.
+     */
+    userOptions: Partial<Options>;
+    /**
+     * The table (viewport) element of the Grid.
+     */
+    viewport?: Table;
+    /**
+     * The time instance.
+     */
+    time: TimeBase;
+    /**
+     * The locale of the Grid.
+     */
+    locale?: string | string[];
+    /**
+     * The unique ID of the Grid.
+     */
+    id: string;
+    /**
+     * The list of currently shown popups.
+     */
+    popups: Set<Popup>;
+    /**
+     * Functions that unregister events attached to the grid's data table,
+     * that need to be removed when the grid is destroyed.
+     */
+    private dataTableEventDestructors;
+    /**
+     * Constructs a new Grid.
+     *
+     * @param renderTo
+     * The render target (container) of the Grid.
+     *
+     * @param options
+     * The options of the Grid.
+     *
+     * @param afterLoadCallback
+     * The callback that is called after the Grid is loaded.
+     */
+    constructor(renderTo: string | HTMLElement, options: Options, afterLoadCallback?: (grid: Grid) => void);
+    private initAccessibility;
+    private initPagination;
+    /**
+     * Initializes the container of the Grid.
+     *
+     * @param renderTo
+     * The render target (html element or id) of the Grid.
+     *
+     */
+    private initContainers;
+    /**
+     * Loads the new user options to all the important fields (`userOptions`,
+     * `options` and `columnOptionsMap`).
+     *
+     * @param newOptions
+     * The options that were declared by the user.
+     *
+     * @param oneToOne
+     * When `false` (default), the existing column options will be merged with
+     * the ones that are currently defined in the user options. When `true`,
+     * the columns not defined in the new options will be removed.
+     */
+    private loadUserOptions;
+    /**
+     * Sets the new column options to the userOptions field.
+     *
+     * @param newColumnOptions
+     * The new column options that should be loaded.
+     *
+     * @param overwrite
+     * Whether to overwrite the existing column options with the new ones.
+     * Default is `false`.
+     */
+    private setColumnOptions;
+    /**
+     * Loads the new column options to the userOptions field in a one-to-one
+     * manner. It means that all the columns that are not defined in the new
+     * options will be removed.
+     *
+     * @param newColumnOptions
+     * The new column options that should be loaded.
+     */
+    private setColumnOptionsOneToOne;
+    update(options?: Options, render?: boolean, oneToOne?: boolean): Promise<void>;
+    update(options: Options, render: false, oneToOne?: boolean): void;
+    updateColumn(columnId: string, options: Column.Options, render?: boolean, overwrite?: boolean): Promise<void>;
+    updateColumn(columnId: string, options: Column.Options, render?: false, overwrite?: boolean): void;
+    /**
+     * Hovers the row with the provided index. It removes the hover effect from
+     * the previously hovered row.
+     *
+     * @param rowIndex
+     * The index of the row.
+     */
+    hoverRow(rowIndex?: number): void;
+    /**
+     * Hovers the column with the provided ID. It removes the hover effect from
+     * the previously hovered column.
+     *
+     * @param columnId
+     * The ID of the column.
+     */
+    hoverColumn(columnId?: string): void;
+    /**
+     * Sets the sync state to the row with the provided index. It removes the
+     * synced effect from the previously synced row.
+     *
+     * @param rowIndex
+     * The index of the row.
+     */
+    syncRow(rowIndex?: number): void;
+    /**
+     * Sets the sync state to the column with the provided ID. It removes the
+     * synced effect from the previously synced column.
+     *
+     * @param columnId
+     * The ID of the column.
+     */
+    syncColumn(columnId?: string): void;
+    /**
+     * Renders the table (viewport) of the Grid.
+     *
+     * @returns
+     * The newly rendered table (viewport) of the Grid.
+     */
+    private renderTable;
+    /**
+     * Renders a message that there is no data to display.
+     */
+    private renderNoData;
+    /**
+     * Returns the array of IDs of columns that should be displayed in the data
+     * grid, in the correct order.
+     */
+    private getEnabledColumnIDs;
+    /**
+     * Loads the data table of the Grid. If the data table is passed as a
+     * reference, it should be used instead of creating a new one.
+     */
+    private loadDataTable;
+    /**
+     * Extracts all references to columnIds on all levels below defined level
+     * in the settings.header structure.
+     *
+     * @param columnsTree
+     * Structure that we start calculation
+     *
+     * @param [onlyEnabledColumns=true]
+     * Extract all columns from header or columns filtered by enabled param
+     * @returns
+     */
+    getColumnIds(columnsTree: Array<GroupedHeaderOptions | string>, onlyEnabledColumns?: boolean): string[];
+    /**
+     * Destroys the Grid.
+     */
+    destroy(): void;
+    /**
+     * Grey out the Grid and show a loading indicator.
+     *
+     * @param message
+     * The message to display in the loading indicator.
+     */
+    showLoading(message?: string): void;
+    /**
+     * Removes the loading indicator.
+     */
+    hideLoading(): void;
+    /**
+     * Returns the 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
+     */
+    getData(modified?: boolean): string;
+    /**
+     * Returns the current Grid options.
+     *
+     * @param onlyUserOptions
+     * Whether to return only the user options or all options (user options
+     * merged with the default ones). Default is `true`.
+     *
+     * @returns
+     * Grid options.
+     */
+    getOptions(onlyUserOptions?: boolean): Partial<Options>;
+}
+declare namespace Grid {
+}
+export default Grid;