Difference between revisions of "ButtonImage"

From HSYCO
Jump to navigation Jump to search
Line 8: Line 8:
  
 
== Parameters ==
 
== Parameters ==
*
+
*'''id''': the object's ID, used by UISets. Optional
 
*'''address''': device data point name. Supports [[Redirect variables]]
 
*'''address''': device data point name. Supports [[Redirect variables]]
 
*'''position''': the object's position. Use the pixels or rows and columns coordinates format
 
*'''position''': the object's position. Use the pixels or rows and columns coordinates format

Revision as of 15:20, 29 January 2020

Note  For a description and a complete list of UI Objects, see UI Objects.

Controls a light or automation device, has the same function of the button object, but you can choose custom graphic images for the different states. You can add an optional label text next to the image, and define several optional CSS attributes to control the text’s format and position. The “top” CSS attribute is used to move the text from its default position. If top is not defined, the text will be located just below the image. If defined, you can specify a positive or negative offset, in pixels. The zero offset position is at the top corner of the image; a positive offset moves the text down, a negative offset moves the text up.

If the button object is connected to a device or light that allows it, a long press on the button will open a popup with a slider. A second long press will close the popup. If specified on systemtopo.txt, it will show a thumbnail on mouse over or touch.

Parameters

  • id: the object's ID, used by UISets. Optional
  • address: device data point name. Supports Redirect variables
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • size: the image's width and height
  • unknown: image associated to the "unknown" state
  • on: image associated to the "on" state
  • off: image associated to the "off" state
  • up: image associated to the "up" state
  • down: image associated to the "down" state
  • off up: image associated to the "off up" state
  • off down: image associated to the "off down" state
  • label: the text label next to the button. Can contain HTML tags. It's optional
  • css style: the label's css style, optional. See css style


Image files are searched inside the www/<project's name>/img directory first, then inside the www/img directory.
If the filename is set with a UISet, it's possible to load an image from the web by entering the URL, or a path relative to www/<skin's name>/pic by specifying /pic/ followed by the filename


Syntax

(buttonimage <address>; <pos>; <width>; <height>; <unknown img>; <on img>; <off img>; <up img>; <down img>; <offup img>; <offdown img>; <text>; <css>)

E.g.

(buttonimage autom.1; x10y20; 200; 200; door_unknown.png; door_open.pgn; door_closed.png; ; ; ; ; Front Door; font-size:20px)

UI Attributes

Common attributes

Name Value Description
pos x<x>y<y> Position specified as x/y coordinates. E.g. x-5y10
visible true Default. Show the object
false Hide the object
blink true | slow Blink the object at a slow speed
fast Blink the object at a fast speed
false Stop the blinking
opacity 0.0 ... 1.0 Object opacity from 0 (not visible) to 1 (fully visible)
rotation 0 ... 360 Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner

Button attributes

Name Value Description
confirm false Default
true Button requires confirmation with a second click, before sending the command