Search
    Preparing search index...

    Interface SearchPanelStoreType<ST, T>

    interface SearchPanelStoreType<
        ST extends AbstractSearchTerm = AbstractSearchTerm,
        T extends JsonData = JsonData,
    > {
        advancedSearchKey: undefined | (keyof ISearchPayload);
        advancedSearchMode: boolean;
        handleClear?: () => void;
        keyword: string;
        MAX_LOGIC_TERM_COUNT: number;
        MAX_LOGIC_TERM_DEEP: number;
        routerStore: RouterStoreType;
        searchTerms: IObservableArray<ST>;
        get hasAdvancedSearch(): boolean;
        get hasTermErrors(): boolean;
        get listST(): ST[];
        get listSTJson(): JsonData[];
        get rootAdvancedST(): undefined | LogicGroupST<ST>;
        addTerm(term: ST | T, key: keyof ISearchPayload): void;
        clearSearch(): void;
        deleteTerm(term: ST, key: keyof ISearchPayload): void;
        findSearchTerm(key: string): any;
        getAllTermsCount(): number;
        getQuery(
            params?: SearchPanelGetQueryParams,
        ): Promise<Partial<ISearchPayload>>;
        registerQuery(
            key: keyof ISearchPayload,
            searchQuery: SearchQuery<any>,
        ): void;
        setAdvancedSearchMode(advanced: boolean): void;
        setKeyword(keyword: string): void;
        unregisterQuery(key: keyof ISearchPayload): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    advancedSearchKey advancedSearchMode handleClear? keyword MAX_LOGIC_TERM_COUNT MAX_LOGIC_TERM_DEEP routerStore searchTerms

    Accessors

    hasAdvancedSearch hasTermErrors listST listSTJson rootAdvancedST

    Methods

    addTerm clearSearch deleteTerm findSearchTerm getAllTermsCount getQuery registerQuery setAdvancedSearchMode setKeyword unregisterQuery

    Properties

    advancedSearchKey: undefined | (keyof ISearchPayload)

    Ключ расширенного поиска Чтобы его активировать необходимо переопределить этот параметр в дочернем классе

    advancedSearchMode: boolean

    Флаг определяющий включен ли расширенный поиск

    handleClear?: () => void

    Метод обработки очистки критериев

    keyword: string

    Ключевое слово поискового критерия

    MAX_LOGIC_TERM_COUNT: number

    Максимальное количество критериев

    MAX_LOGIC_TERM_DEEP: number

    Максимальная глубина логических критериев

    routerStore: RouterStoreType

    Стор маршрутизации

    searchTerms: IObservableArray<ST>

    Поисковые критерии

    Accessors

    • get hasAdvancedSearch(): boolean

      Геттер для проверки активен ли расширенный поиск

      Returns boolean

    • get hasTermErrors(): boolean

      Геттер проверки на ошибки поисковых критериев

      Returns boolean

    • get listST(): ST[]

      Геттер получения всех поисковых критериев

      Returns ST[]

    • get listSTJson(): JsonData[]

      Геттер получения json-данных

      Returns JsonData[]

    • get rootAdvancedST(): undefined | LogicGroupST<ST>

      Геттер получения корневого расширенного критерия

      Returns undefined | LogicGroupST<ST>

    Methods

    • Метод добавления поискового критерия

      Parameters

      • term: ST | T

        поисковый критерий

      • key: keyof ISearchPayload

        ключ поискового критерия

      Returns void

    • Метод очистки поиска

      Returns void

    • Метод удаления поискового критерия

      Parameters

      • term: ST

        поисковый критерий

      • key: keyof ISearchPayload

        ключ поискового критерия

      Returns void

    • Метод поиска поискового критерия по ключу

      Parameters

      • key: string

        ключ поискового критерия

      Returns any

    • Метод получения количества всех поисковых критериев

      Returns number

    • Метод получения запроса для поиска

      Parameters

      • Optionalparams: SearchPanelGetQueryParams

        параметры, которые необходимо передать в поисковый запрос

      Returns Promise<Partial<ISearchPayload>>

    • Метод регистрации поискового запроса

      Parameters

      • key: keyof ISearchPayload

        ключ поискового запроса

      • searchQuery: SearchQuery<any>

        поисковый запрос

      Returns void

    • Метод задания параметра advancedSearchMode

      Parameters

      • advanced: boolean

        флаг, расширенный поиск или нет

      Returns void

    • Метод задания ключевого слова

      Parameters

      • keyword: string

        ключевое слово

      Returns void

    • Метод удаления поискового запроса

      Parameters

      • key: keyof ISearchPayload

        ключ поискового запроса

      Returns void

    On This Page

    Properties
    Accessors
    Methods