Image
The image object displays an image.
The image can be specified in the Image attribute as an image file or as an icon from an icon set.
The appearance can be customized with the Fit attribute.
A label can be added with the Label attribute.
Attributes
Common
ID
Sets the object's ID.
The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.
The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.
IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dinamically attached to a set of attribute values.
E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:
Value binding:
="mybutton" + ui('button', 'address')
UISet:
UISet('button', 'address', '1') switches the ID to mybutton1
UISet('button', 'address', '2') switches the ID to mybutton2
Position and Size
Position
Sets the object's position.
The default value is: x0y0.
Attribute Values
| Value | Description | Example |
|---|---|---|
| x<left>y<top> | Specify left/top coordinates in pixels. | x10y20 |
Flex Grow
Specifies if the objects should grow to fill the available space.
The default value is: true.
Attribute Values
| Value | Description |
|---|---|
| true | Default value. Objects expand to fill the available space. |
| false | Objects do not grow to fill the available space. |
Flex Shrink
Specifies if the objects should shrink to fit the available space.
The default value is: true.
Attribute Values
| Value | Description |
|---|---|
| true | Default value. Objects shrink to fit the available space. |
| false | Objects do not shrink to fit the available space. |
Width
Sets the object's width in pixels.
Minimum value is 1.
Height
Sets the object's height in pixels.
Minimum value is 1.
Image
Image
Specifies an image to show.
Attribute Values
| Value | Description |
|---|---|
| <image> | Path to the image file. Files are searched inside the project's directory first, then inside the www/img directory. |
Fit
Specifies how the image should be resized to fit its container.
The default value is: contain.
Attribute Values
| Value | Description |
|---|---|
| fill | The image is resized to fill the given dimension. If necessary, the image will be stretched or squished to fit. |
| contain | Default value. The image keeps its aspect ratio, but is resized to fit within the given dimension. |
| cover | The image keeps its aspect ratio and fills the given dimension. The image will be clipped to fit. |
| none | The image is not resized. |
| scale-down | The image is scaled down to the smallest version of none or contain. |
Icon Color
Specifies the icon color.
Label
Label
Specifies a label.
Attribute Values
| Value | Description |
|---|---|
| <string> | Label. |
Font Family
Specifies the font family.
The default value is: default.
Font Size
Specifies the font size in pixels or percentage (relative to the project's font size).
The default value is: 14.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <integer> | Font size in pixels. | |
| <percentage>% | Relative font size in percentage. | 90% |
Font Color
Specifies the text CSS color.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <html color> | Color in any html accepted format. | #ff0000 |
Font Weight
Specifies the weight of the font.
The default value is: normal.
Attribute Values
| Value | Description |
|---|---|
| normal | Default value. Normal. |
| bold | Bold. |
| bolder | Bolder. |
| lighter | Lighter. |
Italic
Show the text in italics.
The default value is: false.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Normal. |
| true | Italics. |
Small Caps
Sets the font to small caps.
The default value is: false.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Normal. |
| true | Small caps. |
Decoration
Specifies the text decoration.
The default value is: none.
Attribute Values
| Value | Description |
|---|---|
| none | Default value. No decoration. |
| underline | Underline. |
| overline | Overline. |
| line-through | Line through. |
Text Align
Sets the horizontal alignment of the text.
The default value is: none.
Attribute Values
| Value | Description |
|---|---|
| none | Default value. No alignment. |
| left | Left alignment. |
| right | Right alignment. |
| center | Center alignment. |
| justify | Justified alignment. |
Line Height
Sets the line height of the text.
The default value is: 1.0.
Attribute Values
| Value | Description |
|---|---|
| <float> | Specify the line height as a multiple of the font size. |
Label CSS
This attribute has been deprecated since ver. 4.0
Tooltip
Specifies a tooltip text that appears on mouseover, after a small delay.
Attribute Values
| Value | Description |
|---|---|
| <string> | Tooltip text. |
Action
Action
Specifies the action performed when clicked/tapped.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| none | No action. |
| link | Changes page, shows a popup or opens a URL. |
| command | Sends a command to the server, with the specified name and parameter. |
| datapoint | Toggles a datapoint. |
| download | Fires a download file request that generates a specific command. A server-side userCommand script must intercept the command. If the content to be downloaded is an existing file, it should return a full pathname of the file to be downloaded, or a JSON object such as {"path":"pathname", "filename":"filename", "delete":true}, where path is the full pathname of the file to be downloaded and filename is the name of the file to be saved on the client. Delete is optional. When present and set to true, the file is deleted as soon as the download is initiated from the client.If the returned pathname is a valid and accessible file under the HSYCO main directory, the download will be initiated. It is also possible to generate the binary content to be downloaded directly from the userCommand script. In this case userCommand should return a JSON object like {"data":"&<Base64-encoded data&>", "filename":"filename"} where data is a Base64-encoded string of the binary data to be downloaded. |
| upload | Shows the upload file popup. A server-side uiSet (not a scope uiSet) must be executed to allow the upload and specify the upload path: uiSet("<object ID>", "path", "<upload path>")* name: the object ID * upload path: the path where the uploaded files are saved, relative to the HSYCO main directory When the upload is completed, a command is generated with: * name: the object ID * parameter: the uploaded file name, including the extension. |
| submit | Sends the values of all the fields within the button's container to the server. If not in a container, it submits all fields from the page. In overlay pages, if the button is not inside a container, it submits fields from the current page as well. Fields inside nested containers are included in the submissions. When submitting, if a field is not valid, it will be focused and the action will be canceled. |
| timer | Opens a timer's details. |
| tab | Shows a specified container and hides the other of the same group. |
| camera-link | Opens a page with the specified camera address. |
| docs-link | Opens the documentation page with the specified root and path. |
| slider | Opens a slider popup. |
| menu | Opens a popup menu. |
| logout | Immediately logs out the user. |
Link
Specifies a page, navigation command or external URL to follow.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <Page ID> | The page ID. | |
| <URL> | A url starting with "http://", "https://", "ftp://" or "www.". | |
| back | Navigate backward in browsing history. | |
| forward | Navigate forward in browsing history. | |
| close | Closes the last opened popup. | |
| close-all | Closes all open popups. | |
| <comma-separated list> | Consequently opens a list of links. Useful for example to open multiple modals in sequence, or to open a page and then a popup. | close-all,mymodal |
Link Target
Specifies where to open the linked URL. Available only for URL links.
The default value is: _self.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| _self | Default value. Opens the linked URL in the same window or tab. |
| _blank | Opens the linked URL in a new window or tab. |
| <string> | Opens the linked URL in a named window or tab. Use this to open multiple links in the same window or tab. |
Datapoint
Specifies a datapoint, to display and control its status.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| [datapoint address] | The datapoint address. | dummy.dimmer.1 |
Name
Specifies the command name that is sent to the server.
If the name starts with $, then the server will automatically set a variable with the same name as the command, containing the command's parameter.
The default value is: =id.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | A command name. | |
| $[variable name] | A command name that sets a variable. | $myvar |
| $[variable name]! | A command name that sets a persistent variable. | $myvar! |
Parameter
Specifies the command parameter that is sent to the server.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| <string> | A command parameter. |
Repeat
If enabled, the command will be repeated every second. Instead of a single command on the button press event, multiple commands are sent with the following suffixes:
<command name>/down: on mouse down or touch down events<command name>/repeat: if the button is still pressed, a repeat command is sent every second<command name>/up: on mouse up or touch up events, for a short press (less than a second, so no repeat commands have been sent yet)<command name>/stop: on mouse up or touch up events, for a long press (more than a second, so at least a repeat command has been sent)
The default value is: false.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Repeat mode is disabled. |
| true | Repeat mode is enabled. |
Path
Specifies the path where uploaded files are saved. If this attribute is not set, the upload has no effect (no files saved on the server).
For security reasons, this UISET must be executed on the server-side code (EVENTS, JavaScript or Java). A client-side UISET would be ignored.
This attribute has been deprecated since ver. 4.0
This attribute is live. It can't be set from the Project Editor, it needs to be set dynamically with a UISet.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | Path. | .tmp |
Multiple
Specifies wether multiple files can be selected.
The default value is: false.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Single file selection. |
| true | Multiple file selection. |
Accept
Specifies the types of files that the server accepts.
The default value is: [any].
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| [empty] | No restrictions. | |
| <comma-separated list> | File extensions. | .jpg,.png,.gif |
Preview
Specifies wether a preview step is displayed.
The default value is: false.
This attribute has been deprecated since ver. 4.0
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. No preview. |
| true | Preview. |
Camera
Specifies a camera, to display its live video stream.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <camera address> | The camera address. | dummy.camera.1 |
Target Camera
Specifies a target camera object, to display the camera live video stream.
If not specified, a default camera object is displayed in a popup.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| [empty string] | The camera is displayed in a popup. | |
| <Container ID> | The container object's ID. | mycontainer |
Docs Target
Specifies a target docs object, to display the documentation.
If not specified, a default docs object is displayed in a popup.
The default value is: default.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| default | Default value. The documentation is displayed in a popup. | |
| <Docs ID> | The docs object's ID. | mydocs |
Doc Type
Specifies the type of documentation.
The default value is: project.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| project | Default value. Project documentation. |
| hsyco | HSYCO documentation. |
| projects | All projects documentation. |
| objects | Custom objects documentation. |
Docs Root Path
Root path of the documentation.
If left empty it loads all the project documentation.
If a path is specified it loads the documentation from that path.
The path is relative to the project docs directory: www/projects/<project id>/docs.
The contents of the docs directory are merged with the common docs directory: www/docs.
The common docs should include documentation that is shared among multiple projects, while project-specific docs should be placed in the project's docs directory.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | Path. | my/sub/dir |
Docs Path
Current path of the docs file displayed, following the same directory structure as the root path.
Can contain an anchor to a specific section of the document, using the format path#anchor.
Each heading in the document has an anchor with an id equal to the heading text in lowercase, with no spaces.
E.g. My Heading becomes #myheading.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | Path. | projects/home |
Index
Specifies wether the index is displayed.
The default value is: toggle.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| true | Visible. |
| false | Hidden. |
| toggle | Default value. User can toggle visibility. |
| toggle-false | User can toggle visibility, but it's hidden by default. |
TOC
Specifies wether the table of contents is displayed.
The default value is: toggle.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| true | Visible. |
| false | Hidden. |
| toggle | Default value. User can toggle visibility. |
| toggle-false | User can toggle visibility, but it's hidden by default. |
Breadcrumbs
Specifies wether the breadcrumbs are displayed.
The default value is: true.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| false | Hidden. |
| true | Default value. Visible. |
Timer
Specifies a timer, to display its details and command it.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <timer address> | The timer address. | dummy.timer.1 |
Target Container
Specifies a target container, to display its content.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <container ID> | The container ID. | dummy.container.1 |
Tab Group
Specifies the tab group to which the tab belongs.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| <string> | The tab group name. |
Slider Action
Specifies the action to perform when the slider is moved.
The default value is: none.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| none | Default value. No action. |
| command | Sends a command. |
| datapoint | Sets a datapoint value. |
| dmx | Sets a DMX value. |
Slider Orientation
Specifies the orientation of the slider.
The default value is: horizontal.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| horizontal | Default value. Horizontal. |
| vertical | Vertical. |
Slider Display Value
Specifies if the slider value is displayed.
The default value is: false.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| false | Default value. The slider value is not displayed. |
| true | The slider value is displayed. |
Slider Name
Specifies the name of the command to send.
The default value is: =id.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| <string> | A command name. |
Slider Address
Specifies the address of the DMX to set.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| <string> | A DMX address. |
Slider Datapoint
Specifies the datapoint to set.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| <datapoint address> | A datapoint address. |
Menu Items
Specifies the menu items.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| <json> | Menu item. |
Feedback
If feedback is enabled, when the action is performed, a loader is displayed until the server responds.
Also the action can't be performed again until the server responds.
The default value is: false.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Feedback is disabled. |
| true | Feedback is enabled. |
Confirm
Requires a confirmation before performing the action.
The default value is: false.
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description |
|---|---|
| false | Default value. No confirmation, the action is performed right away. |
| doubleclick | A second click (or touch or enter key) is required to confirm the action. |
| popup | A popup is displayed to ask for confirmation. |
Confirm Message
The confirmation message to be displayed if the "confirm" attribute is set to "popup".
This attribute has been deprecated since ver. 4.0
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | The message to be displayed in the confirm popup. | Are you sure? |
States
Specifies attribute values for each datapoint state value.
This attribute has been deprecated since ver. 4.0
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
View
Visible
Sets the object's visibility.
The default value is: true.
Attribute Values
| Value | Description |
|---|---|
| true | Default value. Visible. |
| false | Hidden. |
Enabled
Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.
The default value is: true.
Attribute Values
| Value | Description |
|---|---|
| true | Default value. Enabled. |
| false | Disabled. |
Blink
Blinks the object at the specified speed.
The default value is: false.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Not blinking. |
| slow | Blinks slowly. |
| fast | Blinks fast. |
Transition
Specifies the transition effect when the object is shown or hidden.
The default value is: none.
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Attribute Values
| Value | Description |
|---|---|
| none | Default value. No transition. |
| fade | Fade in/out. |
| fade-left | Slide from left and fade in/out. |
| fade-right | Slide from right and fade in/out. |
| fade-up | Slide from top and fade in/out. |
| fade-down | Slide from bottom and fade in/out. |
| slide-left | Slide from left. |
| slide-right | Slide from right. |
| slide-up | Slide from top. |
| slide-down | Slide from bottom. |
| zoom-in | Zoom in. |
| zoom-out | Zoom out. |
| 3d-flip-left | 3D flip from left. |
| 3d-flip-right | 3D flip from right. |
Transition Duration
Specifies the transition duration in milliseconds.
The default value is: 300.
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Attribute Values
| Value | Description |
|---|---|
| <integer> | Duration in milliseconds. |
Transition Delay
Specifies the transition delay in milliseconds.
The default value is: 0.
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Attribute Values
| Value | Description |
|---|---|
| <integer> | Delay in milliseconds. |
Opacity
Sets the object's opacity. Opacity is the degree to which content behind an object is hidden.
The default value is: 1.0.
Attribute Values
| Value | Description |
|---|---|
| 0 | The object is fully transparent. |
| >0.0, <1.0 | The object is translucent (content behind the element can be seen). |
| 1.0 | Default value. The object is fully opaque. |
Rotation
Specifies the degrees by which the object is rotated. A positive number rotates it clockwise, while a negative value rotates it counter-clockwise.
The default value is: 0.
CSS Class
Specifies a CSS Class that applies to the object, useful to customize its appearance. Custom CSS Classes are specified within the custom.css file.
Margin
Specifies the margin of the object. The margin is the space outside the object's border.
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <int> | Specify the margin in pixels for all sides of the object. | |
| <top> <right> <bottom> <left> | Specify the margin in pixels for each side of the object. | 10 20 30 40 |
View Scale
Specifies the scale of the object. The scale is the ratio between the object's size and the size of the view it is contained in.
The default value is: 1.0.
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Attribute Values
| Value | Description |
|---|---|
| <float> | Specify the scale for both width and height of the object. |
Meta
Comment
Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.
This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.
Exclude
Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.
The default value is: false.
This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.
Attribute Values
| Value | Description |
|---|---|
| false | Default value. Object is included in the UI. |
| true | Object is excluded from the UI. |