QuickSearchApi

Provides run-time access to Quick Search Module

export interface

Methods

Method Details

clearQuickSearch

Clears Quick Search

clearQuickSearch(): void;

Returns

void

getQuickSearchCellMatchStyle

Retrieves whole-cell style for matching Quick Search cells (undefined when unset on client-side)

getQuickSearchCellMatchStyle(): AdaptableStyle | undefined;

Returns

AdaptableStyle | undefined

getQuickSearchCurrentTextMatchStyle

Retrieves the style for the active Quick Search match (includes run-time default when unset)

getQuickSearchCurrentTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'>;

Returns

Omit<AdaptableStyle, 'ClassName'>

getQuickSearchState

Retrieves Quick Search section from Adaptable State

getQuickSearchState(): QuickSearchState;

Returns

QuickSearchState

getQuickSearchTextMatchStyle

Retrieves the style for matched text within Quick Search results (includes run-time default when unset)

getQuickSearchTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'>;

Returns

Omit<AdaptableStyle, 'ClassName'>

getQuickSearchValue

Retrieves current Quick Search text

getQuickSearchValue(): string;

Returns

string

gotoNextMatch

Goes to the next match for the current Quick Search text

gotoNextMatch(): void;

Returns

void

gotoPreviousMatch

Goes to the previous match for the current Quick Search text

gotoPreviousMatch(): void;

Returns

void

hideFloatingQuickSearch

Hides the floating Quick Search

hideFloatingQuickSearch(): void;

Returns

void

openQuickSearchSettingsPanel

Opens Settings Panel with Quick Search section selected and visible

openQuickSearchSettingsPanel(): void;

Returns

void

runQuickSearch

Runs Quick Search using supplied text

runQuickSearch(quickSearchText: string): void;

Parameters

Returns

void

setQuickSearchCellMatchStyle

Sets whole-cell style for Quick Search (SSRM / legacy). Prefer setQuickSearchTextMatchStyle for client-side row models using AG Grid Find.

setQuickSearchCellMatchStyle(style: AdaptableStyle): void;

Parameters

Returns

void

setQuickSearchCurrentTextMatchStyle

Sets style for the active Quick Search match when cycling results (AG Grid Find)

setQuickSearchCurrentTextMatchStyle(style: AdaptableStyle): void;

Parameters

Returns

void

setQuickSearchTextMatchStyle

Sets style for matched text within Quick Search results (AG Grid Find)

setQuickSearchTextMatchStyle(style: AdaptableStyle): void;

Parameters

Returns

void

showFloatingQuickSearch

Opens the Floating Quick Search

showFloatingQuickSearch(): void;

Returns

void