API клиентской части конфигурации

Это описание относится к версии 3!!! Актуальное API — на отдельной странице: API для Iris CRM 4.0.19+.

Содержание

IrisCardController (карточка)

Language (переводы)

Transport (обращение к серверу)

Функции для работы с балансом

API для работы с карточками записей

Функции для смены ответственного

API для работы с формами

API для работы с таблицами

Общие функции

Системные функции

Для работы с email

Печатные формы

IrisCardController

Методы IrisCardController
ФункцияНазначение
getField()Принимает название поля и возвращает поле (объект jQuery). Пример вызова: this.getField('Name');
getFields()Принимает название код вкладки и название поля, и возвращает набор полей (объектов jQuery), относящихся к matrix. Пример вызова: this.getFields('d_Account_Property', 'Name');
bindFields()Используется, когда требуется, чтобы значение в одном поле фильтровало набор доступных значений в другом поле. Работает для lookup-полей.
serverEvent()Вызов указанного серверного обработчика для указанного поля.
onChangeEvent()Вызов серверного onBeforePost() для редактируемого поля.

Language

Методы Transport
ФункцияНазначение
t()Перевод сообщения

Transport

Методы Transport
ФункцияНазначение
request()Вызов метода на сервере

Функции для работы с балансом (balance.js)

Функции файла config/common/Lib/balance.js
ФункцияНазначение
increaseBalance()Функция пополнения баланса. Используется в разделах Мои счета, Мой кошелек.

API для работы с карточками (cards.js)

Функции файла config/common/Lib/cards.js
ФункцияНазначение
c_Common_SetOnBlur()Назначение обработчика события onblur для элемента с возможностью немедленного его вызова.
c_Common_SetOnChange()Назначение обработчика события onchange для элемента с возможностью немедленного его вызова.
c_Common_LinkedField_OnChange()Назначение стандартного обработчика на изменение поля(onchange для select и onblur для lookup).
c_Common_LinkedField_OnChange_end()Обработчик ответа на изменение поля справочника.
c_Common_SetDefaultValues()Заполнение полей карточки значениями по умолчанию (запрос на получение массива значений по умолчанию и вызов c_Common_SetFieldValues_end()).
c_Common_SetFieldValues_end()Обработчик ответа на заполнение полей значениями по умолчанию (непосредственное заполнение полей).
g_Common_InsertDefaultRowValues()Заполнение полей значениями по умолчанию для таблицы (вставка строки со значениями по умолчанию в БД и запрос на g_Common_InsertRowFieldValues_end()).
g_Common_InsertRowFieldValues_end()Заполнение созданной строки таблицы значениями по умолчанию.
g_Common_UpdateRowField()Обновление значения в строке таблицы после его изменения в интерфейсе (обновление на уровне БД и запрос на g_Common_UpdateRowField_end()).
g_Common_UpdateRowField_end()Обновляем поля в строке таблицы после изменения значений на уровне БД.
c_Common_GetElementValue()Возвращает значение элемента карточки.
c_Common_SetElementValue()Присваивает элементу карточки значение.
c_Common_IsRemind_OnChange()Стандартный обработчик изменения поля Напоминание.
c_Common_RemindDate_OnChange()Стандартный обработчик изменения поля Дата напоминания.
GetArrayValueByParameter()Возвращает значение элемента массива ассоциативных массивов по значению одного из параметров.
GetElementHTMLCode()Возвращает HTML код элемента карточки.
ShowValueFieldByType()Отображает на карточке поле со значением в зависимости от его типа.
c_Common_MakeFieldValue()Формирует значение поля в стандартном формате.

Функции для рекурсивной смены ответственного (chown.js)

Функции файла config/common/Lib/chown.js
ФункцияНазначение
c_common_drawChownBtn()Отображение кнопки Сменить ответственного.
c_common_chown()Отправка запроса на сервер для смены ответственного.
c_common_chown_child()Рекурсивная функция для смены ответственного во всех связанных сущностях. Используется функцией c_common_chown().

API для работы с формами (forms.js)

Функции файла config/common/Lib/forms.js
ФункцияНазначение
getItemIndexByParamValue()Возвращает порядковый номер элемента в DOM модели формы по значению заданного параметра.
SetSelectValueByID()Установка значения в select-поле по ID.
SetSelectValueByAttribute()Установка значения в select-поле по атрибуту (code и т.д.).
HideAccessCardIDColumn()Скрыть на карточке поле RecordID.
UpdateCardHeight()Устанавливаем высоту окна по содержимому, чтобы не подгонять.
addCardHeaderButton()Создание кнопки на верхней панели карточки.

API для работы с таблицами (grids.js)

Функции файла config/common/Lib/grids.js
ФункцияНазначение
CreateSummaryPanel()Создает в таблице строчку с итогами. Если она уже есть, то обновляет ее содержимое.
g_DrawAddRecordRow()Функция добавления в редактируемую таблицу строки, которая позволяет добавлять новые записи.
g_CreateNewGridRecord()Создание новой записи в редактируемой таблице.
getGridFooterTable()Возвращает панель с кнопками управления записями таблицы.
g_Prepare_Custom_Section()Подготовка нестандартного раздела к использованию.
g_InsertUserButtons()Добавление дополнительных кнопок на панель кнопок таблицы.
g_GetButtonMenuHTML()Формирует HTML код кнопки с выпадающим меню (дополнительные кнопки для таблиц).

Общие функции (lib.js)

Функции файла config/common/Lib/lib.js
ФункцияНазначение
IsEmptyValue()Возвращает true, если пустое значение или переменная не определена.
IsEmptyGUIDValue()Возвращает true, если пустое значение или содержит null или переменная не определена.
ShowCustomWindow()Отобразить окно с указанным содержимым.
Common_ShowCustomWindow()Отобразить окно с указанным содержимым и кнопками.
GetFieldValueByFieldName()Возвращает значение поля по названию поля. Значения полей передаются в виде стандартной структуры конфигурации.

Системные функции (common.js)

Функции файла core/engine/js/common.js
ФункцияНазначение
bind_lookup_element()Привязка lookup элемента к родительскому элементу (select или lookup). При смене значеня в родительском элементе, в дочернем элементе проводится фильтрация значений по полю p_child_field_name.
bind_select_element()Привязывает select элемент к родительскому элементу (select или lookup). При смене значеня в родительском элементе, в дочернем элементе проводится фильтрация значений. При фильтрации используются атрибуты тега option дочернего элемента.
ClearFormValues()Очистка пользовательских полей формы карточки. При этом системные поля не очищаются.
getGridSelectedID()Получение ID выбранной записи в таблице записей.
getGridSelectedIDs()Получение списка ID выбранных записей в таблице записей.
getNumberCaption()Возвращает окончание для множественного числа слова. В функцию передаётся число сущностей, для которого нужно подобрать окончания, и массив слов (или окончаний для слов).
get_window_id()Возвращает id окна, в котором находится элемент p_elem.
GetCardMD5()Подсчет хеша значений полей для карточки, расположенной в окне p_window_id. Хеш значений необходим для отслеживания изменений в карточке.
getElementValue()Получает значение элемента p_element. Элементом может выступать текстовое поле, список, lookup поле и поле даты.
iris_GetCurrentDate()Получение текущей даты в формате dd.mm.yyyy.
iris_GetCurrentTime()Получение текущего времени в формате hh:mm.
iris_GetCurrentDateTime()Получение текущей даты в формате dd.mm.yyyy hh:mm.
is_date_correct()Проверяет правильность заполнения даты.
is_int_correct()Проверяет правильность заполнения целого числа.
is_decimal_correct()Проверяет правильность заполнения дробного числа.
isBrowserChrome()Определяет, является ли текущий браузер браузером Google Chrome. Функция является дополнением к свойству Prototype.Browser библиотеки Prototype.
openCard()Открывает карточку записи раздела или справочника
refresh_grid()Обновляет содержимое таблицы записей с id=p_grid. Выполняет то же действие, что и кнопка "Обновить" в таблице записей.
SetLookupValue()Устанавливает значение для lookup элемента. Если значение элемента (id) изменилось, то для элемента вызывается событие lookup:changed.
showNotify()Показывает всплывающее уведомление. См. также showNotifySpecial
switchShadowCard()Устанавливает(снимает) картинку загрузки у окна той карточки.
wnd_alert()Показывает модальное окно с сообщением p_message.

Функции для работы с email (mailto.js)

Функции файла config/common/Lib/mailto.js
ФункцияНазначение
mail_to()Замена стандартной функции ядра mail_to(), которая вызывается при нажатии на конвертик письма. Вместо вызова стандартного почтового клиента откроется карточка нового письма.

Функции для печатных форм (printform.js)

Функции файла config/common/Lib/printform.js
ФункцияНазначение
printform_createButton()Добавляет кнопку печатной формы в таблицу.
printform_show()Вывод на экран заполненной печатной формы.

Навигация