ParameterProperties interface
Properties of a HorizonDB parameter.
Properties
| allowed |
The allowed values for the parameter. |
| data |
The data type of the parameter. |
| default |
The system-defined default value of the parameter, independent of the effective value. |
| description | The description of the parameter. |
| documentation |
Link to parameter documentation. |
| is |
Whether the parameter can be changed dynamically. |
| is |
Whether the parameter is read-only. Read-only parameters cannot be overridden. |
| name | The name of the parameter. |
| unit | The unit of measurement for the parameter. |
| value | The value of the configuration. |
| value |
The source of the effective parameter value. UserOverride means that the value was explicitly supplied by the user, even when it equals defaultValue. |
Property Details
allowedValues
The allowed values for the parameter.
allowedValues?: stringProperty Value
string
dataType
The data type of the parameter.
dataType?: stringProperty Value
string
defaultValue
The system-defined default value of the parameter, independent of the effective value.
defaultValue?: stringProperty Value
string
description
The description of the parameter.
description?: stringProperty Value
string
documentationLink
Link to parameter documentation.
documentationLink?: stringProperty Value
string
isDynamic
Whether the parameter can be changed dynamically.
isDynamic?: booleanProperty Value
boolean
isReadOnly
Whether the parameter is read-only. Read-only parameters cannot be overridden.
isReadOnly?: booleanProperty Value
boolean
name
The name of the parameter.
name?: stringProperty Value
string
unit
The unit of measurement for the parameter.
unit?: stringProperty Value
string
value
The value of the configuration.
value?: stringProperty Value
string
valueSource
The source of the effective parameter value. UserOverride means that the value was explicitly supplied by the user, even when it equals defaultValue.
valueSource?: stringProperty Value
string
