Documentation
CheckBox
Creates a checkbox.
If created in the "elements" area, the checkbox sets a property to True or False when accepted.
The parameter "name" defines which property is set.
Parameters
| Parameter | Description |
|---|---|
| caption | visible caption |
| download (optional) | (default: "") If this parameter is not an empty string and the output of the onChange script is a Data-URL, the output is downloaded as a text file with the name of the download parameter. (since IP-Symcon 7.0) |
| enabled (optional) | (default: true) If true, the CheckBox can be used, otherwise it is displayed as deactivated (since IP-Symcon 5.2) |
| link (optional) | (default: false) If this parameter is true, the output of the onChange script is opened as a link. If it is false, the output is displayed as a dialog in the configuration form. (since IP-Symcon 6.0) |
| name (optional) | Name of the checkbox/the property to be set |
| onChange (optional) | (default: "") Script, which is executed with a click when the checkbox is changed. If the script consists of several lines, the individual lines can also be defined as an array (arrays are supported since version 6.0). It has the same properties as onClick of the Button (since IP-Symcon 5.2) |
| type | CheckBox |
| value (optional) | (default: false) The value of the CheckBox - If there is an associated property, this parameter is overwritten by the property in the elements area (since IP-Symcon 5.2) |
| visible (optional) | (default: true) If true, the CheckBox is visible, otherwise it is invisible (since IP-Symcon 5.2) |
| width (optional) | Fixed width of the checkbox in pixels or % as a string, e.g. "40%" or "250px". If the value is not set or "", the width is automatically selected based on the caption (since IP-Symcon 5.3) |
Example
{ "type": "CheckBox", "name": "status", "caption": "emulate Status" }