Описание метаданных столбца представления.

interface IViewColumnMetadata {
    alias: string;
    appearance: null | string;
    calendarIdColumn: null | string;
    calendarOverdueFormat: null | string;
    calendarQuantsColumn: null | string;
    caption: string;
    condition: null | string;
    disableGrouping: boolean;
    hidden: boolean;
    invisibleByDefault: boolean;
    isVirtual: boolean;
    localizable: boolean;
    maxLength: null | number;
    normalizationKeyColumn: null | string;
    normalizationSource: null | string;
    nullValue: null | string;
    plannedColumn: null | string;
    schemeType: SchemeType;
    sortBy: null | string;
    sortByFormat: null | string;
    treatValueAsUtc: boolean;
    clone(): IViewColumnMetadata;
    deserializeFromStorage(
        storage: IStorage,
        context?: StorageSerializableContext,
    ): this;
    isSealed(): boolean;
    seal(): this;
    serializeToStorage(
        storage?: IStorage,
        context?: StorageSerializableContext,
    ): IStorage;
}

Hierarchy (View Summary, Expand)

Implemented by

Properties

alias: string

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

appearance: null | string

Псевдоним или имя колонки хранящего внешний вид.

calendarIdColumn: null | string

Псевдоним или имя колонки, содержащей ID календаря, кванты которого надо перевести в строку на сервере.

calendarOverdueFormat: null | string

Строка локализации или строка с форматом для отображения истекших сроков.

calendarQuantsColumn: null | string

Псевдоним или имя колонки, содержащей кванты календаря, которые надо перевести в строку на сервере.

caption: string

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

condition: null | string

Условия попадания объекта метаданных в результирующие метаданные.

disableGrouping: boolean

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

hidden: boolean

Признак скрытой колонки.

invisibleByDefault: boolean

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

isVirtual: boolean

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

localizable: boolean

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

maxLength: null | number

Максимальная длина отображаемых данных в столбце.

normalizationKeyColumn: null | string

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

normalizationSource: null | string

Имя справочника нормализации. Если указано, то колонка считается нормализуемой. Также требуется указать normalizationKeyColumn.

nullValue: null | string

Значение, подставляемое вместо NULL в строки с результатами выполнения представления на место этой колонки (на сервере). Если указаны null/пустая строка, то исходное значение NULL сохраняется.

Тип значения приводится к типу колонки schemeType в инвариантной культуре. Для бинарных колонок выполняется парсинг из base64.

Подстановка значения вместо NULL выполняется после нормализации, если для колонки заполнены значения normalizationSource и normalizationKeyColumn.

plannedColumn: null | string

Псевдоним или имя колонки, содержащей плановую дату завершения задания, которая необходима для вычисления строки срока на сервере.

schemeType: SchemeType

Тип данных столбца.

sortBy: null | string

Выражение для сортировки\группировки вида table.Column.

sortByFormat: null | string

Шаблон SQL-выражения для сортировки по указанной колонке.

treatValueAsUtc: boolean

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

Methods

  • Returns boolean

  • Returns this

MMNEPVFCICPMFPCPTTAAATR