@highcharts/grid-pro 2.0.0

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

@@ -0,0 +1,228 @@
+/* *
+ *
+ *  (c) 2010-2024 Torstein Honsi
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ * */
+
+/* *
+ *
+ *  Declarations
+ *
+ * */
+
+/**
+ * Page size selector configuration options.
+ */
+export interface PageSizeSelectorOptions {
+    /**
+     * Whether the page size selector is enabled.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+
+    /**
+     * Available options for page size dropdown.
+     *
+     * @default [10, 20, 50, 100]
+     */
+    options: Array<number>;
+}
+
+/**
+ * Controls options for pagination UI elements.
+ */
+export interface PaginationControlsOptions {
+    /**
+     * Page size selector configuration including available options and enabled
+     * state. Users can select from the options to change the number of items
+     * displayed per page.
+     *
+     * @default { enabled: true, options: [10, 20, 50, 100] }
+     */
+    pageSizeSelector: boolean | PageSizeSelectorOptions;
+
+    /**
+     * Whether to show the page information text
+     * (e.g., "Showing 1 - 20 of 200").
+     *
+     * @default true
+     */
+    pageInfo?: boolean | PageInfoOptions;
+
+    /**
+     * Whether to show the first/last page controls buttons.
+     *
+     * @default true
+     */
+    firstLastButtons?: boolean | FirstLastButtonsOptions;
+
+    /**
+     * Whether to show the previous/next page controls buttons.
+     *
+     * @default true
+     */
+    previousNextButtons?: boolean | PreviousNextButtonsOptions;
+
+    /**
+     * Page number buttons configuration.
+     *
+     * @default { enabled: true, count: 5 }
+     */
+    pageButtons: boolean | PageButtonsOptions;
+}
+
+/**
+ * Language options for pagination text values.
+ */
+export interface PaginationLangOptions {
+    /**
+     * Text for the page information display.
+     * Placeholders: {start}, {end}, {total}, {currentPage}, {totalPages}
+     *
+     * @default "Showing {start} - {end} of {total} (Page {currentPage} of {totalPages})" // eslint-disable-line
+     */
+    pageInfo: string;
+
+    /**
+     * Text for the page size label.
+     *
+     * @default "rows per page"
+     */
+    pageSizeLabel: string;
+
+    /**
+     * Text for the first page button (accessibility).
+     *
+     * @default "First page"
+     */
+    firstPage: string;
+
+    /**
+     * Text for the previous page button (accessibility).
+     *
+     * @default "Previous page"
+     */
+    previousPage: string;
+
+    /**
+     * Text for the next page button (accessibility).
+     *
+     * @default "Next page"
+     */
+    nextPage: string;
+
+    /**
+     * Text for the last page button (accessibility).
+     *
+     * @default "Last page"
+     */
+    lastPage: string;
+
+    /**
+     * Text for page number button (accessibility).
+     * Placeholder: {page}
+     *
+     * @default "Page {page}"
+     */
+    pageNumber: string;
+
+    /**
+     * Text for ellipsis (accessibility).
+     *
+     * @default "More pages"
+     */
+    ellipsis: string;
+}
+
+/**
+ * Pagination options.
+ */
+export interface PaginationOptions {
+    /**
+     * Whether the pagination should be rendered.
+     *
+     * @default false
+     */
+    enabled: boolean;
+
+    /**
+     * Initial number of items per page when the Grid is initialized.
+     * This value will be used as the default page size if not specified
+     * in pageSizeSelector options.
+     *
+     * @default 10
+     */
+    pageSize: number;
+
+    /**
+     * Position of the pagination container relative to the table.
+     *
+     * @default 'bottom'
+     */
+    position?: string;
+
+    /**
+     * Controls options for pagination UI elements.
+     */
+    controls: PaginationControlsOptions;
+}
+
+/**
+ * Page buttons configuration options.
+ */
+export interface PageButtonsOptions {
+    /**
+     * Whether to show page number buttons.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+
+    /**
+     * Maximum number of page number buttons to show before using ellipsis.
+     *
+     * @default 5
+     */
+    count: number;
+}
+
+/**
+ * Page info configuration options.
+ */
+export interface PageInfoOptions {
+    /**
+     * Whether to show the page information text.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}
+
+/**
+ * First/last page navigation buttons configuration options.
+ */
+export interface FirstLastButtonsOptions {
+    /**
+     * Whether to show the first/last page navigation buttons.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}
+
+/**
+ * Previous/next page navigation buttons configuration options.
+ */
+export interface PreviousNextButtonsOptions {
+    /**
+     * Whether to show the previous/next page navigation buttons.
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}

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

@@ -0,0 +1,66 @@
+import type { FilterCondition } from '../../../Data/Modifiers/FilterModifierOptions.js';
+import type { FilteringCondition } from '../Options.js';
+import FilterModifier from '../../../Data/Modifiers/FilterModifier.js';
+import QueryingController from './QueryingController.js';
+/**
+ * Class that manages one of the data grid querying types - filtering.
+ */
+declare class FilteringController {
+    /**
+     * The data grid instance.
+     */
+    private querying;
+    /**
+     * A map of the filtering conditions for each column.
+     */
+    private columnConditions;
+    /**
+     * The modifier that is used to filter the data.
+     */
+    modifier?: FilterModifier;
+    /**
+     * Constructs the FilteringController instance.
+     *
+     * @param querying
+     * The querying controller instance.
+     */
+    constructor(querying: QueryingController);
+    /**
+     * Maps filtering options to the filtering condition.
+     *
+     * @param columnId
+     * Id of the column to filter.
+     *
+     * @param options
+     * Filtering options.
+     */
+    static mapOptionsToFilter(columnId: string, options: FilteringCondition): FilterCondition | undefined;
+    /**
+     * Loads filtering options from the data grid options.
+     */
+    loadOptions(): void;
+    /**
+     * Adds a new filtering condition to the specified column.
+     *
+     * @param columnId
+     * The column ID to filter in.
+     *
+     * @param options
+     * The filtering options.
+     */
+    addColumnFilterCondition(columnId: string, options: FilteringCondition): void;
+    /**
+     * Clears the filtering condition for the specified column. If no column ID
+     * is provided, clears all the column filtering conditions.
+     *
+     * @param columnId
+     * The column ID to clear or `undefined` to clear all the column filtering
+     * conditions.
+     */
+    clearColumnFiltering(columnId?: string): void;
+    /**
+     * Updates the modifier based on the current column conditions.
+     */
+    private updateModifier;
+}
+export default FilteringController;

package/es-modules/Grid/Core/Querying/FilteringController.js

@@ -0,0 +1,256 @@
+/* *
+ *
+ *  Grid Filtering Controller class
+ *
+ *  (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 FilterModifier from '../../../Data/Modifiers/FilterModifier.js';
+import U from '../../../Core/Utilities.js';
+const { isString } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Class that manages one of the data grid querying types - filtering.
+ */
+class FilteringController {
+    /* *
+    *
+    *  Constructor
+    *
+    * */
+    /**
+     * Constructs the FilteringController instance.
+     *
+     * @param querying
+     * The querying controller instance.
+     */
+    constructor(querying) {
+        /**
+         * A map of the filtering conditions for each column.
+         */
+        this.columnConditions = {};
+        this.querying = querying;
+    }
+    /* *
+    *
+    *  Functions
+    *
+    * */
+    /**
+     * Maps filtering options to the filtering condition.
+     *
+     * @param columnId
+     * Id of the column to filter.
+     *
+     * @param options
+     * Filtering options.
+     */
+    static mapOptionsToFilter(columnId, options) {
+        const { condition, value } = options;
+        const isStringValue = isString(value);
+        const stringifiedValue = isStringValue ? value : '';
+        const nonValueConditions = ['empty', 'notEmpty', 'true', 'false'];
+        if ((typeof value === 'undefined' ||
+            (isStringValue && !stringifiedValue)) && !nonValueConditions.includes(condition ?? '')) {
+            return;
+        }
+        switch (condition) {
+            case 'contains':
+                return {
+                    columnId,
+                    operator: 'contains',
+                    value: stringifiedValue
+                };
+            case 'doesNotContain':
+                return {
+                    operator: 'not',
+                    condition: {
+                        columnId,
+                        operator: 'contains',
+                        value: stringifiedValue
+                    }
+                };
+            case 'equals':
+                return {
+                    columnId,
+                    operator: '===',
+                    value
+                };
+            case 'doesNotEqual':
+                return {
+                    columnId,
+                    operator: '!==',
+                    value
+                };
+            case 'beginsWith':
+                return {
+                    columnId,
+                    operator: 'startsWith',
+                    value: stringifiedValue
+                };
+            case 'endsWith':
+                return {
+                    columnId,
+                    operator: 'endsWith',
+                    value: stringifiedValue
+                };
+            case 'greaterThan':
+                return {
+                    columnId,
+                    operator: '>',
+                    value
+                };
+            case 'greaterThanOrEqualTo':
+                return {
+                    columnId,
+                    operator: '>=',
+                    value
+                };
+            case 'lessThan':
+                return {
+                    columnId,
+                    operator: '<',
+                    value
+                };
+            case 'lessThanOrEqualTo':
+                return {
+                    columnId,
+                    operator: '<=',
+                    value
+                };
+            case 'before':
+                return {
+                    columnId,
+                    operator: '<',
+                    value
+                };
+            case 'after':
+                return {
+                    columnId,
+                    operator: '>',
+                    value
+                };
+            case 'empty':
+                return {
+                    columnId,
+                    operator: 'empty',
+                    value
+                };
+            case 'notEmpty':
+                return {
+                    operator: 'not',
+                    condition: {
+                        columnId,
+                        operator: 'empty',
+                        value
+                    }
+                };
+            case 'true':
+                return {
+                    columnId,
+                    operator: '===',
+                    value: true
+                };
+            case 'false':
+                return {
+                    columnId,
+                    operator: '===',
+                    value: false
+                };
+        }
+    }
+    /**
+     * Loads filtering options from the data grid options.
+     */
+    loadOptions() {
+        const columnOptionsMap = this.querying.grid.columnOptionsMap;
+        const newConditions = {};
+        if (columnOptionsMap) {
+            const columnIds = Object.keys(columnOptionsMap);
+            for (let i = 0, iEnd = columnIds.length; i < iEnd; ++i) {
+                const columnId = columnIds[i];
+                const filteringOptions = columnOptionsMap[columnId]?.options?.filtering;
+                if (!filteringOptions) {
+                    continue;
+                }
+                const condition = FilteringController.mapOptionsToFilter(columnId, filteringOptions);
+                if (condition) {
+                    newConditions[columnId] = condition;
+                }
+            }
+        }
+        this.columnConditions = newConditions;
+        this.updateModifier();
+    }
+    /**
+     * Adds a new filtering condition to the specified column.
+     *
+     * @param columnId
+     * The column ID to filter in.
+     *
+     * @param options
+     * The filtering options.
+     */
+    addColumnFilterCondition(columnId, options) {
+        const condition = FilteringController.mapOptionsToFilter(columnId, options);
+        if (condition) {
+            this.columnConditions[columnId] = condition;
+        }
+        else {
+            delete this.columnConditions[columnId];
+        }
+        this.updateModifier();
+    }
+    /**
+     * Clears the filtering condition for the specified column. If no column ID
+     * is provided, clears all the column filtering conditions.
+     *
+     * @param columnId
+     * The column ID to clear or `undefined` to clear all the column filtering
+     * conditions.
+     */
+    clearColumnFiltering(columnId) {
+        if (!columnId) {
+            this.columnConditions = {};
+        }
+        else {
+            delete this.columnConditions[columnId];
+        }
+        this.updateModifier();
+    }
+    /**
+     * Updates the modifier based on the current column conditions.
+     */
+    updateModifier() {
+        const columnConditions = Object.values(this.columnConditions);
+        this.querying.shouldBeUpdated = true;
+        if (columnConditions.length < 1) {
+            delete this.modifier;
+            return;
+        }
+        this.modifier = new FilterModifier({
+            condition: {
+                operator: 'and',
+                conditions: columnConditions
+            }
+        });
+    }
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default FilteringController;

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

@@ -0,0 +1,50 @@
+import QueryingController from './QueryingController.js';
+import RangeModifier from '../../../Data/Modifiers/RangeModifier.js';
+/**
+ * Class that manages one of the data grid querying types - pagination.
+ */
+declare class PaginationController {
+    /**
+     * The grid instance.
+     */
+    private querying;
+    /**
+     * The current page.
+     */
+    currentPage?: number;
+    /**
+     * The number of rows before pagination.
+     */
+    totalItems?: number;
+    /**
+     * Constructs the PaginationController instance.
+     *
+     * @param querying
+     * The querying controller instance.
+     */
+    constructor(querying: QueryingController);
+    /**
+     * Sets the range options.
+     *
+     * @param currentPage
+     * The current page.
+     */
+    setRange(currentPage: number): void;
+    /**
+     * Loads range options from the grid options.
+     */
+    loadOptions(): void;
+    /**
+     * Returns the range modifier.
+     *
+     * @param rowsCountBeforePagination
+     * The number of rows before pagination. Default is the number of rows in
+     * the original data table.
+     */
+    createModifier(rowsCountBeforePagination?: number): RangeModifier | undefined;
+    /**
+     * Reset the pagination controller.
+     */
+    reset(): void;
+}
+export default PaginationController;

package/es-modules/Grid/Core/Querying/PaginationController.js

@@ -0,0 +1,101 @@
+/* *
+ *
+ *  Grid Pagination Controller 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 RangeModifier from '../../../Data/Modifiers/RangeModifier.js';
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Class that manages one of the data grid querying types - pagination.
+ */
+class PaginationController {
+    /* *
+    *
+    *  Constructor
+    *
+    * */
+    /**
+     * Constructs the PaginationController instance.
+     *
+     * @param querying
+     * The querying controller instance.
+     */
+    constructor(querying) {
+        this.querying = querying;
+    }
+    /* *
+    *
+    *  Functions
+    *
+    * */
+    /**
+     * Sets the range options.
+     *
+     * @param currentPage
+     * The current page.
+     */
+    setRange(currentPage) {
+        this.currentPage = currentPage;
+        this.querying.shouldBeUpdated = true;
+    }
+    /**
+     * Loads range options from the grid options.
+     */
+    loadOptions() {
+        const pagination = this.querying.grid.pagination;
+        if (pagination?.options.enabled &&
+            this.currentPage !== pagination.currentPage) {
+            this.currentPage = pagination.currentPage;
+            this.setRange(this.currentPage);
+        }
+    }
+    /**
+     * Returns the range modifier.
+     *
+     * @param rowsCountBeforePagination
+     * The number of rows before pagination. Default is the number of rows in
+     * the original data table.
+     */
+    createModifier(rowsCountBeforePagination = (this.querying.grid.dataTable?.rowCount || 0)) {
+        const currentPage = this.currentPage || 1; // Start from page 1, not 0
+        const pageSize = this.querying.grid.pagination?.currentPageSize;
+        if (!pageSize) {
+            return;
+        }
+        // Calculate the start index (0-based)
+        const start = (currentPage - 1) * pageSize;
+        const end = Math.min(start + pageSize, rowsCountBeforePagination);
+        this.totalItems = rowsCountBeforePagination;
+        return new RangeModifier({
+            start,
+            end
+        });
+    }
+    /**
+     * Reset the pagination controller.
+     */
+    reset() {
+        delete this.currentPage;
+        this.querying.shouldBeUpdated = true;
+    }
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default PaginationController;