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

Интерфейс RelatedEntitySearchStoreType

interface RelatedEntitySearchStoreType {
    hasSelectedEntity: boolean;
    innerColumnsStore: DataSearchColumnsStoreType | undefined;
    isDataLoadedInner: boolean;
    isLoadingInner: boolean;
    isQueryInvalid: boolean;
    metaStore: MetaDataStoreType;
    queryInvalidType: INVALID_QUERY_TYPE | undefined;
    routerStore: RouterStoreType;
    savedSearchStore: SavedSearchStore<JsonData>;
    searchEntityKey: SearchEntityKey;
    searchPanel: RelatedEntitySearchPanelStoreType;
    searchResult: DataSearchResultStoreType;
    viewVariant: string | undefined;
    get columns(): ISearchColumn[];
    get columnsStore(): C | undefined;
    get displayName(): string;
    get isDataLoaded(): boolean;
    get isLoading(): boolean;
    get isSilent(): boolean;
    get namespaceId(): keyof INamespace;
    get savedSearchId(): string;
    get savedSearchNamespaces(): SearchNamespaceId[];
    get searchHits(): SearchHit[];
    get searchNamespaceId(): SearchNamespaceId;
    get tableColumns(): (
        | TableColumnWithoutData<SearchHit, undefined>
        | (
            TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
        )
    )[];
    get totalRecords(): number;
    get typeName(): string;
    addSearchTerms(
        terms: JsonData[],
        defaultSearchPayloadKey: keyof ISearchPayload,
    ): void;
    changeShow(column: ISearchColumn, checked: boolean): void;
    changeShowAll(checked: boolean): void;
    checkResourceRight(item: ILastSearchItem<JsonData>): boolean;
    clearSearch(): void;
    clearSearchEntityKey(): void;
    createColumnStore(
        metaModel: IMetaModel | undefined,
    ): DataSearchColumnsStoreType | undefined;
    doSearch(
        namespaceId?: SearchNamespaceId,
        typeName?: string,
        displayName?: string,
    ): Promise<void>;
    getRowTypeName(hit: SearchHit): string;
    getSavedSearchItems(
        isSystem?: boolean,
    ): Map<string, ILastSearchItem<JsonData>[]>;
    getSystemTerms(): AbstractSearchTerm[];
    initSearchResult(
        mainResponseKey: keyof ISearchPayload,
        searchResultCtor: ClassCtor<DataSearchResultStoreType>,
        opts?: SearchStoreOpts,
    ): DataSearchResultStoreType;
    loadData(): Promise<void>;
    loadFromSelectedSearch(): void;
    loadFromState(): void;
    loadMeta(): Promise<IMetaModel | undefined>;
    registerSearchQuery(): void;
    searchData(): Promise<void>;
    setIsQueryInvalid(isInvalid: boolean, type?: INVALID_QUERY_TYPE): void;
    setLoading(isLoading: boolean): void;
    setSavedIndexByTerms(searchTerms: JsonData[], typeName: string): void;
    setSortFields(): void;
    setUrlQuery(): void;
    setViewVariant(variant: string): void;
    toggleAdvancedMode(advanced: boolean): void;
    validateSearchTerms(): Promise<void>;
}

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

Индекс

Свойства

hasSelectedEntity innerColumnsStore isDataLoadedInner isLoadingInner isQueryInvalid metaStore queryInvalidType routerStore savedSearchStore searchEntityKey searchPanel searchResult viewVariant

Акцессоры

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

Методы

addSearchTerms changeShow changeShowAll checkResourceRight clearSearch clearSearchEntityKey createColumnStore doSearch getRowTypeName getSavedSearchItems getSystemTerms initSearchResult loadData loadFromSelectedSearch loadFromState loadMeta registerSearchQuery searchData setIsQueryInvalid setLoading setSavedIndexByTerms setSortFields setUrlQuery setViewVariant toggleAdvancedMode validateSearchTerms

Свойства

hasSelectedEntity: boolean
innerColumnsStore: DataSearchColumnsStoreType | undefined
isDataLoadedInner: boolean

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

isLoadingInner: boolean
isQueryInvalid: boolean

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

metaStore: MetaDataStoreType
queryInvalidType: INVALID_QUERY_TYPE | undefined

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

routerStore: RouterStoreType

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

savedSearchStore: SavedSearchStore<JsonData>

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

searchEntityKey: SearchEntityKey
searchPanel: RelatedEntitySearchPanelStoreType

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

searchResult: DataSearchResultStoreType

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

viewVariant: string | undefined

Акцессоры

  • get columns(): ISearchColumn[]

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

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

  • get columnsStore(): C | undefined

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

    Возвращает C | undefined

  • get displayName(): string

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

    Возвращает string

  • get isDataLoaded(): boolean

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

    Возвращает boolean

  • get isLoading(): boolean

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

    Возвращает boolean

  • get isSilent(): boolean

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

    Возвращает boolean

  • get namespaceId(): keyof INamespace

    Возвращает keyof INamespace

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

  • get savedSearchId(): string

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

    Возвращает string

  • get savedSearchNamespaces(): SearchNamespaceId[]

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

  • get searchHits(): SearchHit[]

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

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

  • get searchNamespaceId(): SearchNamespaceId

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

    Возвращает SearchNamespaceId

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

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

    Возвращает (
        | TableColumnWithoutData<SearchHit, undefined>
        | (
            TableColumnWithoutData<SearchHit, ISearchColumn> & { data: ISearchColumn; }
        )
    )[]

  • get totalRecords(): number

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

    Возвращает number

  • get typeName(): string

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

    Возвращает string

Методы

  • Параметры

    • terms: JsonData[]
    • defaultSearchPayloadKey: keyof ISearchPayload

    Возвращает void

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

    Параметры

    • column: ISearchColumn

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

    • checked: boolean

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

    Возвращает void

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

    Параметры

    • checked: boolean

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

    Возвращает void

  • Параметры

    • OptionalnamespaceId: SearchNamespaceId
    • OptionaltypeName: string
    • OptionaldisplayName: string

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

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

    Параметры

    • OptionalisSystem: boolean

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

    Возвращает Map<string, ILastSearchItem<JsonData>[]>

  • Step for get meta info and fill columns from it. If your columns is static - return undefined.

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

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

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

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

    Параметры

    • isInvalid: boolean

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

    • Optionaltype: INVALID_QUERY_TYPE

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

    Возвращает void

  • Параметры

    • isLoading: boolean

    Возвращает void

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

    Параметры

    • advanced: boolean

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

    Возвращает void

  • Метод валидации поисковых критериев.

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

    Promise.resolve() в случае успешной валидации и Promise.reject() с ValidationException в случае неуспешной.

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

Настройки

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

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

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