getParams

Request the configurator parameters.

Signatures

  • Paramate.Configurator.getParams(callback = undefined)

Details

The function requests the configurator parameters and updates the params object with them.

Parameters

callback

Function to be called with the configurator parameters object as argument.

Return value

An object containing the configurator parameters:

 {
   <paramName>:        // string: name of the configurator parameter
   {
     changed: ...,     // bool: flag whether the parameter was changed
     default: ...,     // string: default value
     descr: ...,       // string: description text
     min: ...,         // number: minimum value
     max: ...,         // number: maximum value
     name: ...,        // string: parameter title
     type: ...,        // string: data type of the parameter
     used: ...,        // bool: flag whether the parameter was actively used in the current configuration
     value: ...        // string: the current value
   },
   ...
 }