You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 5 Next »
s_widget is an object of the SimpleWidget class initialized within a widget you create.
s_widgets is an object of the SimpleWidgets class initialized when you add a widget to a form or a portal page.
The widget API describes the methods for widget structure and functionality customization:
- Use s_widget and s_widgets methods in client-side scripts to implement the widget functionality required.
- To create your own widget methods, use the custom method functionality.
These methods can be used on the client-side only.
s_widget
To perform the current widget customization, 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.
Parameters:
Name | Type | Mandatory | Default Value |
---|---|---|---|
id | String | Y | N |
template | String | Y | N |
script | String | N This parameter is mandatory if you need to define the type parameter. If no script is needed, use an empty string ('') as in the example below. | N |
type | String (possible options: inner, before, after) | Y | inner |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
<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:
Type | Description |
---|---|
array<elements> | The widget structure elements are collected in an array. |
Example:
window.s_widget.getElements();
s_widget.getFieldValue(key)
Use this method to return the widget field value defined by the key option.
Parameter:
Name | Type | Mandatory | Default Value |
---|---|---|---|
key | String | Y | N |
Return:
Type | Description |
---|---|
mixed | The value of the field is defined by the key defined. |
Example:
s_widget.getFieldValue('element');
s_widget.getForm()
This method returns a form object that is placed using the <Form> or <remform> tags.
Parameter:
Name | Type | Mandatory | Default Value |
---|---|---|---|
name | String | Y | N |
Return:
Type | Description |
---|---|
Object | This method returns a SimpleForm object. |
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:
Type | Description |
---|---|
String | This method returns a widget instance ID. |
Example:
s_widget.getId();
s_widget.getOptionValue(key)
Use this method to return a widget option value defined by the key option.
Parameter:
Name | Type | Mandatory | Default Value |
---|---|---|---|
key | String | Y | N |
Return:
Type | Description |
---|---|
mixed | The value of the widget options is defined by the key. |
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):
Name | Type | Mandatory | Default Value |
---|---|---|---|
id | String | Y | N |
Return:
Type | Description |
---|---|
Void | This method does not return a value. |
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)
Use this method to set 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.
Parameters:
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()
Use this method to transfer widget data to a server script and to update 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)
Use this method to set a widget option value using the key option.
Parameters:
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.
Parameters:
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 a list of all the widget instance IDs of the page.
Return:
Type | Description |
---|---|
Array | A list of all the widget instance IDs of the page. |
Example:
s_widgets.getWidgets();
s_widgets.setFieldValue(widgetInstanceID, key, value)
Use this method to set a field value using the key and the widget instance ID.
Parameters:
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