Page History

API виджетов описывает методы настройки структуры и функциональности виджетов:

• Используйте методы объектов s_widget и s_widgets в клиентских скриптах виджетов для добавления необходимой функциональности.
• Для создания пользовательских методов используйте s_widget_custom.

s_widget

Используйте нижеописанные методы для того, чтобы выполнить пользовательскую настройку текущего виджета.

s_widget.getFieldValue(key); 

s_widget.getFieldValue(widgetId, key);

s_widget.addTemplate(id, template, script, type)

Этот метод добавляет дочерний шаблон к существующему по его ID с одним из следующих типов: inner, before, after.

Параметры:

Возвращаемое значение:

Пример:

<div id="steps"></div>

s_widget.addTemplate('steps', '<div class="main">', '', 'inner');

s_widget.getElements()

Данный метод возвращает элемент массив элементов структуры виджета structure.

Возвращаемое значение:

Пример:

window.s_widget.getElements();

s_widget.getFieldValue(key)

Используйте этот метод для получения значения поля виджета, определенного опцией ключом key. 

Параметр:

Возвращаемое значение:

Пример:

s_widget.getFieldValue('element');

s_widget.getForm()

Данный метод возвращает объект формы, размещенный при помощи тэга <Form> или <remform>.

Параметр:

Пример:

s_widget

.

s_widget.getId()

Данный метод возвращает ID экземпляра виджета как значение строкив виде строки.

Возвращаемое значение:

Пример:

s_widget.getId();

s_widget.getOptionValue(key)

Используйте данный метод для возврата опции виджета получения значения value, определенной опцией заданного в опции key.

Параметр:

Возвращаемое значение:

Пример:

s_widget.getOptionValue('label');

s_widget.removeTemplate(id)

Используйте данный метод, чтобы удалить все дочерние узлы и содержимое указанных элементов. Сами элементы и аттрибуты при этом сохраняются.

Параметр:

Возвращаемое значение:

Пример:

<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).

Параметры:

Возвращаемое значение:

Пример:

;
(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()

Данный метод предназначен для переноса данных виджета на серверный скрипт и обновления данных виджета после ответа сервера.

Возвращаемое значение:

Пример:

;
(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).

Параметры:

Возвращаемое значение:

Пример:

s_widget.setOptionValue('label', 'name');

s_widget.showData()

Используйте этот метод для отображения данных поля виджета в консоли.

Возвращаемое значение:

Пример:

s_widget.showData();

s_widgets

Вызывайте метод s_widgets в своих скриптах при добавлении виджета на форму или страницу для взаимодействия с виджетом.

s_widgets.getFieldValue(widgetInstanceID, key)

Данный метод возвращает значение объекта при помощи ключа (key) и ID экземпляра виджета (widget instance ID).

Параметры:

Возвращаемое значение:

Пример:

s_widgets.getFieldValue('157555401214600424', 'name');

s_widgets.getForm()

Данный метод возвращает объект формы, размещенный при помощи тэга <form> или <remform>.

Параметр:

Возвращаемое значение:

Пример:

const builtInForm = s_widgets.getForm('custom');
await builtInForm.save();

s_widgets.getWidgets()

Этот метод возвращает список ID всех экземпляров виджетов на странице.

Возвращаемое значение:

Пример:

s_widgets.getWidgets();

s_widgets.setFieldValue(widgetInstanceID, key, value)

Используйте данный метод для настройки значения (value) поля при помощи ключа(key)и ID экземпляра виджета (widget instance ID).

Параметры:

Возвращаемое значение:

Пример:

s_widgets.getFieldValue('157555401214600424', 'name', 'Alex');

Anchor
Custom method Custom method

s_widget_custom

При помощи переменной  window.s_widget_custom можно изменять настройки пользовательских методов для виджетов внутри клиентского скрипта.

window.s_widget_custom.updateFullname = function() {
  //
}