QuickSearchApi
Provides run-time access to Quick Search Module
export interfaceMethods
| 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 |
Method Details
clearQuickSearch
Clears Quick Search
clearQuickSearch(): void;Returns
void
getQuickSearchCellMatchStyle
Retrieves current Quick Search style
getQuickSearchCellMatchStyle(): AdaptableStyle;Returns
getQuickSearchCurrentTextMatchStyle
Retrieves the style for the current text match in the Quick Search
getQuickSearchCurrentTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'> | undefined;Returns
Omit<AdaptableStyle, 'ClassName'> | undefined
getQuickSearchState
Retrieves Quick Search section from Adaptable State
getQuickSearchState(): QuickSearchState;Returns
getQuickSearchTextMatchStyle
Retrieves the style for the text match in the Quick Search
getQuickSearchTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'> | undefined;Returns
Omit<AdaptableStyle, 'ClassName'> | undefined
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
| Parameter | Type | Description |
|---|---|---|
| quickSearchText | string | text to run QuickSearch on |
Returns
void
setQuickSearchCellMatchStyle
Sets style for Quick Search; can be name of (a provided) css style
setQuickSearchCellMatchStyle(style: AdaptableStyle): void;Parameters
| Parameter | Type | Description |
|---|---|---|
| style | AdaptableStyle | the style to use |
Returns
void
showFloatingQuickSearch
Opens the Floating Quick Search
showFloatingQuickSearch(): void;Returns
void