*
*
* Operator
|
* Description
|
* Supported Types
|
*
*
* startswith
|
* Checks whether the value begins with the specified value.
|
* String
|
*
*
* endswith
|
* Checks whether the value ends with the specified value.
|
*
String
|
*
*
* contains
|
* Checks whether the value contains the specified value.
|
*
String
|
*
*
* equal
|
* Checks whether the value is equal to the specified value.
|
*
String | Number | Boolean | Date
|
*
*
* notequal
|
* Checks for values that are not equal to the specified value.
|
*
String | Number | Boolean | Date
|
*
*
* greaterthan
|
* Checks whether the value is greater than the specified value.
|
* Number | Date
|
*
*
* greaterthanorequal
|
* Checks whether the value is greater than or equal to the specified value.
|
*
Number | Date
|
*
*
* lessthan
|
* Checks whether the value is less than the specified value.
|
*
Number | Date
|
*
*
* lessthanorequal
|
* Checks whether the value is less than or equal to the specified value.
|
*
Number | Date
|
*
*
* @default null
*/
operator?: string;
/**
* Defines the value used to filter records.
*
* @default ''
*/
value?: string | number | Date | boolean | (string | number | Date | boolean)[];
/**
* If match case set to true, then filter records with exact match or else
* filter records with case insensitive(uppercase and lowercase letters treated as same).
*
* @default null
*/
matchCase?: boolean;
/**
* If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering.
*
* @default false
*/
ignoreAccent?: boolean;
/**
* Defines the relationship between one filter query and another by using AND or OR predicate.
*
* @default null
*/
predicate?: string;
/**
* @hidden
* Defines the actual filter value for the filter column.
*/
actualFilterValue?: Object;
/**
* @hidden
* Defines the actual filter operator for the filter column.
*/
actualOperator?: Object;
/**
* @hidden
* Defines the type of the filter column.
*/
type?: string;
/**
* @hidden
* Defines the predicate of filter column.
*/
ejpredicate?: Object;
/**
* Defines the UID of filter column.
*
* @default ''
*/
uid?: string;
/**
* @hidden
* Defines the foreignKey availability in filtered columns.
*/
isForeignKey?: boolean;
/**
* Defines the condition to add the new predicates on existing predicate with "and"/"or" operator.
*
* @default ''
*/
condition?: string;
}
/**
* Interface for a class InfiniteScrollSettings
*/
export interface InfiniteScrollSettingsModel {
/**
* If `enableCache` is set to true, the Grid will cache the loaded data to be reused next time it is needed.
*
* @default false
*/
enableCache?: boolean;
/**
* Defines the number of blocks to be maintained in Grid while settings enableCache as true.
*
* @default 3
*/
maxBlocks?: number;
/**
* Defines the number of blocks that will render at the initial Grid rendering.
*
* @default 3
*/
initialBlocks?: number;
}
/**
* Interface for a class FilterSettings
*/
export interface FilterSettingsModel {
/**
* Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.
*
* @default []
*/
columns?: PredicateModel[];
/**
* Defines options for filtering type. The available options are
* * `Menu` - Specifies the filter type as menu.
* * `CheckBox` - Specifies the filter type as checkbox.
* * `FilterBar` - Specifies the filter type as filterbar.
* * `Excel` - Specifies the filter type as checkbox.
*
* @default FilterBar
*/
type?: FilterType;
/**
* Defines the filter bar modes. The available options are,
* * `OnEnter`: Initiates filter operation after Enter key is pressed.
* * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
*
* @default OnEnter
*/
mode?: FilterBarMode;
/**
* Shows or hides the filtered status message on the pager.
*
* @default true
*/
showFilterBarStatus?: boolean;
/**
* Defines the time delay (in milliseconds) in filtering records when the `Immediate` mode of filter bar is set.
*
* @default 1500
*/
immediateModeDelay?: number;
/**
* The `operators` is used to override the default operators in filter menu. This should be defined by type wise
* (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
*
* > Check the [`Filter Menu Operator`](../../grid/filtering/filter-menu#customizing-filter-menu-operators-list) customization.
*
* @default null
*/
operators?: ICustomOptr;
/**
* If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
*
* > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
*
* @default false
*/
ignoreAccent?: boolean;
/**
* If `enableInfiniteScrolling` set to true, then the data will be loaded in Checkbox filter `Popup` content, when the scrollbar reaches the end.
* This helps to load large dataset in Checkbox filter `Popup` content.
* {% codeBlock src='grid/enableInfiniteScrolling/index.md' %}{% endcodeBlock %}
*
* @default false
*/
enableInfiniteScrolling?: boolean;
/**
* If `enableInfiniteScrolling` set to true, For on demand request, Gets data from the parent data source based on given number of records count.
*
* @default 100
*/
itemsCount?: number;
/**
* Defines the loading indicator. The available loading indicator are:
* * Spinner
* * Shimmer
*
* @default Shimmer
*/
loadingIndicator?: IndicatorType;
/**
* If `enableCaseSensitivity` is set to true then searches grid records with exact match based on the filter
* operator. It will have no effect on number, boolean and Date fields.
*
* @default false
*/
enableCaseSensitivity?: boolean;
/**
* If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator
* in filterbar input
*
* @default false
*/
showFilterBarOperator?: boolean;
}
/**
* Interface for a class SelectionSettings
*/
export interface SelectionSettingsModel {
/**
* Grid supports row, cell, and both (row and cell) selection mode.
*
* @default Row
*/
mode?: SelectionMode;
/**
* The cell selection modes are flow and box. It requires the selection
* [`mode`](./selectionmode/) to be either cell or both.
* * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
* * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
* * `BoxWithBorder`: Selects the range of cells as like Box mode with borders.
*
* @default Flow
*/
cellSelectionMode?: CellSelectionMode;
/**
* Defines options for selection type. They are
* * `Single`: Allows selection of only a row or a cell.
* * `Multiple`: Allows selection of multiple rows or cells.
*
* @default Single
*/
type?: SelectionType;
/**
* If 'checkboxOnly' set to true, then the Grid selection is allowed only through checkbox.
*
* > To enable checkboxOnly selection, should specify the column type as`checkbox`.
*
* @default false
*/
checkboxOnly?: boolean;
/**
* If 'persistSelection' set to true, then the Grid selection is persisted on all operations.
* For persisting selection in the Grid, any one of the column should be enabled as a primary key.
*
* @default false
*/
persistSelection?: boolean;
/**
* Defines options for checkbox selection Mode. They are
* * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
* * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
* rows can be selected by using CTRL or SHIFT key.
*
* @default Default
*/
checkboxMode?: CheckboxSelectionType;
/**
* If 'enableSimpleMultiRowSelection' set to true, then the user can able to perform multiple row selection with single clicks.
*
* @default false
*/
enableSimpleMultiRowSelection?: boolean;
/**
* If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.
*
* @default true
*/
enableToggle?: boolean;
/**
* If 'allowColumnSelection' set to true, then the user can able to select the columns.
*
* @default false
*/
allowColumnSelection?: boolean;
}
/**
* Interface for a class SearchSettings
*/
export interface SearchSettingsModel {
/**
* Specifies the collection of fields included in search operation. By default, bounded columns of the Grid are included.
*
* @default []
*/
fields?: string[];
/**
* Specifies the key value to search Grid records at initial rendering.
* You can also get the current search key.
*
* @default ''
*/
key?: string;
/**
* Defines the operator to search records. The available operators are:
*