@progress/kendo-angular-grid
Version:
Kendo UI Grid for Angular - high performance data grid with paging, filtering, virtualization, CRUD, and more.
54 lines (53 loc) • 2.12 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
/**
* Configures the `filterable` option for the Grid.
*
* The possible values are:
* * `row`—Shows a filter row in the Grid. [See example](slug:filter_row).
* * `menu`—Shows a filter menu in the Grid. [See example](slug:filter_menu).
* * `menu, row`—Shows both filter menu and filter row.
*
* @example
* ```html
* <kendo-grid filterable="menu, row"></kendo-grid>
* ```
*/
export type FilterableSettings = boolean | 'row' | 'menu' | 'menu, row';
/**
* Configures the supported UI variants for the column's filter menu.
*
* The possible values are:
* - `default`—Renders the standard filter UI (e.g. text, numeric, date inputs with operator pickers).
* - `multiCheckbox`—Renders a list of distinct column values with checkboxes for inclusion/exclusion filtering.
*/
export type FilterVariant = 'default' | 'multiCheckbox';
export interface FilterVariantSettings {
/**
* Specifies the filter menu variant.
*/
variant: FilterVariant;
/**
* Specifies if the search input is displayed. By default the input is visible.
*/
search?: boolean;
/**
* Allows providing custom set of filter list values. Each entry must include a field matching the target column's field.
* By default, the filter list is populated with unique values from the Grid's data, taking into account their format as well (if present).
*/
data?: Array<any>;
}
/**
* @hidden
*/
export declare const isFilterable: (settings: FilterableSettings) => settings is true | "row" | "menu" | "menu, row";
/**
* @hidden
*/
export declare const hasFilterMenu: (settings: FilterableSettings) => boolean;
/**
* @hidden
*/
export declare const hasFilterRow: (settings: FilterableSettings) => boolean;