Module

Common_Functions_ListWidgets

Methods

# inner getList()

Returns the content of a list.

# inner getListVariableName() → {string}

Returns the variable name of a variable-based list widget.
string

# inner getSelectedLabel() → {string}

Returns the label selected by the connected user.
string

# inner getSelectedValue() → {string}

Returns the value selected by the connected user. This does not work with multi-selection lists.
string

# inner loadList(url)

Sets the URL field of the list widget.
Parameters:
Name Type Description
url string List URL

# inner reset()

Resets a list selection to empty.

# inner setListVariableName(name)

Sets the variable name of a variable-based list widget.
Parameters:
Name Type Description
name string Name to be assigned to the variable

# inner setPicked(label, value)

Sets the picked item.
Parameters:
Name Type Description
label string Label to set
value string Value to set

# inner setPostLoadedScript(callBK)

Sets the callback function that is to be executed just before loading the list of the widget.
Parameters:
Name Type Description
callBK module:Common_Functions_ListWidgets~callbackFunction Callback that handles the post loaded script field

# inner setSelectedLabel(label)

Sets the label (value) which is displayed to the connected user.
Parameters:
Name Type Description
label string Label to set

# inner setSelectedValue(value)

Sets the value (label) which is displayed to the connected user.
Parameters:
Name Type Description
value string Value to set

# inner setVariableValue(varName, varValue)

Sets the value of a given variable of the widget.
Parameters:
Name Type Description
varName string Name of the variable
varValue string Value to be assigned to the variable

Type Definitions

# callbackFunction()

Callback function to handle the `post loaded script` field of a list-based widget.