Цикл статей «Документация jqGrid на русском».
Следующая статья — «Список triggered-событий в jqGrid».
Предыдущая статья — «События в jqGrid».
Событие: afterInsertRow
Параметры: rowid, rowdata, rowelem
Это событие возникает после каждого добавления новой строки.
rowid — id вставленной записи
rowdata — массив с данными для вставки. Этот массив имеет вид «имя:значение», где имя — это name из colModel.
rowelem — это элемент из ответа сервера. Если используются XML-данные, то здесь XML-элемент для строки. Если JSON-данные, то это массив с данными для строки.
Внимание! Это событие не возникает, если свойство gridview установлено в true.
Событие: beforeProcessing
Параметры: data, status, xhr
Это событие возникает перед обработкой данных с сервера. Параметр data форматирован в зависимости от datatype. Если datatype равен
'json' , то data является объектом Javascript.
Событие: beforeRequest
Параметры: нет
Это событие возникает перед запросом любых данных. Событие не возникает в случае, когда datatype является функцией. Если событие возвращает false, то запрос на сервер не отправляется.
Событие: beforeSelectRow
Параметры: rowid, e
Это событие возникает, когда пользователь кликает на строку, но перед выделением строки.
rowid — id строки.
e — объект event.
Это событие должно вернуть true или false. Если событие возвращает true, то происходит выделение строки. Если событие возвращает false, то строка не выделяется, и любое другое определённое действие не происходит.
Событие: gridComplete
Параметры: нет
Это событие возникает после того, как все данные были загружены в таблицу, и все процессы завершены. Событие возникает независимо от свойства datatype и после сортировки, перехода на страницу и т. д.
Событие: loadBeforeSend
Параметры: xhr, settings
Событие, возникающее перед отправкой. Позволяет менять XMLHttpRequest (xhr) перед отправкой. Используйте это событие для установки особых заголовков и др. Возврат false из события отменяет запрос.
Событие: loadComplete
Параметры: data
Это событие возникает сразу после выполнения каждого запроса на сервер.
data — данные из ответа. Зависят от свойства datatype.
Событие: loadError
Параметры: xhr, status, error
Возникает при ошибке отправки запроса на сервер. Обработчик получает три аргумента: XMLHttpRequest (xhr), строка с описанием типа ошибки (status) и не обязательный объект исключения (error), если оно было.
Событие: onCellSelect
Параметры: rowid, iCol, cellcontent, e
Вызывается при клике на ячейку таблицы.
rowid — id строки.
iCol — индекс колонки.
cellcontent — содержимое ячейки.
e — объект event того элемента, на который был клик.
(Заметьте, что это доступно, когда мы НЕ используем редактирование ячейки, и недоступно при использовании редактирования ячейки).
Событие: ondblClickRow
Параметры: rowid, iRow, iCol, e
Возникает при двойном щелчке на строке таблицы.
rowid — id строки.
iRow — индекс строки.
iCol — индекс колонки.
e — объект event.
Событие: onHeaderClick
Параметры: gridstate
Возникает после клика на иконку показ/скрытие таблицы (hidegrid:true).
gridstate — статус таблицы. Может быть одним из значений: visible, hidden.
Событие: onPaging
Параметры: pgButton
Это свойство возникает при клике на кнопки постраничной навигации и после заполнения данных. Также работает при вводе пользователем номера страницы в input box (и нажатии клавиши Enter), и когда количество запрашиваемых данных меняется с помощью select box-а. В это событие передаётся только один параметр pgButton. Смотрите статью «Постраничная навигация в jqGrid».
Если это событие возвращает
'stop', то обработка останавливается, и вы можете определить свою собственную постраничную навигацию.
Событие: onRightClickRow
Параметры: rowid, iRow, iCol, e
Возникает сразу после клика правой кнопкой мышки по строке.
rowid — id строки
iRow — порядковый индекс строки (не путайте с rowid),
iCol — порядковый индекс ячейки.
e — объект event.
Заметьте: Это событие не работает в Opera, так как опера не поддерживает событие oncontextmenu.
Событие: onSelectAll
Параметры: aRowids, status
Это событие возникает, когда свойство multiselect установлено в true, и когда пользователь кликает на checkbox-е в заголовке.
aRowids — массив выбранных строк (массив rowid).
status — логическая переменная, определяющая статус checkbox-а в заголовке. Если выбран — true, в противном случае — false.
Обратите внимание, что aRowids всегда содержит ids, когда checkbox в заголовке выбран или не выбран.
Событие: onSelectRow
Параметры: rowid, status, e
Возникает сразу после клика на строке.
rowid — id строки,
status — статус выбора. Если строка выбрана — true, в противном случае — false.
e — объект event. Может быть использован в случае, когда multiselect установлен в true.
Событие: onSortCol
Параметры: index, iCol, sortorder
Возникает сразу после клика на сортируемой колонке, перед сортировкой данных.
index — index из colModel,
iCol — порядковый индекс колонки,
sortorder — новое направление сортировки. Может быть
'asc' or
'desc' .
Если это свойство вернёт
'stop', то обработка сортировки остановится, и вы сможете определить пользовательскую сортировку.
Событие: rowattr
Параметры: rowData, currentObj, rowId
rowData — это массив с данными ячеек.
currObj — это текущая строка, представленная в исходном виде (JSON или XML).
rowId — id строки.
Это событие возникает при добавлении новой строки в таблицу. Оно может использоваться для установки дополнительных стилей CSS для строки. Событие должно вернуть объект вида
{"style" : "somestyle", "class": "someclass"}. Обратите внимание, что вы можете указать любой атрибут для строки. Важно иметь в виду, что событие возникает только при добавлении новой строки. Это означает, что оно не может быть использовано с методами, которые обновляют строку, например, setRowData.
Событие: resizeStart
Параметры: event, index
Событие, которое вызывается, когда мы начинаем менять ширину ячейки.
event — объект event.
index — index колонки из colModel.
Событие: resizeStop
Параметры: newwidth, index
Событие вызывается после изменения ширины колонки. Параметр newwidth содержит новую ширину. Параметр index — индекс колонки из colModel.
Событие: serializeGridData
Параметры: postData
Если установлено, то это свойство позволяет сериализовать данные, отправляемые в Ajax-запросе. Функция должна вернуть сериализованные данные. Это событие может использоваться в случае, когда на сервер должны быть отправлены специфические данные. Например: JSON-строка, XML-строка и другие.
В это событие мы передаём объект postData.
Дополнительные свойства описани в статьях «Редактирование ячейки в jqGrid» и «Подтаблицы (Subgrid) в jqGrid».
Цикл статей «Документация jqGrid на русском».
Следующая статья — «Список triggered-событий в jqGrid».
Предыдущая статья — «События в jqGrid».