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

Интерфейс UESearchQueryToTermMapFunc

Точка расширения позволяющая при открытии сохранённого поиска восстанавливать ранее введённые поисковые критерии

interface UESearchQueryToTermMapFunc {
    active: boolean;
    fn: (
        store: CommonSearchStoreFacade,
        query: Query,
        mainKey: keyof ISearchPayload,
        aggregations: Aggregation[],
        queryMeta: SearchQueryMeta,
    ) => Promise<ResultTerms | undefined> | undefined;
    meta: {};
    moduleId: string;
    resolver: UESearchQueryToTermResolver;
    system: boolean;
}

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

Индекс

Свойства

active fn meta moduleId resolver system

Свойства

active: boolean

Является ли экземпляр точки расширения активным

fn: (
    store: CommonSearchStoreFacade,
    query: Query,
    mainKey: keyof ISearchPayload,
    aggregations: Aggregation[],
    queryMeta: SearchQueryMeta,
) => Promise<ResultTerms | undefined> | undefined

Функция, которая по поисковому запросу Query асинхронно вернёт результат в формате ResultTerms с поисковывми термами, если они должны быть восстановлены для для данного поискового запроса.

Объявление типа

    • (
          store: CommonSearchStoreFacade,
          query: Query,
          mainKey: keyof ISearchPayload,
          aggregations: Aggregation[],
          queryMeta: SearchQueryMeta,
      ): Promise<ResultTerms | undefined> | undefined

    • Параметры

      • store: CommonSearchStoreFacade

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

      • query: Query

        пвосстанавливаемый поисковый запрос

      • mainKey: keyof ISearchPayload

        ключ главного поисковго фрагмента в запросе

      • aggregations: Aggregation[]

        вычесленная агрегация если она запрашивалась внутри поискового стора (используется для бизнес поиска)

      • queryMeta: SearchQueryMeta

        Дополнительная мета-информация для сохраненного запроса, необходимая для восстановления его состояния

      Возвращает Promise<ResultTerms | undefined> | undefined

      Promise с поисковыми термами которые должны быть воостановлены

meta: {}

Мета-информация точки расширения

moduleId: string

Уникальный идентификатор экземпляра точки расширения

resolver: UESearchQueryToTermResolver

Функция указывает, следует ли применять данный экземпляр точки расширения

system: boolean

Является ли системным экземпляром

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

Настройки

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

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

Свойства