@adaptabletools/adaptable/src/Api/QuickSearchApi.d.ts

Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { AdaptableStyle } from '../AdaptableState/Common/AdaptableStyle';
import { QuickSearchState } from '../AdaptableState/QuickSearchState';
/**
 * Provides run-time access to Quick Search Module
 */
export interface QuickSearchApi {
    /**
     * Retrieves Quick Search section from Adaptable State
     */
    getQuickSearchState(): QuickSearchState;
    /**
     * Runs Quick Search using supplied text
     * @param quickSearchText text to run QuickSearch on
     */
    runQuickSearch(quickSearchText: string): void;
    /**
     * Clears Quick Search
     */
    clearQuickSearch(): void;
    /**
     * Goes to the next match for the current Quick Search text
     */
    gotoNextMatch(): void;
    /**
     * Goes to the previous match for the current Quick Search text
     */
    gotoPreviousMatch(): void;
    /**
     * Retrieves current Quick Search text
     */
    getQuickSearchValue(): string;
    /**
     * Retrieves whole-cell style for matching Quick Search cells (undefined when unset on client-side)
     */
    getQuickSearchCellMatchStyle(): AdaptableStyle | undefined;
    /**
     * Retrieves the style for matched text within Quick Search results (includes run-time default when unset)
     */
    getQuickSearchTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'>;
    /**
     * Retrieves the style for the active Quick Search match (includes run-time default when unset)
     */
    getQuickSearchCurrentTextMatchStyle(): Omit<AdaptableStyle, 'ClassName'>;
    /**
     * Sets style for matched text within Quick Search results (AG Grid Find)
     * @param style the style to use
     */
    setQuickSearchTextMatchStyle(style: AdaptableStyle): void;
    /**
     * Sets style for the active Quick Search match when cycling results (AG Grid Find)
     * @param style the style to use
     */
    setQuickSearchCurrentTextMatchStyle(style: AdaptableStyle): void;
    /**
     * Sets whole-cell style for Quick Search (SSRM / legacy). Prefer `setQuickSearchTextMatchStyle`
     * for client-side row models using AG Grid Find.
     * @param style the style to use
     */
    setQuickSearchCellMatchStyle(style: AdaptableStyle): void;
    /**
     * Opens Settings Panel with Quick Search section selected and visible
     */
    openQuickSearchSettingsPanel(): void;
    /**
     * Opens the Floating Quick Search
     */
    showFloatingQuickSearch(): void;
    /**
     * Hides the floating Quick Search
     */
    hideFloatingQuickSearch(): void;
}