Search Changed Event

An Adaptable Event which is fired whenever the Search, Filtering or Sorting state in AdapTable changes.

It is primarily used for Server Searching and Filtering where these activities take place on the server, rather than the (default) client.

SearchChangedInfo

The SearchChangedInfo object includes full and comprehensive details of the state of all the search and filter related functions in Adaptable.

It also includes a SearchChangedTrigger which describes which Module in AdapTable was responsible for the change in Search state.

PropertyDescription
adaptableSearchStateCurrent searches and filters in the Grid
adaptableSortStateCurrent sort state in the Grid
searchChangedTriggerWhat action caused event to fire: DataSource, CurrentQuery, Filter, DataChange or Sort

AdaptableSearchState

PropertyDescription
columnFiltersCurrently applied Column Filters
currentQueryCurrent Query
dataSourceCurrent Data Source (if one selected)
queryASTAST for Current Query

AdaptableSortState

PropertyDescription
columnSortsWhich columns have sorting applied and,if so, which direction
customSortsAll the Custom Sorts in State; this is always sent even if no custom sorts are active

Event Subscription

Subscribing to the Event is done the same as with all Adaptable Events:

api.eventApi.on('SearchChanged', (eventInfo: SearchChangedInfo) => {
// do something with the info
});

More Information