Interface IViewMetadata

Метаданные представления.

interface IViewMetadata {
    alias: string;
    appearance: null | string;
    appearances: IDictionary<IViewAppearanceMetadata>;
    autoSelectFirstRow: boolean;
    autoWidthRowLimit: null | number;
    caption: string;
    collapseGroups: boolean;
    columns: IDictionary<IViewColumnMetadata>;
    connection: null | string;
    defaultSortColumns: ISortColumn[];
    enableAutoWidth: boolean;
    exportDataPageLimit: number;
    extensions: IDictionary<IViewExtensionMetadata>;
    formatVersion: number;
    groupingColumn: null | string;
    multiSelect: boolean;
    pageLimit: number;
    paging: Paging;
    parameters: IDictionary<IViewParameterMetadata>;
    quickSearchParam: null | string;
    references: IDictionary<IViewReferenceMetadata>;
    rowCounterVisible: boolean;
    rowCountSubset: null | string;
    selectionMode: ViewSelectionMode;
    subsets: IDictionary<IViewSubsetMetadata>;
    tagsPosition: TagsPosition;
    treatAsSingleQuery: boolean;
    treeGroup: null | string;
    treeGroupDisplayValue: null | string;
    treeGroupId: null | string;
    treeGroupParentId: null | string;
    treeId: null | string;
    treeParentId: null | string;
    validationResult: ValidationResult;
    clone(): IViewMetadata;
    deserializeFromStorage(
        storage: IStorage,
        context?: StorageSerializableContext,
    ): this;
    isSealed(): boolean;
    seal(): this;
    serializeToStorage(
        storage?: IStorage,
        context?: StorageSerializableContext,
    ): IStorage;
}

Hierarchy (View Summary)

Implemented by

Properties

alias appearance appearances autoSelectFirstRow autoWidthRowLimit caption collapseGroups columns connection defaultSortColumns enableAutoWidth exportDataPageLimit extensions formatVersion groupingColumn multiSelect pageLimit paging parameters quickSearchParam references rowCounterVisible rowCountSubset selectionMode subsets tagsPosition treatAsSingleQuery treeGroup treeGroupDisplayValue treeGroupId treeGroupParentId treeId treeParentId validationResult

Methods

clone deserializeFromStorage isSealed seal serializeToStorage

Properties

alias

alias: string

Уникальный алиас объекта.

appearance

appearance: null | string

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

Readonlyappearances

appearances: IDictionary<IViewAppearanceMetadata>

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

autoSelectFirstRow

autoSelectFirstRow: boolean

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

autoWidthRowLimit

autoWidthRowLimit: null | number

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

caption

caption: string

Заголовок объекта.

collapseGroups

collapseGroups: boolean

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

Readonlycolumns

columns: IDictionary<IViewColumnMetadata>

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

connection

connection: null | string

Алиас строки подключения (из конфигурационного файла веб сервиса app.json) к БД.

defaultSortColumns

defaultSortColumns: ISortColumn[]

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

enableAutoWidth

enableAutoWidth: boolean

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

exportDataPageLimit

exportDataPageLimit: number

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

Readonlyextensions

extensions: IDictionary<IViewExtensionMetadata>

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

ReadonlyformatVersion

formatVersion: number

Версия формата JSON.

groupingColumn

groupingColumn: null | string

Псевдоним столбца, по которому включена группировка по умолчанию.

multiSelect

multiSelect: boolean

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

pageLimit

pageLimit: number

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

paging

paging: Paging

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

Readonlyparameters

parameters: IDictionary<IViewParameterMetadata>

Параметры представления.

quickSearchParam

quickSearchParam: null | string

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

Readonlyreferences

references: IDictionary<IViewReferenceMetadata>

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

rowCounterVisible

rowCounterVisible: boolean

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

rowCountSubset

rowCountSubset: null | string

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

selectionMode

selectionMode: ViewSelectionMode

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

Readonlysubsets

subsets: IDictionary<IViewSubsetMetadata>

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

tagsPosition

tagsPosition: TagsPosition

Расположение контрола со списком тегов.

treatAsSingleQuery

treatAsSingleQuery: boolean

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

treeGroup

treeGroup: null | string

Имя столбца, содержащего признак того, что строка содержит только информацию о группе.

treeGroupDisplayValue

treeGroupDisplayValue: null | string

Имя столбца, содержащего отображаемое имя группы.

treeGroupId

treeGroupId: null | string

Имя столбца, содержащего идентификатор группы строки.

treeGroupParentId

treeGroupParentId: null | string

Имя столбца, содержащего идентификатор родительской группы.

treeId

treeId: null | string

Имя столбца идентификатора строки.

treeParentId

treeParentId: null | string

Имя столбца идентификатора родительской строки.

validationResult

validationResult: ValidationResult

Результат валидации представления.

Methods

clone

  • clone(): IViewMetadata

    Создает новый объект, который является копией текущего экземпляра.

    Returns IViewMetadata

deserializeFromStorage

isSealed

  • isSealed(): boolean

    Returns boolean

seal

  • seal(): this

    Returns this

serializeToStorage

Settings

Member Visibility

On This Page

Properties
Methods