« Back to Product

Documentation

Presentations

Require: IP-Symcon >= 8.0

Description

A visual overview of all presentations can be found in the Object Presentation.
The presentation of a variable can be set using the functions IPS_SetVariableCustomPresentation, RegisterVariable* and MaintainVariable. The presentation of a variable is determined by an array with the following "Key"->"Value" pairs.

Key Description
PRESENTATION The ID of the presentation to be used, formatted as GUID
TEMPLATE (optional) The ID of the template to be used, formatted as a GUID
Presentation Parameters (optional) Instead of a template, any number of parameters for a presentation can be set. The parameters are set at the same level as the PRESENTATION parameter
Warning

If a parameter is set directly, the values of the template are ignored

The available presentations corresponding to the templates are here.

Example:
The presentation of a variable is set to a slider with its own suffix when it is created.

$this->RegisterVariableFloat('Value', 'Value', [
   'PRESENTATION' => VARIABLE_PRESENTATION_SLIDER,
   'SUFFIX' => ' %'
]);

Presentations

presentation
Enumeration
Date/Time
Duration
Color
Shutter
Switch
Slider
Web Content
Value Presentation
Value Input
Any questions?