AdapTable Quick Search

View as Markdown

Summary

  • Quick Search finds and highlights matching text across visible cells in the Grid
  • It searches cell display values by default (not numeric filters or AdapTableQL)
  • Matching text uses configurable Matching Styles; optionally you can filter rows to matching results only
  • Search inputs appear on the Dashboard, Status Bar, Tool Panel, and elsewhere

AdapTable provides a cross-grid text search called Quick Search.

AdapTable finds and highlights all instances of the search text in:

  • All AG Grid data / field columns
  • Dynamic columns (e.g. row grouped or tree view columns)
  • AdapTable special columns (e.g. Calculated and FreeText columns)
  • Leaf (data) rows
  • Grouped rows (i.e. rows that contain aggregations)

Hint

  • For row-level filtering with expressions, use Grid Filter or Column Filters instead
  • They hide non-matching rows, not just highlight cells

Unlike those filters, Quick Search is purely text-based and runs on each cell's display value.

For example, a cell with a display value of £1,500 will not match a search for 1500 (but £1 will match).

Caution

  • Cells using an AG Grid cell component are searched using the raw value
  • This is because the cell may be showing an image or custom renderer output
Deep Dive

How Quick Search Works in AdapTable

Quick Search
Fork
  • Initial State runs Quick Search for Java — cells whose display text contains that substring are highlighted (e.g. JavaScript in the language column)
  • The Dashboard header and Status Bar both include a Quick Search input; change the text to try other terms
Loading demo…

Note

  • Quick Search re-runs when the search text changes, when grid data is edited, or when column visibility changes
  • The active search text is stored as QuickSearchText in Quick Search Initial State

Topics in this Section

Matching Styles

  • Highlight matching text vs whole cells
  • Current match when cycling results
  • Design-time and run-time styling

Filter Search Results

  • Optional row filter after search
  • AG Grid Quick Filter behaviour
  • Performance and caveats

Configuring Quick Search

  • Raw value and bespoke search text
  • Exclude columns or cells
  • Case sensitivity, placeholder, persistence
  • Floating Quick Search

Technical Reference

  • Quick Search Options
  • Quick Search Initial State
  • Quick Search API

Quick Search inputs

Quick Search is available in several places so users can search without opening a module popup:

LocationNotes
Dashboard HeaderShown by default in Expanded, Collapsed, and Floating modes
Hide with showQuickSearchInHeader: false in Dashboard Options
Settings PanelRun search and configure matching styles (Filter Quick Search Results if enabled)
Dashboard ToolbarRarely used because the header already contains an input
Tool PanelQuick Search Module Tool Panel
Status BarOptional QuickSearch status bar panel

Hint

Cycling through matches

Users can move between matches using the up / down controls on Quick Search inputs.

Note

This is also available programmatically via gotoNextMatch / gotoPreviousMatch on the Quick Search API

The current match uses CurrentTextMatchStyle.

Caution

Matching cell styles

When Quick Search runs, matching cells are styled so results stand out.

Three styles are stored in Quick Search State (each an Adaptable Style):

  • CellMatchStyle — styles all text in matching cells (optional until enabled in the UI)
  • TextMatchStyle — styles matching substring within the cell
  • CurrentTextMatchStyle — styles the current match when cycling through results

Find Out More

See Quick Search Matching Styles for defaults, theme variables, design-time State, and Settings Panel tabs.

Configuration options

All Quick Search options live on quickSearchOptions in Adaptable Options:

OptionPurpose
getCellSearchTextText to search per cell (raw value, bespoke matching, comma-separated terms, etc.)
isCellSearchableExclude specific columns or cells from search
isQuickSearchCaseSensitiveMatch search text with exact casing
quickSearchPlaceholderPlaceholder string for Quick Search inputs
clearQuickSearchOnStartUpDo not restore saved QuickSearchText on load
filterGridAfterQuickSearchAlso hide rows with no matches (AG Grid Quick Filter)

Find Out More

See Configuring Quick Search and Filtering Quick Search Results for further details and demo examples

Filter Search Results

By default Quick Search highlights matches only; all rows remain visible.

Set filterGridAfterQuickSearch to true (or enable 'Filter Quick Search Results' in the Settings Panel) to show only rows that contain the search text in at least one visible, searchable column.

This uses AG Grid's Quick Filter — register AG Grid's QuickFilterModule when using this option.

Caution

  • Quick Search as Filter does not use AdapTableQL; it ignores getCellSearchText / isCellSearchable exclusions
  • Prefer Column Filters or Grid Filter for large grids or expression-based filtering

Find Out More

See Filtering Quick Search Results for performance notes, SSRM behaviour, and customising quickFilterParser.

Server-Side Row Model

Quick Search works fully when using the Server-Side Row Model.

However, AdapTable uses its own search implementation instead of AG Grid Find.

  • Highlights apply to rows as they load; newly fetched rows are searched when they appear.
  • Only CellMatchStyle applies (whole-cell highlight).
  • Cycling through matches is not supported.

Find Out More

See Server-Side Row Model - Searching for a demo and implementation notes.

UI Entitlements

UI Entitlements for the Quick Search module:

  • Full — Quick Search runs normally and all Quick Search UI controls are available.
  • Hidden and ReadOnly — module UI (Settings Panel, Toolbar, Tool Panel, Status Bar) is not available.

Caution

  • The Dashboard header Quick Search input can still appear when the module is ReadOnly
  • Set showQuickSearchInHeader to false in Dashboard Options to hide it

Quick Search API

Quick Search can be driven programmatically via the Quick Search API:

  • run or clear search — runQuickSearch, clearQuickSearch
  • read current text — getQuickSearchValue
  • cycle matches (client-side Find) — gotoNextMatch, gotoPreviousMatch
  • matching styles — get/set style properties
  • floating search — showFloatingQuickSearch, hideFloatingQuickSearch
  • Settings Panel — openQuickSearchSettingsPanel

FAQ

Does Quick Search update when data changes? Yes. Like Grid Filter and Column Filters, an active Quick Search is reapplied when data changes.

Does Quick Search run on grouped rows? Yes. Quick Search evaluates grouped rows (including aggregations) as well as leaf data rows.

Can users type expressions (e.g. > 50) in Quick Search? No. Quick Search is substring text search on display (or configured) cell text. Use Column Filters or Grid Filter for structured filtering.

Which AG Grid modules does Quick Search need? Client-side highlighting requires AG Grid FindModule. If you enable filterGridAfterQuickSearch, also register QuickFilterModule (see AG Grid Modules).