You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
s_widget это объект класса SimpleWidget, который инициализируетя внутри виджета при создании.
s_widgets это объект класса SimpleWidgets, который инициализируется при добавлении виджета на форму или на страницу портала.
API виджетов описывает методы настройки структуры и функциональности виджетов:
- Используйте методы s_widget и s_widgets в клиентских скриптах для добавления необходимой функциональности виджетов.
- Для создания пользовательских методов используйте custom method functionality.
Эти методы могут быть использованы только на стороне клиента.
s_widget
Используйте нижеописанные методы для того, чтобы выполнить пользовательскую настройку текущего виджета.
Manual console invoke
Для того чтобы вручную вызвать метод в консоли, передайте ID экземпляра виджета в первом параметре. Например, чтобы вызвать метод:
s_widget.getFieldValue(key);
используйте следующий метод:
s_widget.getFieldValue(widgetId, key);
s_widget.addTemplate(id, template, script, type)
Этот метод добавляет дочерний шаблон к существующему по его ID с одним из следующих типов: inner, before, after.
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
id | String | Д | Н |
template | String | Д | Н |
script | String | Н Для настройки параметра type этот параметр является обязательным. Если параметр script не используется, используйте (''), как показано в примере ниже. | Н |
type | String (возможные варианты: inner, before, after) | Y | inner |
Возврат:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
<div id="steps"></div>
s_widget.addTemplate('steps', '<div class="main">', '', 'inner');
s_widget.getElements()
Данный метод возвращает элемент виджета structure.
Возврат:
Тип | Описание |
---|---|
array<elements> | Элементы структуры виджета, собранные в массив. |
Пример:
window.s_widget.getElements();
s_widget.getFieldValue(key)
Используйте этот метод для получения значения поля виджета, определенного опцией key.
Параметр:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
key | String | Д | Н |
Возврат:
Тип | Описание |
---|---|
mixed | Значение поля определенное указанным ключом. |
Пример:
s_widget.getFieldValue('element');
s_widget.getForm()
Данный метод возвращает объект формы, размещенный при помощи тэга <Form> или <remform>.
Параметр:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
name | String | Д | Н |
Возврат:
Тип | Описание |
---|---|
Object | Метод возвращает объект SimpleForm. |
Пример:
const builtInForm = s_widgets.getForm('custom'); await builtInForm.save();
s_widget.getId()
Данный метод возвращает ID экземпляра виджета как значение строки.
Возврат:
Тип | Описание |
---|---|
String | Метод возвращает ID экземпляра виджета. |
Пример:
s_widget.getId();
s_widget.getOptionValue(key)
Используйте данный метод для возврата опции виджета value, определенной опцией key.
Параметр:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
key | String | Д | Н |
Возврат:
Тип | Описание |
---|---|
mixed | Значение опций виджета определено ключом. |
Пример:
s_widget.getOptionValue('label');
s_widget.removeTemplate(id)
Используйте данный метод, чтобы удалить все дочерние узлы и содержимое указанных элементов. Сами элементы и аттрибуты при этом сохраняются.
Параметр:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
id | String | Д | Н |
Возврат:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
<div id="element1"> Remove me </div> <button buttonType="approve" event-click="window.s_widget_custom.remove();"> Click me </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 | mixed | Д | Н |
Возврат:
Тип | Описание |
---|---|
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 | Метод возвращает промис, содержащий определенные данные. |
Пример:
; (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 | mixed | Д | Н |
Возврат:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_widget.setOptionValue('label', 'name');
s_widget.showData()
Используйте этот метод для отображения данных поля виджета в консоли.
Возврат:
Тип | Описание |
---|---|
Void | Данный метод не возвращает значение. |
Пример:
s_widget.showData();
s_widgets
Вызывайте метод s_widgets в своих скриптах при добавлении виджета на форму или страницу для взаимодействия с виджетом.
s_widgets.getFieldValue(widgetInstanceID, key)
Данный метод возвращает значение объекта при помощи ключа (key) и ID экземпляра виджета (widget instance ID).
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
widgetInstanceID | String (значение sys_id) | Д | Н |
key | Integer | Д | Н |
Возврат:
Тип | Описание |
---|---|
mixed | Возвращает значение объекта. |
Пример:
s_widgets.getFieldValue('157555401214600424', 'name');
s_widgets.getWidgets()
Этот метод возвращает список ID всех экземпляров виджетов на странице.
Возврат:
Тип | Описание |
---|---|
List<String> | Список ID объектов типа строка |
Пример:
s_widgets.getWidgets();
s_widgets.setFieldValue(widgetInstanceID, key, value)
Используйте данный метод для настройки значения (value) поля при помощи ключа(key) и ID экземпляра виджета (widget instance ID).
Параметры:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
widgetInstanceID | String (значение sys_id) | Д | Н |
key | Integer | Д | Н |
value | mixed | Д | Н |
Возврат:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
s_widgets.getFieldValue('157555401214600424', 'name', 'Alex');
s_widget_custom
Within the client-side scripts, you can configure your own widget methods by using the window.s_widget_custom variable:
window.s_widget_custom.updateFullname = function() { // }
- No labels