ViewGridColumn

ViewGridColumn - наследник класса TableColumn.

Свойства

type

тип	значение по умолчанию	допустимые значения
string	string	string, number, bool, date, time, bigint

Задает тип колонки.

Используется для корректного отображения данных в гриде.

Примечание

Т.к. в БД колонки с типом bigint в js будут хранится в виде строки (из за ограничений типа Number), то сортировка по этой колоке будет как со строками. Тип bigint для колонки грида (для клиентского грида) был добавлен для того, чтобы строки сортировались как числа. Если грид серверный, то эта проблема не актуальна, т.к. сортировка происходит на сервере.

dataField

тип	значение по умолчанию	допустимые значения	Обязательное
string	-		Да

Задает имя свойства для биндинга (обязательное свойство).

Должно быть уникальным в рамках одного грида. По значению этого свойство можно обращаться к объектной модели колонки.

text

тип	значение по умолчанию	допустимые значения
string	-	-

Задает заголовок колонки.

width

тип	значение по умолчанию	допустимые значения
string	auto	auto, ширина в пикселях(px), процентах(%)

Задает ширину колонки

Значение можно указывать в пикселях(px), процентах(%), либо авто ширину (значение 'auto').

align

тип	значение по умолчанию	допустимые значения
string	left	left, right, center

Задает выравнивание по горизонтали для заголовка.

cellsAlign

тип	значение по умолчанию	допустимые значения
string	left	left, right, center

Задает выравнивание текста внутри ячеек колонки по горизонтали.

visible

Отнаследовано от Control.

visibilityCustomizable

тип	значение по умолчанию	допустимые значения
bool	true	true, false

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

pinned

тип	значение по умолчанию	допустимые значения
bool	false	true, false

Делает колонку заблокированной от прокрутки по горизонтали.

hint

Всплывающая подсказка, которая появляется при наведении на контрол.

Отнаследовано от Control.

Текст всплывающей подсказки. В случае отсутствия свойства применяются в следующем порядке text, dataField.

cellsHintLength

тип	значение по умолчанию	допустимые значения
number	-	-

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

aggregates

тип	значение по умолчанию	допустимые значения
[string]		['sum', 'max', 'min', 'avg', 'count']

Задает типы агрегирования для колонки, которые будут отображаться в итоговых полях.

Свойство доступно только в js-коде. Для задания в шаблоне используйте ViewGridColumnAggregate. Для удаления агрегатов необходимо присвоить пустой массив.

Пример

// задать агрегаты 'sum' и 'avg'
this.controls.grid1.columns.c1.aggregates = ['sum', 'avg']
// удалить агрегаты
this.controls.grid1.columns.c2.aggregates = []

aggregateType

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

Аналогично aggregateType Grid.

groupingIndex

Задает индекс группировки, начиная с 0. Свойство недоступно в объектной модели колонки.

Аналогично groupingIndex Grid

removeHtml

тип	значение по умолчанию	допустимые значения
bool	false	true, false

Позволяет удалять HTML-теги при отображении данных внутри ячеек.

format

тип	значение по умолчанию	допустимые значения
string	-	-

Задает форматирование ячейки.

Форматирование колонки с типом number

Доступние символы:

• g - задает группировку по разрядам.
• f* - позволяет задать количество знаков после запятой, где * - количество знаков (если не задано, то дробная часть не форматируется). Если необходимо число вывести без дробной части, то необходимо задать значение f0. Можно комбинировать с символом g (должен указываться перед символом f).
• [ ] - внутри квадратных скобок указывается выводимый текст. Должен комбинироваться с символом f и/или g. Сами скобки запрещается использовать в качестве строки текста. Текст может задаваться в начале и/или в конце. Примеры: gf2[ руб.], f[ текст в конце], [текст в начале ]f, [текст в начале ]f[ текст в конце].

Форматирование колонки с типом time

Доступные значения:

• HH:mm:ss - выводит часы, минуты, секунды
• HH:mm - выводит часы, минуты.

Форматирование колонки с типом date

Доступные символы:

• YYYY - четырехзначный год. Примеры: 0999, 2015
• YY - двухзначный год. Примеры: 99, 01, 15
• Y - четырехзначный год с удалением лишних нулей в начале. Примеры: 2, 44, 888, 2015
• MMMM - название месяца (полное). Примеры: Январь, Декабрь
• MMM - название месяца (сокращенное). Примеры: Янв, Дек
• MM - номер месяца с нулем в начеле. Примеры: 01, 12
• M - номер месяца. Примеры: 1, 12
• DD - день с нулем в начале. Примеры: 02, 31
• D - день. Примеры: 2, 31
• dddd - день недели (полное). Примеры: Пятница, Воскресенье
• ddd - день недели (сокращенное). Примеры: Пт, Вс
• dd - день недели (сокращенное). Примеры: Пт, Вс
• HH - часы в 24-часовом формате с нулем в начале. Примеры: 23, 08
• H - часы в 24-часовом формате. Примеры: 23, 8
• hh - часы в 12-часовом формате с нулем в начале. Примеры: 11, 08
• h - часы в 12-часовом формате. Примеры: 11, 8
• A - время суток. Примеры: утро, день, вечер, ночь
• mm - минуты с нулем в начале. Примеры: 14, 07
• m - минуты. Примеры: 14, 7
• ss - секунды с нулем в начале. Примеры: 05, 10
• s - секунды. Примеры: 5, 10
• SSS - тысячные доли секунд. Примеры: 753, 022
• SS - сотые доли секунд. Примеры: 75, 02
• S - десятые доли секунд. Примеры: 7, 0
• Z - смещение часового пояса. Примеры: +0100, -0800
• [ ] - внутри квадратных скобок можно указывать выводимый текст с экранированием спецсимволов.

Примеры

день.месяц.годдень-месяц-год часы:минутыдень месяц год 'года'

DD.MM.YYYY

DD-MM-YYYY HH:mm

DD MMMM YYYY [года]

Коллбэки

imageRenderer

imageRenderer - колбэк, который позволяет отрисовать картинку в ячейках грида.

imageRenderer(s, e) {
    return {
        image, 
        showValue   
    }
}

параметр	тип	описание
s	TableColumn	ссылка на экземпляр грида
e	object	объект параметров
e.dataField	string	свойство dataField колонки
e.objectField	object	свойство objectField колонки
e.rowIndex	number	индекс строки
e.rowData	string	ссылка на объект с данными для текущей строки

Обработчик должен вернуть объект со свойствами:

• image - ссылка на картинку.
• showValue - позволяет скрыть/отобразить значение ячейки (по умолчанию false).

Пример

import addIMG from 'current-theme/images/grid/add.png'
...
imageRenderer(s, e) {
    return { image: addIMG, showValue: true };
}   

---