You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 28 Next »
Данные классы описывают методы настройки структуры и функциональности виджетов:
- Используйте методы объекта s_widget класса SimpleWidget для добавления необходимой функциональности. Объект доступен при инициализации виджета.
- Используйте методы объекта s_widgets класса SimpleWidgets для добавления необходимой функциональности. Объект инициализируется при добавлении виджета на форму или на страницу портала.
Для создания пользовательских методов используйте s_widget_custom.
Эти методы могут быть использованы только на стороне клиента.
SimpleWidget
s_widget
Используйте глобальный объект s_widget для того, чтобы выполнить пользовательскую настройку текущего виджета.
Для того чтобы вручную вызвать метод в консоли, передайте ID экземпляра виджета в первом параметре. Например, чтобы вызвать метод:
s_widget.getFieldValue(key);
используйте следующий способ его вызова:
s_widget.getFieldValue(widgetId, key);
s_widget.addTemplate(id, template, script, type)
Используйте метод для добавления дочерний шаблон (template) к существующему по его ID с одним из следующих типов: inner, before, after.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
id | String | Да | Нет |
template | String | Да | Нет |
script | String | Нет Для настройки параметра type этот параметр является обязательным. Если параметр script не используется, используйте (''), как показано в примере ниже. | Нет |
type | String | Нет | inner Возможные варианты: inner, before, after. |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
<div id="steps"></div>
s_widget.addTemplate('steps', '<div class="main">', '', 'inner');
s_widget.getElements()
Используйте данный метод, чтобы вернуть массив элементов структуры виджета.
Возвращаемое значение:
Тип | Описание |
---|---|
Array of <elements> | Элементы структуры виджета, собранные в массив. |
Пример:
s_widget.getElements();
s_widget.getFieldValue(key)
Используйте этот метод для получения значения данных виджета, определенных ключом (key).
Параметр:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
key | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Any | Значение поля, определённого указанным ключом. |
Пример:
s_widget.getFieldValue('element');
s_widget.getId()
Используйте данный метод для возращения ID экземпляра виджета.
Возвращаемое значение:
Тип | Описание |
---|---|
String | Метод возвращает ID экземпляра виджета. |
Пример:
s_widget.getId();
s_widget.getOptionValue(key)
Используйте данный метод для получения значения value, заданного в опции ключа (key).
Параметр:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
key | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Any | Значение опции виджета, определенной ключом. |
Пример:
s_widget.getOptionValue('label');
s_widget.removeTemplate(id)
Используйте данный метод, чтобы удалить все дочерние узлы и содержимое указанного элемента. Сам элемент и его атрибуты при этом сохраняются.
Параметр:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
id | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
<div id="element1"> Убрать </div> <button buttonType="approve" event-click="window.s_widget_custom.remove();"> Добавить </button>
#element1 { background-color: yellow; height: 20px; }
; (() => { window.s_widget_custom = window.s_widget_custom || {}; window.s_widget_custom.remove = function () { s_widget.removeTemplate('element1'); } })();
s_widget.setFieldValue(key, value)
Используйте этот метод, чтобы задать значение (value) для ключа (key).
Если задаваемое значение равно null, например, s_widget.setFieldValue
('subject', null)
, заданное поле будет очищено.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
key | String | Да | Нет |
value | Any | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
; (async () => { const tableName = s_form.getTableName(); const recordId = s_form.getUniqueValue(); const serviceId = s_form.getValue('service'); const serviceDisplayValue = s_form.getDisplayValue('service'); s_widget.setFieldValue('table_name', tableName); s_widget.setFieldValue('record_id', recordId); s_widget.setFieldValue('service', { database_value: serviceId, display_value: serviceDisplayValue }); await s_widget.serverUpdate(); })();
s_widget.serverUpdate()
Этот метод переносит данные на сервер, где выполняется серверный скрипт виджета, в результате чего обновляются его данные.
Возвращаемое значение:
Тип | Описание |
---|---|
Object | Метод возвращает объект Promise, содержащий ответ сервера. |
Пример:
; (async () => { const tableName = s_form.getTableName(); const recordId = s_form.getUniqueValue(); s_widget.setFieldValue('table_name', tableName); s_widget.setFieldValue('record_id', recordId); const response = await s_widget.serverUpdate(); console.log(response.getData().data); })();
s_widget.setOptionValue(key, value)
Используйте этот метод, чтобы задать значение (value) для ключа (key) опций виджета.
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
key | String | Да | Нет |
value | Any | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_widget.setOptionValue('label', 'название');
s_widget.showData()
Используйте этот метод для отображения данных виджета в консоли.
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_widget.showData();
SimpleWidgets
s_widgets
Вызывайте методы у глобального объекта s_widgets в своих скриптах при добавлении виджета на форму или страницу для взаимодействия с виджетом.
s_widgets.getFieldValue(widgetInstanceID, key)
Данный метод возвращает значение из данных виджета для ключа (key) и ID экземпляра виджета (widgetinstanceID).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
widgetInstanceID | String | Да | Нет |
key | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Any | Возвращает значение объекта. |
Пример:
s_widgets.getFieldValue('157555401214600424', 'name');
s_widgets.getForm()
Данный метод возвращает объект формы, размещенный при помощи тега <Form> или <remform>.
Параметр:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
name | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Object | Метод возвращает объект SimpleForm. |
Пример:
const builtInForm = s_widgets.getForm('custom'); await builtInForm.save();
s_widgets.getWidgets()
Этот метод возвращает список ID всех экземпляров виджетов на странице.
Возвращаемое значение:
Тип | Описание |
---|---|
Array | Список ID всех экземпляров виджетов на странице. |
Пример:
s_widgets.getWidgets();
s_widgets.setFieldValue(widgetInstanceID, key, value)
Используйте данный метод, чтобы задать значение (value) для ключа (key) в данных виджета и ID экземпляра виджета (widgetinstanceID).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
widgetInstanceID | String | Да | Нет |
key | String | Да | Нет |
value | Any | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
s_widgets.setFieldValue('157555401214600424', 'name', 'Александр');
- No labels