ID |
Integer |
The ID of the parameter. |
ParameterName |
String |
The name of the parameter. |
InfoSubText |
String |
The parameter description. |
IsMonitored |
Boolean |
Whether the value of the parameter is being monitored by an alarm template. |
IsNumerical |
Boolean |
Whether the value of the parameter is numerical. |
HasRange |
Boolean |
Determines whether the value of the parameter is defined within a certain range. |
RangeLow |
Double |
If HasRange is true, this determines the lowest value of the parameter range. |
RangeHigh |
Double |
If HasRange is true, this determines the highest value of the parameter range. |
RangeLowDisplay |
String |
The display value of the raw value stored in RangeLow. |
RangeHighDisplay |
String |
The display value of the raw value stored in RangeHigh. |
Options |
String |
The parameter options (extra flags to e.g. indicate special formatting instructions). |
Unit |
String |
The unit of measure of the parameter. |
PrimaryKeyID |
Integer |
If the parameter is a table parameter, the primary key. |
DisplayKeyID |
Integer |
If the parameter is a table parameter, the display key. |
IsLogarithmic |
Boolean |
Indicates whether the trend data of this parameter should be displayed on a logarithmic scale. |
IsTableColumn |
Boolean |
Whether or not the parameter is a table column parameter. |
IsTable |
Boolean |
Whether or not the parameter is a table parameter. |
IsTrending |
Boolean |
Whether the value of the parameter is being trended. |
TableParameterID |
Integer |
If the parameter is a column parameter, this indicates the ID of the table parameter. |
Decimals |
Integer |
The number of decimals. |
Type |
String |
The type of parameter: “Read”, “Write”, or “Table”. |
WriteType |
String |
The type of write parameter: “String”, “Discreet”, “Number”, ... |
ReadType |
String |
The type of read parameter. |
Discreets |
Array of DMAParameterEditDiscreet |
The discreet values of the parameter (only if WriteType is “Discreet”). |
DashboardsType |
String |
The button panel dashboard type: None, ButtonPanel, ButtonPanelContainers or ButtonPanelCollection. |
Positions |
Array of DMAParameterPosition |
The places where the parameter can be found in the different Data Display pages of the element. |
WarningMessage |
String |
The message that, in the protocol, can be configured on the write parameter. This message will be displayed when an attempt is made to update the parameter. For example: "Changing this setting will make the device unavailable." |
AvgTrendingFilters |
Array of String |
An array of filters for which average trending is enabled (as configured in the trend template). |
RealTimeTrendingFilters |
Array of String |
An array of filters for which real-time trending is enabled (as configured in the trend template). |