Methods
-
<static> createData(name, data, filter)
-
Create new data and set a variable to it
Parameters:
Name Type Argument Description name
string Name of the variable
data
* Data to set
filter
string <optional>
Url of the filter to use with this variable
-
<static> doAction(name, value)
-
Send an action to all modules that are listening to it
Parameters:
Name Type Argument Description name
string Action name
value
* <optional>
Action value
-
<static> executeAction(name, value)
-
Execute a global visualizer action
Parameters:
Name Type Description name
string Action name
value
* Action value
-
<static> existVariable(varName) → {boolean}
-
Check if a variable is defined
Parameters:
Name Type Description varName
string Name of the variable
Returns:
- Type
- boolean
-
<static> getVariable(name) → {Variable}
-
Get a variable by name
Parameters:
Name Type Description name
string Name of the variable
Returns:
- Type
- Variable
-
<static> loading(id, message)
-
Set a loading message or change the value of an existing message
Parameters:
Name Type Argument Description id
string ID of the message
message
string <optional>
Message content (default: value of the ID)
-
<static> setHighlight(element, onOff)
-
Change the state of a highlight
Parameters:
Name Type Description element
object | array Object with a _highlight property or array of highlight IDs
onOff
boolean -
<static> setVariable(name, sourceVariable, jpath, filter)
-
Set a variable using a jpath
Parameters:
Name Type Argument Description name
string Name of the variable
sourceVariable
Variable <optional>
Source variable. If set, the new variable will be created relative to its jpath
jpath
string[] filter
string <optional>
Url of the filter to use with this variable
-
<static> stopLoading(id)
-
Remove a loading message
Parameters:
Name Type Description id
string ID of the message