Page History

The SimpleWidget and SimpleWidgets client-side classes provide the methods for widget structure and functionality customization:

• Use the

• s_widget

• object of the SimpleWidget class

• to implement the required functionality. The object becomes available when a widget you create is initialized.

• Use the s_widgets

• object of the SimpleWidgets class to implement the required functionality. The object is initialized when you add a widget to a form or a portal page.

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

  To create your own widget methods, use thes_widget_custom

  method functionality

  .

  Info
  These methods can only be used on the client-side

• .

  
  

SimpleWidget

s_widget

To Use the s_widget object to perform the current widget customization you created, use with the methods below.

s_widget.getFieldValue(key); 

s_widget.getFieldValue(widgetId, key);

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

This Use this method adds to add a child template to the existing template by its ID id with one of the following types: inner, before, after.

Parameters:

Return:

Example:

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

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

s_widget.getElements()

This Use this method returns to return the structure element of a widgetwidget structure elements collected in an array. The elements in the response are ordered the same way as on the page.

Return:

Example:

window.s_widget.getElements();

s_widget.getFieldValue(key)

Use this method to return the data value of the widget field value that is defined by the key option.

Parameter

:

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 Use this method returns to return a widget instance ID as a string value.

Return:

Example:

s_widget.getId();

s_widget.getOptionValue(key)

Use this method to return a widget option value the value of an option defined by the key from the widget Schema option values.

Parameter

:

Return:

Example:

s_widget.getOptionValue('label');

s_widget.removeTemplate(id)

The Use the method removes to remove all child nodes and content from the specified elementselement. 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 meAdd
</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 Use this method sets to set a value using for the key.

Parameters:

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 Use this method to transfer the data to a server, where the widget server script  and updates widget data according to the server replyruns. As a result, the widget data is updated.

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 Use this method sets to set a widget option value using the key of the widget option.

Parameters:

Return:

Example:

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

s_widget.showData()

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

Return:

Example:

s_widget.showData();

SimpleWidgets

s_widgets

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

s_widgets.getFieldValue(widgetInstanceID, key)

This Use this method returns to return the objectvalue using data value of the widget field for the key and widget instance ID.

Parameters:

Return:

Example:

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

s_widgets.

getForm()

Use this method to return a form object that is placed using the <Form> or <remform> tag.

Parameter:

Return:

Example:

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

s_widgets.getWidgets()

Use this method to return a list of all the IDs of the widgets instances located on the page. The elements in the response are ordered the same way as on This method returns all the widget instance IDs of the page.

Return:

Example:

s_widgets.getWidgets();

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

s_widgets.setFieldValue(widgetInstanceID, key, value)

This method sets the value using the key Use this method to set a value for the key in the widget data, and the widget instance ID.

Parameters:

Return:

Example:

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