Дополнительные методы jqGrid

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

Следующая статья — «JqGrid поддержка языков с письмом справа-налево в Firefox».
Предыдущая статья — «Общие функции и свойства jqGrid».

Для того чтобы использовать эти методы, вам нужно отметить галочкой Custom при скачивании jqGrid. Для разработчиков: эти методы расположены в файле grid.custom.js. Эти методы должны использоваться так же, как методы из статьи «Список методов экземпляров jqGrid».

Метод: filterGrid
Параметры: grid_id, params
Возвращает: HTML-объект
Этот метод может вызываться для построения пользовательской формы поиска для таблицы и должен применяться не к таблице, а к HTML-элементу.
grid_id — id таблицы, к которой поиск будет применён.
params — массив параметров. Для получения большей информации обратитесь к статье «Пользовательский поиск в jqGrid».

Метод: filterToolbar
Параметры: params
Возвращает: объект jqGrid
Этот метод такой же, как и filterGrid, но элементы фильтра располагаются в таблице под заголовками. Когда меняется ширина заголовка, то элементы фильтра тоже меняют свою ширину в соответствии с новой шириной. Другое отличие от filterGrid в том, что фильтр в панели использует определения из colModel. Для получения большей информации обратитесь к статье «Панель поиска в jqGrid».

Метод: getColProp
Параметры: colname
Возвращает: array{}
Возвращает массив свойств колонки с переданным именем из colModel.

Метод: GridDestroy
Параметры: grid_id
Возвращает: true — при успешном выполнении, иначе — false.
Удаляет всю таблицу с id=grid_id из DOM (очищает весь HTML-код, связанный с таблицей и отвязывает все события)

Метод: GridUnload
Параметры: grid_id
Возвращает: true — при успешном выполнении, иначе — false.
Единственное отличие от предыдущего метода в том, что таблица уничтожается, но элементы table и pager (если есть) остаются и могут быть использованы ещё раз.

Метод: setGridState
Параметры: state
Возвращает: объект jqGrid
Показывает или скрывает таблицу в зависимости от параметра state. Если параметр state установлен в 'visible' — таблица показывается. Если параметр установлен в 'hidden' — таблица скрывается. Этот метод не вызывает событие onHeaderClick, и заголовок таблицы всегда виден.

Метод: setColProp
Параметры: colname, properties
Возвращает: объект jqGrid
Устанавливает новые свойства в colModel. Этот метод идеален для динамического изменения настроек колонки. Обратите внимание, что некоторые свойства не могут быть изменены. Смотрите статью «Свойства colModel в jqGrid» для получения подробностей. Например:
jQuery("#grid_id").setColProp('colname',{editoptions:{value:"True:False"}});
заменит свойство editoptions.

Метод: sortGrid
Параметры: colname, reload
Возвращает: объект jqGrid
Сортирует колонку с именем colname и показывает подходящую иконку сортировки. То же самое (без иконки сортировки) может быть сделано с помощью setGridParam({sortname:'myname'}).trigger('reloadGrid') . Если reload установлено в true, то таблица перезагрузит текущую страницу и настройки sortorder.

Метод: updateGridRows
Параметры: data, rowidname, jsonreader
Возвращает: true — при успешном выполнении, иначе — false.
Этот метод обновляет текущие данные в таблице по переданному rowidname.
data — массив данных в формате [{name:value,name1:value1}, {name:value,name2:value2}], где name — значение name из colModel, и value — новое значение. Не обязательно все колонки должны присутствовать в элементах data (как и в методе setRowData)
rowidname (string) — это name из строки, которое ведёт себя как id. Если не указано, то имя "id" используется.
jsonreader (boolean) — по умолчанию false. Если установлен в true, то определение jsonReader используется для установки данных. Это работает только в случае, когда элемент 'repeatitems' в jsonReader установлен в true. В этом случае данные должны быть в парах «имя:значение», ?но только значения, где число колонок должно быть равно этим из colModel?.

 

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

Следующая статья — «JqGrid поддержка языков с письмом справа-налево в Firefox».
Предыдущая статья — «Общие функции и свойства jqGrid».

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

Ваш адрес email не будет опубликован. Обязательные поля помечены *