Общие функции и свойства jqGrid

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

Следующая статья — «Дополнительные методы jqGrid».
Предыдущая статья — «Список методов экземпляров jqGrid».

Эти функции могут быть использованы в любом месте проекта и не связаны с экземпляром jqGrid. Это означает, что синтаксис у них такой:

Где:

  • jgrid.jqGridFunction — это имя функции
  • parameter1,…parameterN — это список параметров

Обратите внимание на пространство имён jqgrid.

Функция/Свойство: ajaxOptions
Параметры: Пустой объект
Возвращает: ничего
Это свойство позволяет устанавливать глобальные настройки для всех AJAX-запросов, используемых в таблице. Обратите внимание, что с помощью этого свойства можно переопределить все текущие настройки AJAX для определённого модуля. Начиная с версии 3.6, мы имеем 3 уровня настроек AJAX.
Первый уровень специфичен для модуля, когда мы используем AJAX.
Второй уровень определяется этим свойством и третий уровень может быть передан дополнительным параметром в конкретный метод. Третий уровень имеет наивысший приоритет. Это означает, что мы используем следующее глобальное правило для всех настроек AJAX:
jQuery.extend(jQuery.ajax({method specific options}, ajaxOptions, ThirdLevelajaxSettinds));
В дополнение к этому мы имеем возможность определять на каждом AJAX-запросе функцию сериализации, которая позволяет конвертировать параметры, передаваемые на сервер.

Функция/Свойство: jqID
Параметры: string
Возвращает: разобранную строку
Экранирует специальные символы в строке двумя обратными косыми чертами (\\), так что одна обратная косая черта будет вставлена в строку и сможет быть корректно распознана при использовании в селекторе jQuery.

Функция/Свойство: jgrid.htmlDecode
Параметры: string
Возвращает: декодированную строку
Функция htmlDecode декодирует закодированную HTML-строку обратно в оригинальный HTML-код.

Функция/Свойство: jgrid.htmlEncode
Параметры: string
Возвращает: закодированную строку
Кодирует HTML-строку. Обратная для htmlDecode.

Функция/Свойство: jgrid.format
Параметры: string
Возвращает: Форматированную строку
Простые шаблоны строк. Принимает строку-шаблон в качестве первого аргумента. Если второй аргумент указан, то он используется для подстановок в первом аргументе.
Пример: jQuery.jqgformat("Please enter a value between {0} and {1}.", 4, 8)
Результат : “Please enter a value between 4 and 8.”

Функция/Свойство: jgrid.getCellIndex
Параметры: cell
Возвращает: индекс
Этот метод часто используется для исправления бага в Internet Explorer 7, где CellIndex вычисляется в Отображаемом Порядке, а не в реальном. Параметр cell — это содержимое ячейки (то есть элемент td).

Функция/Свойство: jgrid.stringToDoc
Параметры: xmlstring
Возвращает: xmlDoc
Преобразует xmlstring в документ dom. Возвращает xmlDoc — документ dom.

Функция/Свойство: jgrid.stripHtml
Параметры: content
Возвращает: new_content
Функция убирает HTML-теги из переданного content.

Функция/Свойство: jgrid.parse
Параметры: jsonString
Возвращает: объект
Эта функция разбирает jsonString (JSON-текст) и создаёт объект или массив.
Чтобы предотвратить атаки Javascript-угонов(hijacking), создатели веб-приложений должны использовать эту функцию. Она возвращает объект, представляющий JSON.
Циклические структуры определяются и безопасно прерываются, но не могут быть в дальнейшем восстановлены.
1. Циклы while(1), расположенные в начале JSON,
2. Комментарии в начале и конце текста.
Поставщикам JSON-данных рекомендуется использовать один или несколько из этих методов, чтобы предотвратить исполнение данных. Такой JSON-ответ может выглядеть как:

jqGrid использует эту функцию при получении данных с datatype:'json'

 

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

Следующая статья — «Дополнительные методы jqGrid».
Предыдущая статья — «Список методов экземпляров jqGrid».

 

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

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