Component Functions
Widget component functions are functions specific to a widget component or container. You may use component functions to invoke a component functionality without involving user interaction.
Just like component events, component functions are called from widget bindings.
Calling Widget Component Functions
You can call widget component functions from widget bindings using the form/ schema.
To do so, specify the function as a binding target and construct a table with function parameters in the binding expression.
Target |
|
Expression | An expression that evaluates to a table with function parameters. |
Activator | Any valid binding activator. |
Another way to call component functions is through binding expressions. You can use this method if you want to use the output of a component function. Like other functions, component functions output Data Tables. If the binding target does not accept Data Table value types, then you need to expand the expression to convert the function output to a required format.
Target | Any valid binding target. |
Expression |
|
Activator | Any valid binding activator. |
Examples
The following example demonstrates a binding that executes the showPopup() function of the Root Panel container. This function displays another widget as a popup. The table specified in the customProperties field will be passed to the displayed widget as a default data table. The component name is omitted in the binding target because the root panel is the root container of the widget.
Target |
|
Expression |
|
Activator |
|
Condition | |
Options |
|
The following example demonstrates a binding that executes the getLayoutsNames() function of the Graph component. This functions returns a list of all available graph layouts. The target of this expression is a data table displayed by a Data Table Editor component. It displays the output table returned by the component function.
Target |
|
Expression |
|
Activator |
|
Condition | |
Options |
|
Was this page helpful?