Page History

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.

s_widget

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

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: inner, before, after.

Parameter(s):

Return:

Example:

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

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

s_widget.getElements()

This method returns the structure element structure of a widget.

Return:

Example:

window.s_widget.getElements();

s_widget.getFieldValue(key)

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

Parameter(s):

Return:

Example:

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:

Example:

s_widget.getId();

s_widget.getOptionValue(key)

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

Parameter(s):

Return:

Example:

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:

Example:

<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 the a value using the key.

Parameter(s):

Return:

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:

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 the a widget option option value using the key option.

Parameter(s):

Return:

Example:

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

s_widget.showData()

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

Return:

Example:

s_widget.showData();

s_widgets

Invoke the s_widgets methods within your scripts, when adding a widget to a form, a page or for widgets interaction.

s_widgets.getFieldValue(widgetInstanceID, key)

This method returns the objectvalue using the key and widget instance ID.

Parameter(s):

Return:

Example:

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

s_widgets.getWidgets()

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

Return:

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

Return:

Example:

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

Anchor
Custom method Custom method

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