Search
    Preparing search index...

    Interface SearchStoreType<P, C, SR>

    interface SearchStoreType<
        P extends Universe.Platform.Search.SearchPanelStoreType,
        C extends IAbstractSearchColumnStore,
        SR extends SearchResultStoreType = SearchResultStoreType,
    > {
        isDataLoadedInner: boolean;
        isQueryInvalid: boolean;
        queryInvalidType?: INVALID_QUERY_TYPE;
        routerStore: RouterStoreType;
        savedSearchStore: SavedSearchStore<JsonData>;
        searchPanel: P;
        searchResult: SR;
        get columns(): ISearchColumn[];
        get columnsStore(): undefined | C;
        get displayName(): string;
        get isDataLoaded(): boolean;
        get isLoading(): boolean;
        get isSilent(): boolean;
        get namespaceId(): keyof INamespace;
        get savedSearchId(): string;
        get searchHits(): SearchHit[];
        get searchNamespaceId(): SearchNamespaceId;
        get tableColumns(): (
            | TableColumnWithoutData<SearchHit, undefined>
            | (
                TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
            )
        )[];
        get totalRecords(): number;
        get typeName(): string;
        changeShow(column: ISearchColumn, checked: boolean): void;
        changeShowAll(checked: boolean): void;
        clearSearch(): void;
        clearSearchEntityKey(): void;
        doSearch(): Promise<void>;
        doSearch(
            namespaceId: SearchNamespaceId,
            typeName: string,
            displayName: string,
        ): Promise<void>;
        doSearch(
            namespaceId?: SearchNamespaceId,
            typeName?: string,
            displayName?: string,
        ): any;
        getSavedSearchItems(
            isSystem?: boolean,
        ): Map<string, ILastSearchItem<JsonData>[]>;
        searchData(): any;
        setIsQueryInvalid(isInvalid: boolean, type?: INVALID_QUERY_TYPE): void;
        toggleAdvancedMode(advanced: boolean): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    isDataLoadedInner isQueryInvalid queryInvalidType? routerStore savedSearchStore searchPanel searchResult

    Accessors

    columns columnsStore displayName isDataLoaded isLoading isSilent namespaceId savedSearchId searchHits searchNamespaceId tableColumns totalRecords typeName

    Methods

    changeShow changeShowAll clearSearch clearSearchEntityKey doSearch getSavedSearchItems searchData setIsQueryInvalid toggleAdvancedMode

    Properties

    isDataLoadedInner: boolean

    Флаг, отображающий загружены ли данные

    isQueryInvalid: boolean

    Флаг, отображающий есть ли ошибки в запросе

    queryInvalidType?: INVALID_QUERY_TYPE

    Тип текущего невалидного поиска

    routerStore: RouterStoreType

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

    savedSearchStore: SavedSearchStore<JsonData>

    Хранилище сохраненного поиска

    searchPanel: P

    Поисковая панель

    searchResult: SR

    Поисковый результат

    Accessors

    • get columns(): ISearchColumn[]

      Геттер получения колонок

      Returns ISearchColumn[]

    • get columnsStore(): undefined | C

      Геттер получения хранилища колонок

      Returns undefined | C

    • get displayName(): string

      Геттер получения отображаемого имени текущей сущности

      Returns string

    • get isDataLoaded(): boolean

      Геттер получения флага isDataLoaded

      Returns boolean

    • get isLoading(): boolean

      Геттер получения флага isLoading

      Returns boolean

    • get isSilent(): boolean

      Геттер получения флага isSilent, с помощью которого критерии поиска добавляются к url, если он равен false

      Returns boolean

    • get namespaceId(): keyof INamespace

      Returns keyof INamespace

      Необходимо использовать searchNamespaceId Для проверки принадлежности неймспейса к системным необходимо использовать SearchNamespaceManager.isSystemNamespace

      @universe-platform/search 2.0.0

      @universe-ee/sdk 6.16.0

      @universe-dg/sdk 2.16.0

      Геттер получения пространства имен текущей сущности

    • get savedSearchId(): string

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

      Returns string

    • get searchHits(): SearchHit[]

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

      Returns SearchHit[]

    • get searchNamespaceId(): SearchNamespaceId

      Геттер получения пространства имен текущей сущности

      Returns SearchNamespaceId

    • get tableColumns(): (
          | TableColumnWithoutData<SearchHit, undefined>
          | (
              TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
          )
      )[]

      Геттер получения колонки таблицы

      Returns (
          | TableColumnWithoutData<SearchHit, undefined>
          | (
              TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
          )
      )[]

    • get totalRecords(): number

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

      Returns number

    • get typeName(): string

      Геттер получения имени текущей сущности

      Returns string

    Methods

    • Метод, изменяющий отображение колонки

      Parameters

      • column: ISearchColumn

        колонка для выбора

      • checked: boolean

        флаг, выбрана ли колонка

      Returns void

    • Метод, изменяющий отображение всех колонок

      Parameters

      • checked: boolean

        флаг, выбраны ли все колонки

      Returns void

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

      Returns void

    • Метод очистки текущей сущности

      Returns void

    • Returns Promise<void>

    • Parameters

      • namespaceId: SearchNamespaceId
      • typeName: string
      • displayName: string

      Returns Promise<void>

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

      Parameters

      • OptionalnamespaceId: SearchNamespaceId

        пространство имен

      • OptionaltypeName: string

        имя мета-сущности

      • OptionaldisplayName: string

        отображаемое имя сущности

      Returns any

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

      Parameters

      • OptionalisSystem: boolean

        флаг, показывающий системный поиск или нет

      Returns Map<string, ILastSearchItem<JsonData>[]>

    • Метод поиска данных

      Returns any

    • Метод установки флага isQueryInvalid

      Parameters

      • isInvalid: boolean

        флаг показывающий, есть ли ошибки в поисковом запросе

      • Optionaltype: INVALID_QUERY_TYPE

        тип текущего невалидного поиска

      Returns void

    • Метод, переключающий расширенный режим

      Parameters

      • advanced: boolean

        флаг, расширенный режим или нет

      Returns void

    On This Page

    Properties
    Accessors
    Methods