Page History

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

• Используйте методы объекта

• s_widget

• класса SimpleWidget

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

• s_widgets

• класса SimpleWidgets

• для добавления необходимой функциональности. Объект инициализируется при добавлении виджета на форму или на страницу портала.

The widget API describes methods and custom method declarations for widget structure and functionality customization:

• Use

  Для создания пользовательских методов используйтеs_widget

  and s

  _

  widgets methods in client-side scripts to implement the widget functionality you need.If you need to create your own widget methods, use the

  custom

  method functionality

  .

  Info
  Эти методы могут

• быть использованы только на стороне

• клиента.

  
  

SimpleWidget

s_widget

To perform the current widget customization you created, use the methods below.

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

s_widget.getFieldValue(key); 

s_widget.getFieldValue(widgetId, key);

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

This method adds a child template to the existing template by its ID with one of the following typesИспользуйте метод для добавления дочернего шаблона (template) к существующему по его id с одним из следующих типов: inner, before, after.

Parameter(s):

Параметры:

Return:

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

Пример

:

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

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

s_widget.getElements()

This method returns the structure element of a widget.

Return:

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

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

Пример

:

window.s_widget.getElements();

s_widget.getFieldValue(key)

Use this method to return the widget field value defined by the key option.

Parameter(s):

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

Параметр:

Return:

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

Пример

:

s_widget.getFieldValue('element');

s_widget.getForm()

This method returns a form object that is placed using the <Form> or <remform> tags.

Parameter(s):

Return:

Example:

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

s_widget.getId()

This method returns a widget instance ID as a string value.

Return:

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

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

Пример

:

s_widget.getId();

s_widget.getOptionValue(key)

Use this method to return a widget option value defined by the key option.

Parameter(s):

Используйте метод для получения значения value, заданного в опции ключа (key) из Опций схемы виджета.

Параметр:

Return:

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

Пример

:

s_widget.getOptionValue('label');

s_widget.removeTemplate(id)

The method removes all child nodes and content from the specified elements. It does not remove the element itself or its attributes.

Parameter(s):

Return:

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

Параметр:

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

Пример

:

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

This method sets a value using the keyИспользуйте этот метод, чтобы задать значение (value) для ключа (key).

Parameter(s):

Параметры:

Return:

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

Пример

:

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

This method transfers widget data to a server script and updates widget data according to the server reply.

Return:

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

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

Пример

:

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

This method sets a widget option value using the key option.

Parameter(s):

Используйте этот метод, чтобы задать значение (value) для ключа (key) опций виджета.

Return:

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

Пример

:

s_widget.setOptionValue('label', 'nameНаименование');

s_widget.showData()

The method displays the field data of a widget in the console. 

Return:

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

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

Пример

:

s_widget.showData();

SimpleWidgets

s_widgets

Invoke the s_widgets methods within your scripts, when adding a widget to a form or a page for widget interactionВызывайте методы у глобального объекта s_widgets в своих скриптах при добавлении виджета на форму или страницу для взаимодействия с виджетом.

s_widgets.getFieldValue(widgetInstanceID, key)

Метод возвращает значение из данных виджета для ключа (key) и ID экземпляра виджета (widgetinstanceID).

Параметры:

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

Пример

Parameter(s):

Return:

:

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

s_widgets.getForm()

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

Параметр:

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

Пример:

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

s_widgets.getWidgets()

This method returns all the widget instance IDs of the page.

Return:

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

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

Пример

:

s_widgets.getWidgets();

['160767740511016793', '160767742115787725', '160767742915897037', '160767743612372124', '158965632914393037', '158965975317960937', '161062077113210360']

s_widgets.setFieldValue(widgetInstanceID, key, value)

This method sets the value using the key and the widget instance ID.

Parameter(s):

Return:

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

Параметры:

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

Пример

:

s_widgets.getFieldValuesetFieldValue('157555401214600424', 'name', 'AlexАлександр');

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() {
  //
}