configure
Perform a configuration.
Signatures
- Paramate.Configurator.configure(changes, callback = undefined, undoable = true)
Details
The function requests the configurator parameters and updates the controls with them. If the configuration fails, the parameters are set back to their last valid values, unless the onConfigureError event handler is defined and is not returning true.
Parameters
- changes
-
An object specifing the changes to be applied, e.g.
{
<paramName>: // name of the configurator parameter
{
value: <string> // value for the configurator parameter
},
...
}
- callback
-
Function to be called with the new configurator parameters object as argument.
- undoable
-
The configuration changes the undo history default: true.
Return value
The new configurator parameters object:
{
<paramName>: // string: name of the configurator parameter
{
changed: ..., // bool: flag whether the parameter was changed
default: ..., // string: default value
descr: ..., // string: description
min: ..., // number: minimum value
max: ..., // number: maximum value
name: ..., // string: parameter title
type: ..., // string: type of the parameter
used: ..., // bool: flag whether the parameter was used in the current configuration
value: ... // string: the current value
},
...
}
