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

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

Readonlyalias

alias: string

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

Readonlyappearance

appearance: null | string

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

Readonlyappearances

appearances: readonly IViewAppearanceMetadata[]

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

ReadonlyautoSelectFirstRow

autoSelectFirstRow: boolean

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

Readonlycaption

caption: string

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

ReadonlycollapseGroups

collapseGroups: boolean

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

Readonlycolumns

columns: readonly IViewColumnMetadata[]

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

ReadonlydefaultSortColumns

defaultSortColumns: readonly ISortColumn[]

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

ReadonlyenableAutoWidth

enableAutoWidth: boolean

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

ReadonlyexpandingIconName

expandingIconName: string

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

ReadonlyexportDataPageLimit

exportDataPageLimit: number

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

Readonlyextensions

extensions: readonly IViewExtensionMetadata[]

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

ReadonlyiconName

iconName: string

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

Readonlyid

id: null | string

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

Readonlyinitialized

initialized: boolean

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

ReadonlymultiSelect

multiSelect: boolean

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

ReadonlypageLimit

pageLimit: number

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

Readonlypaging

paging: Paging

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

Readonlyparameters

parameters: readonly IViewParameterMetadata[]

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

ReadonlyparametersValues

parametersValues: readonly ViewRequestParameter[]

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

Readonlyreferences

references: readonly IViewReferenceMetadata[]

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

ReadonlyrowCounterVisible

rowCounterVisible: boolean

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

ReadonlyrowCountSubset

rowCountSubset: null | string

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

ReadonlyselectionMode

selectionMode: ViewSelectionMode

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

ReadonlysourceType

sourceType: MetadataDataSourceTypes

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

Readonlysubsets

subsets: readonly IViewSubsetMetadata[]

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

ReadonlytypeName

typeName: string

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

ReadonlyvalidationResult

validationResult: ValidationResult

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

Methods

clone

deserializeFromStorage

getViewMetadata

  • getViewMetadata(): null | IViewMetadata

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

    Returns null | IViewMetadata

isSealed

  • isSealed(): boolean

    Returns boolean

isSpecialSubset

  • isSpecialSubset(alias: string): boolean

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

    Parameters

    • alias: string

    Returns boolean

seal

  • seal(): this

    Returns this

serializeToStorage

Settings

Member Visibility

On This Page

Properties
Methods