Default value of parameter, stringified.
Controls whether the parameter should be hidden in the UI.
Unique ID of parameter, stays constant each time a model gets uploaded.
Name of the parameter.
The value that corresponds to the latest successful call to ISessionApi.customize. This property will be updated immediately before ISessionApi.customize returns.
Type of parameter.
The current value.
Validation happens immediately when setting this property. An error will be thrown in case validation fails. Use isValid to test whether a value passes validation.
In case ISessionApi.automaticSceneUpdate is true, setting the value will immediately trigger a customization (see ISessionApi.customize).
Choice of parameter values for types STRINGLIST.
Number of decimal places for numeric types.
Parameter name to display instead of name.
Optional expression to be applied to value for visualisation.
List of file formats (content types) supported, used for type FILE.
Group of a parameter.
Technical hint for the UI implementation.
Step size used for domain parameters.
Maximum:
STRING.FILE.Minimum value (stringified) for numeric types.
Ordering of the parameter in client applications.
Structure of a parameter.
Description that is shown as a tooltip in the clients.
Maximum u value for two dimensional domain parameters.
Minimum u value for two dimensional domain parameters.
Optional preferred visualization for parameters of type {@link ShapeDiverResponseParameterType.FILE} and {@link ShapeDiverResponseParameterType.STRINGLIST}.
Maximum v value for two dimensional domain parameters.
Minimum v value for two dimensional domain parameters.
Evaluates if a given value is valid for this parameter.
the value to evaluate
if true, an error is thrown if validation does not pass (default: false)
Resets the value to the default value.
Resets the value to sessionValue.
Returns the current value as a string
The api for a parameter of a corresponding session.
Parameters represent the channels through which data can be input into the model represented by a session.
The current value can be changed by setting the value property.