TESSA Web API
    Preparing search index...

    Interface IWorkplaceDataSourceMetadata

    Метаданные объекта, предоставляющего доступ к метаданным источника данных.

    interface IWorkplaceDataSourceMetadata {
        alias: string;
        appearance: null | string;
        appearances: readonly IViewAppearanceMetadata[];
        autoSelectFirstRow: boolean;
        caption: string;
        collapseGroups: boolean;
        columns: readonly IViewColumnMetadata[];
        defaultSortColumns: readonly ISortColumn[];
        enableAutoWidth: boolean;
        expandingIconName: string;
        exportDataPageLimit: number;
        extensions: readonly IViewExtensionMetadata[];
        iconName: string;
        id: null | string;
        initialized: boolean;
        multiSelect: boolean;
        pageLimit: number;
        paging: Paging;
        parameters: readonly IViewParameterMetadata[];
        parametersValues: readonly ViewRequestParameter[];
        references: readonly IViewReferenceMetadata[];
        rowCounterVisible: boolean;
        rowCountSubset: null | string;
        selectionMode: ViewSelectionMode;
        sourceType: MetadataDataSourceTypes;
        subsets: readonly IViewSubsetMetadata[];
        typeName: string;
        validationResult: ValidationResult;
        clone(): IWorkplaceDataSourceMetadata;
        deserializeFromStorage(
            storage: IStorage,
            context?: StorageSerializableContext,
        ): this;
        getViewMetadata(): null | IViewMetadata;
        isSealed(): boolean;
        isSpecialSubset(alias: string): boolean;
        seal(): this;
        serializeToStorage(
            storage?: IStorage,
            context?: StorageSerializableContext,
        ): IStorage;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    alias appearance appearances autoSelectFirstRow caption collapseGroups columns defaultSortColumns enableAutoWidth expandingIconName exportDataPageLimit extensions iconName id initialized multiSelect pageLimit paging parameters parametersValues references rowCounterVisible rowCountSubset selectionMode sourceType subsets typeName validationResult

    Methods

    clone deserializeFromStorage getViewMetadata isSealed isSpecialSubset seal serializeToStorage

    Properties

    alias: string

    Псевдоним элемента.

    appearance: null | string

    Псевдоним внешнего вида строки представления.

    appearances: readonly IViewAppearanceMetadata[]

    Настройки внешнего вида представления.

    autoSelectFirstRow: boolean

    Признак того, что при открытии представления должна быть автоматически выделена первая строка.

    caption: string

    Заголовок элемента.

    collapseGroups: boolean

    Признак того, что при открытии представления группировки должны быть свёрнуты.

    columns: readonly IViewColumnMetadata[]

    Список метаданных столбцов.

    defaultSortColumns: readonly ISortColumn[]

    Список колонок, по которым происходит сортировка по умолчанию.

    enableAutoWidth: boolean

    Признак автоматического расчета ширины столбцов представления.

    expandingIconName: string

    Имя значка в развернутом состоянии.

    exportDataPageLimit: number

    Количество строк запрашиваемых в режиме пагинации при выгрузке данных.

    extensions: readonly IViewExtensionMetadata[]

    Список имен типов расширений.

    iconName: string

    Имя значка в свернутом состоянии.

    id: null | string

    Идентификатор.

    initialized: boolean

    Источник данных был успешно инициализирован.

    multiSelect: boolean

    Признак возможности множественного выбора строк в представлении.

    pageLimit: number

    Количество строк возвращаемых в режиме пейджинга.

    paging: Paging

    Поддержка постраничного вывода.

    parameters: readonly IViewParameterMetadata[]

    Список метаданных параметров доступных в компоненте.

    parametersValues: readonly ViewRequestParameter[]

    Список значений параметров заданных в метаданных источника данных.

    references: readonly IViewReferenceMetadata[]

    Список ссылок представления.

    rowCounterVisible: boolean

    Признак необходимости расчета и отображения количества строк.

    rowCountSubset: null | string

    Алиас подмножества используемого для расчета количество строк.

    selectionMode: ViewSelectionMode

    Режим выделения элементов представления.

    sourceType: MetadataDataSourceTypes

    Тип источника данных.

    subsets: readonly IViewSubsetMetadata[]

    Список подмножеств.

    typeName: string

    Имя типа на серверной стороне.

    validationResult: ValidationResult

    Результат валидации.

    Methods

    • Возвращает адаптируемые метаданные.

      Returns null | IViewMetadata

    • Returns boolean

    • Осуществляет проверку является ли подмножество системным.

      Parameters

      • alias: string

      Returns boolean

    • Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods