Свойства colModel в jqGrid

Цикл статей «Документация jqGrid на русском».

Следующая статья — «Манипуляция данными в jqGrid».
Предыдущая статья — «Свойства jqGrid».

Свойство colModel определяет колонки таблицы как массив объектов. Это наиболее важная часть jqGrid.

Возможные свойства объектов в colModel перечислены здесь в алфавитном порядке. Единственное обязательное поле — это name. Свойства colModel могут быть установлены или получены с помощью getColProp и setColProp. За более подробной информацией обратитесь к статье «Дополнительные методы jqGrid».

Свойство: align
Тип: string
Определяет выравнивание ячейки в теле таблицы, а не в заголовке. Возможные значения: "left" , "center" , "right" .
По умолчанию: "left"

Свойство: cellattr
Тип: function
Эта функция добавляет атрибуты к ячейке во время создания данных (т. е. динамически). Все корректные атрибуты ячейки могут использоваться, или может использоваться атрибут style с разными свойствами. Функция должна возвращать строку. Параметры функции:
rowId — id строки
val — значение, которое будет добавлено в ячейку.
rawObject — Сырой объект данных для строки. Например, если datatype равен json, то массив, если datatype равен xml, то элемент xml.
cm — Все свойства этой колонки, перечисленные в colModel.
rdata — Строка с данными, которая будет вставлена в строку. Этот параметр является объектом, в котором имя свойства — это name из colModel, value — значение.
По умолчанию: null

Свойство: classes
Тип: string
Это свойство позволяет добавить классы к колонке. Если используется больше одного класса, то между ними должен быть пробел. Например, 'class1 class2'  установит class1 и class2 для каждой ячейки в колонке. В табличном файле стилей есть предопределённый класс ui-ellipsis, который позволяет присоединить ellipsis к определённой строке row. Работает также и в FireFox.
По умолчанию: пустая строка

Свойство: datefmt
Тип: string
Управляет форматом при sorttype:'date' (когда datetype установлено в 'local' ) и для полей editrules {date:true}. Определяет ожидаемый формат данных для этой колонки. Использует форматирование в стиле PHP. На текущий момент "/" , "-"  и "."  поддерживаются как разделители дат. Корректные форматы:
y,Y,yyyy для года с четырьмя цифрами
YY, yy для года с двумя цифрами
m,mm для месяцев
d,dd для дней.
Смотрите «Получение данных в jqGrid» раздел «Array Data».
По умолчанию: ISO Date (Y-m-d)

Свойство: defval
Тип: string
Значение по умолчанию для поля поиска. Это свойство используется только в Пользовательском Поиске и устанавливается в качестве начального значения для поиска.
По умолчанию: empty

Свойство: editable
Тип: boolean
Можно ли поле редактировать. Это свойство используется в режимах редактирования ячейки, строки и формы. Смотрите «Общие свойства редактирования в jqGrid».
По умолчанию: false

Свойство: editoptions
Тип: array
Объект с допустимыми свойствами редактирования. Смотрите «Общие свойства редактирования в jqGrid».
По умолчанию: пустой массив

Свойство: editrules
Тип: array
Устанавливает дополнительные свойства для поля редактирования. Смотрите «Общие свойства редактирования в jqGrid».
По умолчанию: пустой массив

Свойство: edittype
Тип: string
Определяет способ редактирования для редактирования в строке и редактирования в форме. Возможные значения: "text" , "textarea" , "select" , "checkbox" , "password" , "button" , "image"  и "file" . Смотрите также «Общие свойства редактирования в jqGrid» свойство edittype.
По умолчанию: text

Свойство: firstsortorder
Тип: string
Если установлено в "asc"  или "desc", то сперва колонка будет отсортирована по этому направлению. Последующие сортировки колонки будут переключаться как обычно.
По умолчанию: null

Свойство: fixed
Тип: boolean
Если установлено в true, то ширина колонки не будет пересчитываться при shrinkToFit, установленном в true. Также ширина не будет меняться при использовании метода setGridWidth.
По умолчанию: false

Свойство: formoptions
Тип: array
Определяет различные свойства для режима редактирования в форме. Смотрите «Общие свойства редактирования в jqGrid» и «Редактирование в форме в jqGrid».
По умолчанию: пусто

Свойство: formatoptions
Тип array
Свойства форматирования могут быть определены для конкретных колонок. Тогда они будут переопределять свойства из языкового файла. Смотрите «Предопределённое форматирование в jqGrid».
По умолчанию: none

Свойство: formatter
Тип: mixed
Предопределённые типы (строка) или пользовательская функция, контролирующие форматирование в ячейке. Смотрите «Предопределённое форматирование в jqGrid».
По умолчанию: none

Свойство: frozen
Тип: boolean
Если установлено в true, то колонка будет заморожена после вызова метода setFrozenColumns.
По умолчанию: false

Свойство: hidedlg
Тип: boolean
Если установлено в true, то колонка не будет показана в диалоговом окне, где пользователи могут выбрать, какие колонки показывать, а какие скрывать. Относится к устаревшему методу setColumns.
По умолчанию: false

Свойство: hidden
Тип: boolean
Скрывает колонку при инициализации.
По умолчанию: false

Свойство: index
Тип: string
Устанавливает имя индекса при сортировке. Передаётся в качестве параметра sidx.
По умолчанию: пустая строка

Свойство: jsonmap
Тип: string
Определяет сопоставление колонки во входящей JSON-строке. Смотрите «JSON-данные в jqGrid»
По умолчанию: none

Свойство: key
Тип: boolean
Переопределяет id (определённый в readers) с сервера. Может быть установлен как id для определения уникального идентификатора строки. Только одна колонка может иметь это свойство. Это свойство имеет более высокий приоритет, чем свойство из readers. Если более чем одно свойство key установлено для таблицы, то используется только первое, а остальные игнорируются.
По умолчанию: false

Свойство: label
Тип: string
Когда массив colNames пуст, определяет заголовок для этой колонки Если colNames пуст, и это свойство пусто, то заголовок для этой строки берётся из свойства name.
По умолчанию: none

Свойство: name
Тип: string
Уникальное имя колонки в таблице. Это свойство обязательно для заполнения. Так же как и другие слова, используемые для имён свойств/событий, зарезервированные слова (которые не могут быть использованы для имён), включая subgrid, cb and rn.
Обязательно нужно заполнить!

Свойство: resizable
Тип: boolean
Определяет, можно ли менять ширину колонки.
По умолчанию: true

Свойство: search
Тип: boolean
При использовании в модулях поиска, запрещает или разрешает поиск по этой колонке. Смотрите «Настройки поиска в jqGrid».
По умолчанию: true

Свойство: searchoptions
Тип: array
Настройки поиска. Смотрите статью «Настройки поиска в jqGrid»
По умолчанию: пусто

Свойство: sortable
Тип: boolean
Можно ли сортировать по этой колонке.
По умолчанию: true

Свойство: sortfunc
Тип: function
Пользовательская функция для пользовательской сортировки в случае, когда datatype установлен в "local". Передаются три параметра: a, b и direction. Параметры a и b — это значения, которые нужно сравнить. Параметр direction является числом 1 или -1 для сортировки по возрастанию и сортировки по убыванию соответственно. Функция должна вернуть 1, -1 или 0.
По умолчанию: null

Свойство: sorttype
Тип: mixed
Используется в случае, когда datatype установлен в "local". Определяет подходящий тип колонки для сортировки. Возможные значения:
int/integer — сортировка целых чисел
float/number/currency — для сортировки дробных чисел
date — для сортировки дат
text — для сортировки текстовых данных
function — определяет пользовательскую функцию сортировки. В эту функцию мы передаём значение, которое нужно отсортировать, и она должна вернуть значение тоже. Смотрите также «Массив данных в jqGrid».
По умолчанию: text

Свойство: stype
Тип: string
Определяет тип элемента при поиске. Смотрите «Настройки поиска в jqGrid».
По умолчанию: text

Свойство: surl
Тип: string
Корректно только при Пользовательской Сортировке и edittype : "select"  и описывает url, с которого мы можем получить уже сформированный элемент select.
По умолчанию: пустая строка

Свойство: template
Тип: object
Множество корректных свойств для colModel. Это свойство может быть использовано, если мы хотим переопределить множество свойство по умолчанию в модели колонок. Смотрите свойство cmTemplate в свойствах таблицы.
По умолчанию: null

Свойство: title
Тип: boolean
Если это свойство установлено в false, то заголовок колонки не показывается, когда мы перемещаем курсор мыши по ячейке.
По умолчанию: true

Свойство: width
Тип: number
Устанавливает начальную ширину колонки в пикселях. На текущий момент это свойство не может быть указано в процентах.
По умолчанию: 150

Свойство: xmlmap
Тип: string
Определяет XML-сопоставление колонки во входящем XML-файле. Используйте спецификацию CSS. Смотрите «XML-данные в jqGrid».
По умолчанию: none

Свойство: unformat
Тип: function
Пользовательская функция для преобразования из форматированного значения обратно в значение ячейки при редактировании. Смотрите «Пользовательское форматирование в jqGrid». (Unformat также вызывается при сортировке. Значение, возвращённое unformat, используется в процессе сортировки.)
По умолчанию: null

Свойство: viewable
Тип: boolean
Это свойство корректно только при активированном методе viewGridRow. Если это свойство установлено в false, то колонка не появляется в форме просмотра.
По умолчанию: true

Как упоминалось выше, следующие свойства в colModel могут быть получены или sfunction:
rowId — id колонки
val — значение, которое будет вставлено в колонку.
rawObject — сырой объект данных этой строки. Например, если datatype равен "json" , то это JSON-массив, если datatype равен "xml" , то это XML-элемент.
cm — Все свойства этой колонки, перечисленные в colModel.
rdata — строка с данными, которая будет вставлена в строку. Этот параметр является массивом вида name:value, где name — это свойство name из colModel, value — значение. et usitemplateng the methods getColProp and setColProp. Ниже перечислены свойства, которые не могут быть изменены после создания таблицы (Если они будут изменены, то изменения не будут иметь эффекта или будут вызывать ошибки). Для некоторых из этих свойств есть специальные методы для изменения из значений:

name
width
resizable
label (Есть метод)

 

 

Цикл статей «Документация jqGrid на русском».

Следующая статья — «Манипуляция данными в jqGrid».
Предыдущая статья — «Свойства jqGrid».


Поделиться:
1 Звезда2 Звезды3 Звезды4 Звезды5 Звезд (Пока оценок нет)
Загрузка...

Свойства colModel в jqGrid: 2 комментария

  1. Снова здравствуйте. Свойство hidden убирает колонку отовсюду, в т.ч. и из формы редактирования. Как сделать чтобы на форме она была видима, а в гриде скрыта? Колонка внешнего ключа и редактируется через edittype:»select».

  2. Можно удалить оба сообщения. hidden:true,editrules: {edithidden:true}. Не внимательно читал.

Добавить комментарий

Ваш e-mail не будет опубликован.

*