TESSA Web API
    Preparing search index...

    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

    Index

    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: string

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

    appearance: null | string

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

    appearances: IDictionary<IViewAppearanceMetadata>

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

    autoSelectFirstRow: boolean

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

    autoWidthRowLimit: null | number

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

    caption: string

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

    collapseGroups: boolean

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

    columns: IDictionary<IViewColumnMetadata>

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

    connection: null | string

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

    defaultSortColumns: ISortColumn[]

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

    enableAutoWidth: boolean

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

    exportDataPageLimit: number

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

    extensions: IDictionary<IViewExtensionMetadata>

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

    formatVersion: number

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

    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

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

    Methods

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

      Returns IViewMetadata

    • Returns boolean

    • Returns this

    Settings

    Member Visibility

    On This Page

    Properties
    Methods