QuickSearchApi

Provides run-time access to Quick Search Module

TypeScript
export interface QuickSearchApi

Methods

MethodDescription
clearQuickSearch()Clears Quick Search
getQuickSearchState()Retrieves Quick Search section from Adaptable State
getQuickSearchStyle()Retrieves current Quick Search style
getQuickSearchValue()Retrieves current Quick Search text
runQuickSearch(quickSearchText)Runs Quick Search using supplied text
setQuickSearchStyle(style)Sets style for Quick Search; can be name of (a provided) css style
showQuickSearchPopup()Opens Quick Search popup screen

Method Details

clearQuickSearch

Clears Quick Search

TypeScript
clearQuickSearch(): void;
Returns

void

getQuickSearchState

Retrieves Quick Search section from Adaptable State

TypeScript
getQuickSearchState(): QuickSearchState;
Returns

QuickSearchState

getQuickSearchStyle

Retrieves current Quick Search style

TypeScript
getQuickSearchStyle(): AdaptableStyle;
Returns

AdaptableStyle

getQuickSearchValue

Retrieves current Quick Search text

TypeScript
getQuickSearchValue(): string;
Returns

string

runQuickSearch

Runs Quick Search using supplied text

TypeScript
runQuickSearch(quickSearchText: string): void;
Parameters
ParameterTypeDescription
quickSearchTextstringtext to run QuickSearch on
Returns

void

setQuickSearchStyle

Sets style for Quick Search; can be name of (a provided) css style

TypeScript
setQuickSearchStyle(style: AdaptableStyle): void;
Parameters
ParameterTypeDescription
styleAdaptableStylethe style to use
Returns

void

showQuickSearchPopup

Opens Quick Search popup screen

TypeScript
showQuickSearchPopup(): void;
Returns

void