Configuring the Grid Filter

Summary

Developers can choose which of the Grid Filter UI controls (Query Builder or Expression Editor) are available
Run-time users can create and manage the Grid Filter in multiple ways

Setting UI Controls

By default both the Query Builder and Expression Editor are available to create Grid Filters.

However developers can configure AdapTable so that only one of these UI components is available.

This is done using the availableFilterEditors property in Grid Filter Options.

availableFilterEditors

Default: ['ExpressionEditor', 'QueryBuilder']

Which Editors are available for users to create Grid Filters

Set which of the UI Components should be available to end users when they create / edit Grid Filters.

// Only make the Query Builder available
gridFilterOptions: {
  availableFilterEditors: ['QueryBuilder']
},

Hint

This is useful when you prefer that users only use Query Builder and not the complexity of the Expression Editor

Grid Filter with Query Builder only

Fork Fork

This demo sets only the Query Builder to be used to create a Grid Filter (and not the Expression Editor also)

Try It Out

Click the "Expand" button in the Grid Filter toolbar and note that only the Query Builder is available

Clearing Grid Filter on Startup

AdapTable always saves the previously applied Grid Filter into AdapTable State (via the Current Layout).

It will then automatically re-apply this Grid Filter when the Application is reloaded.

If this behaviour is not desired, set the clearGridFilterOnStartUp property in Grid Filter Options to true.

clearGridFilterOnStartUp

Default: false

boolean

Clear the Grid Filter applied in previous session when Application re-starts

AdapTable saves all User State to either local or remote storage, including Column Filters.

It then re-applies a persisted Grid Filter when the application re-starts.

Setting this property to true will remove the Grid Filter from Adaptable State, and display a non-filtered AG Grid instance.

// Clear a previously set Grid Filter when AdapTable starts
const adaptableOptions: AdaptableOptions = {
    gridFilterOptions = {
        clearGridFilterOnStartUp: true
    }
};

Hint

The clearQuickSearchOnStartUp property in Quick Search Options will clear a saved Quick Search
The clearFiltersOnStartUp property in Filter Options will clear any saved Column Filters

PreviousDefining Grid Filter NextUsing Grid Filter