Search results

FilterSettings API in JavaScript (ES5) Grid API control

Configures the filtering behavior of the Grid.

Properties

columns

PredicateModel[]

Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.

Defaults to []

enableCaseSensitivity

boolean

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.

Defaults to false

enableInfiniteScrolling

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.

<div id='Grid'></grid>
import { Grid, InfiniteScroll} from '@syncfusion/ej2-grids';
import { categoryData } from './data-source';
Grid.Inject(InfiniteScroll);
let grid: Grid = new Grid(
  {
    dataSource: categoryData,
    enableInfiniteScrolling: true,
    height: 300,   
  });
grid.appendTo('#Grid');

Defaults to false

ignoreAccent

boolean

If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.

Check the Diacritics filtering.

Defaults to false

immediateModeDelay

number

Defines the time delay (in milliseconds) in filtering records when the Immediate mode of filter bar is set.

Defaults to 1500

itemsCount

number

If enableInfiniteScrolling set to true, For on demand request, Gets data from the parent data source based on given number of records count.

Defaults to 100

loadingIndicator

IndicatorType

Defines the loading indicator. The available loading indicator are:

  • Spinner
  • Shimmer

Defaults to Shimmer

mode

FilterBarMode

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.

Defaults to OnEnter

operators

ICustomOptr

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 customization.

Defaults to null

showFilterBarOperator

boolean

If ‘showFilterBarOperator’ is set to true, then it renders the dropdownlist component to select the operator in filterbar input

Defaults to false

showFilterBarStatus

boolean

Shows or hides the filtered status message on the pager.

Defaults to true

type

FilterType

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.

Defaults to FilterBar