Юниверс DG SDK UI
v2.15.0

Интерфейс SearchPanelStoreType<ST, T>

interface SearchPanelStoreType<
    ST extends AbstractSearchTerm = AbstractSearchTerm,
    T extends JsonData = JsonData,
> {
    advancedSearchKey: (keyof ISearchPayload) | undefined;
    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(): LogicGroupST<ST> | undefined;
    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;
}

Параметры типа

Иерархия (Просмотр сводки)

Реализован в

Индекс

Свойства

advancedSearchKey advancedSearchMode handleClear? keyword MAX_LOGIC_TERM_COUNT MAX_LOGIC_TERM_DEEP routerStore searchTerms

Акцессоры

hasAdvancedSearch hasTermErrors listST listSTJson rootAdvancedST

Методы

addTerm clearSearch deleteTerm findSearchTerm getAllTermsCount getQuery registerQuery setAdvancedSearchMode setKeyword unregisterQuery

Свойства

advancedSearchKey: (keyof ISearchPayload) | undefined

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

advancedSearchMode: boolean

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

handleClear?: () => void

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

keyword: string

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

MAX_LOGIC_TERM_COUNT: number

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

MAX_LOGIC_TERM_DEEP: number

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

routerStore: RouterStoreType

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

searchTerms: IObservableArray<ST>

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

Акцессоры

  • get hasAdvancedSearch(): boolean

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

    Возвращает boolean

  • get hasTermErrors(): boolean

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

    Возвращает boolean

  • get listST(): ST[]

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

    Возвращает ST[]

  • get listSTJson(): JsonData[]

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

    Возвращает JsonData[]

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

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

    Возвращает LogicGroupST<ST> | undefined

Методы

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

    Параметры

    • term: ST | T

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

    • key: keyof ISearchPayload

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

    Возвращает void

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

    Возвращает void

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

    Параметры

    • term: ST

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

    • key: keyof ISearchPayload

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

    Возвращает void

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

    Параметры

    • key: string

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

    Возвращает any

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

    Возвращает number

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

    Параметры

    • Optionalparams: SearchPanelGetQueryParams

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

    Возвращает Promise<Partial<ISearchPayload>>

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

    Параметры

    • key: keyof ISearchPayload

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

    • searchQuery: SearchQuery<any>

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

    Возвращает void

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

    Параметры

    • advanced: boolean

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

    Возвращает void

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

    Параметры

    • keyword: string

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

    Возвращает void

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

    Параметры

    • key: keyof ISearchPayload

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

    Возвращает void

© Авторские права 2025, Юниверс Дата.

Настройки

Видимость элементов?

На этой странице

Свойства
Акцессоры
Методы