Quick Search Technical Reference
Summary
- Quick Search Initial Adaptable State can set search text and a Highlight Style
- Quick Search Options contains properties to configure Search behaviour
- Quick Search API provides programmatic access to Quick Search
Quick Search Options
The QuickSearchOptions section of Adaptable Options contains these properties:
| Property | Description | Default |
|---|---|---|
| clearQuickSearchOnStartUp | Clears saved searches when AdapTable loads | false |
| filterGridAfterQuickSearch | Filters Grid after quick search so only matching rows are displayed | false |
| getCellSearchText | Allows a different value to be used for a cell when searching (instead of its raw value) | |
| isCellSearchable | Determines whether Quick Search should be applied to a given cell | |
| isQuickSearchCaseSensitive | Run Quick Search using Case Sensitivity | false |
| quickSearchPlaceholder | Value to use as placeholder in QuickSearch controls (e.g. in Dashboard) | 'Search' |
Find Out More
See Configuring Search for further details and examples
Quick Search Initial Adaptable State
The Quick Search section of Adaptable State contains these properties:
| Property | Description |
|---|---|
| CellMatchStyle | Style used to highlight matching cells |
| CurrentTextMatchStyle | Style used to highlight matching text within current match (not availale in SSRM) |
| QuickSearchText | Last Quick Search that was run (and will be applied at start-up) |
| TextMatchStyle | Style used to highlight matching text within a cell (not availale in SSRM) |
Quick Search API
The Quick Search section of Adaptable API contains functions for applying and managing Quick Searches:
| Method | Description |
|---|---|
| clearQuickSearch() | Clears Quick Search |
| getQuickSearchCellMatchStyle() | Retrieves current Quick Search style |
| getQuickSearchCurrentTextMatchStyle() | Retrieves the style for the current text match in the Quick Search |
| getQuickSearchState() | Retrieves Quick Search section from Adaptable State |
| getQuickSearchTextMatchStyle() | Retrieves the style for the text match in the Quick Search |
| getQuickSearchValue() | Retrieves current Quick Search text |
| gotoNextMatch() | Goes to the next match for the current Quick Search text |
| gotoPreviousMatch() | Goes to the previous match for the current Quick Search text |
| hideFloatingQuickSearch() | Hides the floating Quick Search |
| openQuickSearchSettingsPanel() | Opens Settings Panel with Quick Search section selected and visible |
| runQuickSearch(quickSearchText) | Runs Quick Search using supplied text |
| setQuickSearchCellMatchStyle(style) | Sets style for Quick Search; can be name of (a provided) css style |
| showFloatingQuickSearch() | Opens the Floating Quick Search |