Documentation
IPS_GetPresentation
Require: Symcon >= 8.0
array IPS_GetPresentation (string $PresentationID)
Parameters
| PresentationID | The ID of the presentation, formatted as GUID |
Returns
The following information is available as key => value pairs:
| Index | Type | Description |
|---|---|---|
| caption | string | The display name of the presentation. |
| chart | array | An array with parameters for the display of a chart (see chart table) |
| condition | array | A list of conditions that the parameters of the presentation must fulfill. |
| conversions | array | A list of statements that are used to adjust parameters for different types of variables |
| customIcon | boolean | Optional. TRUE if the presentation provides its own parameters for the icon (e.g., ICON) |
| form | array/string | The configuration form determines how the parameters can be adjusted in the variables dialog or the template manager. |
| format | array/string | The formatting of values within this presentation |
| groups | array | Optional. A list of groups with adjustments for specific variable types (see groups table) |
| id | string | The ID of the presentation, formatted as GUID |
| locale | array | The localization of the presentation |
| presentationParameters | array | A list describing the default values of the parameters of this presentation |
| presentationValue | mixed | The default value which is displayed in the presentation preview. Alternatively, it can contain PHP code as an array of strings that returns the value |
| restrictions | array | A list of restrictions that defines for which variables this presentation is available |
chart table
Each value can either be a number or the name of the parameter whose value is to be used.
| Index | Type | Description |
|---|---|---|
| min | integer/float/string | Parameter for the minimum value |
| max | integer/float/string | Parameter for the maximum value |
| stepSize | integer/float/string | Parameter for the step size |
groups table
The first group whose restrictions contain the variable type of the variable is used. Its values extend or override the values of the presentation with the same name.
| Index | Type | Description |
|---|---|---|
| id | string | The ID of the group, formatted as GUID |
| name | string | The name of the group |
| restrictions | array | Restrictions defining for which variables this group applies. The entry variableType is a list of variable types |
| presentationParameters | array | The default values of the parameters for this group |
| format | array/string | Optional. The formatting of values for this group |
| chart | array | Optional. The parameters for the display of a chart for this group |
| condition | array | Optional. Conditions that the parameters for this group must fulfill |
Description
The function returns an array with information about the variable presentation with the ID PresentationID.
Example
IPS_GetPresentation('{6B9CAEEC-5958-C223-30F7-BD36569FC57A}' /* Slider */);