« Back to Product

Documentation

Image

Require: IP-Symcon >= 5.0

Creates an image that is displayed on the module page. The image can be specified directly or loaded from a media object.

Warning

This item is not supported by the Legacy Console. If a module with this element is opened in the legacy console, an error message appears.

Parameters

Parameter Description
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)
image (optional) Content of the image as a Data-URI (More info, cannot be combined with mediaID, either image or mediaID must be set)
link (optional) If this parameter is true, the output of the onClick script is opened as a link. If it is false, the output is displayed as a dialog in the configuration form. If the parameter is not set, a decision is made on the basis of the output whether it is opened as a link or displayed in the dialog (see info box). (since IP-Symcon 6.0)
mediaID (optional) MediaID of the displayed image or stream (since IP-Symcon 5.5) (cannot be combined with image, either image or mediaID must be set)
name (optional) Name of the image
type Image
visible (optional) (default: true) If true, the image is visible, otherwise it is invisible (since IP-Symcon 5.2)
center (optional) (default: false) If center is set, the image is centered horizontally within the displayed area, otherwise it is left-justified. This setting has no function within a RowLayout.
width (optional) Fixed width of the image 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 image (since IP-Symcon 6.0)
onClick Script that is executed when the image is clicked. If the script consists of several lines, the individual lines can also be defined as an array. It has the same properties as onClick of the Button. (since IP-Symcon 6.0)
Warning

If the parameter onClick contains an "echo" in combination with 'http'/'https', the browser is opened and the URL is called. If there is an "echo" in combination with a 'mailto:', the default mail program is opened with all the parameters set (since IP-Symcon 6.0)

Example

// Display the image base64-coded
{
     "type": "Image",
      "image": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
}

// Display image from media
{
    "type": "Image",
    "mediaID": 12345
}
Any questions?