You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
s_widget это объект класса SimpleWidget, который инициализируетя внутри виджета при создании.
s_widgets это объект класса SimpleWidgets, который инициализируется при добавлении виджета на форму или на страницу портала.
API виджетов описывает методы и 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.
Эти методы могут спользованы только на стороне клиента.
s_widget
To perform the current widget customization you created, use the methods below.
Manual console invoke
In the console, to manually invoke the method, pass the widget instance ID as the first parameter. For example, to call the following method:
s_widget.getFieldValue(key);
use the method instead:
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: 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)
Use this method to return the widget field value defined by the key option.
Параметр:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
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)
The method removes all child nodes and content from the specified elements. It does not remove the element itself or its attributes.
Параметр:
Название | Тип | Обязательный | Дефолтное значение |
---|---|---|---|
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)
This method sets a value using the key.
If the value parameter is equal to 'null', for example, s_widget.setFieldValue
('subject', null)
, the defined field is cleared.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
key | String | Y | N |
value | mixed | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
; (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:
Type | Description |
---|---|
Object | This method returns a promise containing specific data. |
Example:
; (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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
key | String | Y | N |
value | mixed | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
s_widget.setOptionValue('label', 'name');
s_widget.showData()
The method displays the field data of a widget in the console.
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
s_widget.showData();
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.getFieldValue(widgetInstanceID, key)
This method returns the object value using the key and widget instance ID.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
widgetInstanceID | String (the sys_id value) | Y | N |
key | Integer | Y | N |
Return:
Type | Description |
---|---|
mixed | Returns the object value. |
Example:
s_widgets.getFieldValue('157555401214600424', 'name');
s_widgets.getWidgets()
This method returns all the widget instance IDs of the page.
Return:
Type | Description |
---|---|
List<String> | A list of ID objects of the String type. |
Example:
s_widgets.getWidgets();
s_widgets.setFieldValue(widgetInstanceID, key, value)
This method sets the value using the key and the widget instance ID.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
widgetInstanceID | String (the sys_id value) | Y | N |
key | Integer | Y | N |
value | mixed | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
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