Button input component

The button is an input component that allows writing a numeric value when the button is clicked in the HMI.

Features

Configuration

This section controls the behavior of the button:

Write value - the value that will be written when the button is clicked.

note

Only numeric values are supported

Target variable - the input variable to which the value will be written.

Style

The style properties define the default look and feel of the component (i.e. no state is active or defined).

Background color - the background color of the component. A hex value can be input in one the formats:

• #RRGGBB
• #RRGGBBAA
• #RGB
• #RGBA

Where:

• R=red color component
• G=green color component
• B=blue color component
• A=alpha (transparency) component

Alternatively, the integrated color picker can be used to visually pick a color:

Text color - the color used for the component text.

Border color - the color used for the component border.

Background image - the background image. If no image is provided, the component is rendered with it's default look.

Background Size - the handling of the background image with regard to the size of the component (default is Auto):

• Auto - Displays the image without any scaling
• Cover - Stretches the image to cover the entire component
• Contain- Stretches the image to fit inside the component

Shadow - allows specifying a component shadow using the built-in shadow editor:

• X offset - the shadow horizontal offset in pixels (can be negative)
• Y offset - the shadow vertical offset in pixels (can be negative)
• Blur - the shadow blur radius. A higher value results in a blurrier shadow, while a lower value will result in a more sharp shadow.
• Color picker - the shadow color

Opacity - controls the transparency of the component.

States

This section allows defining condition-based visual states for the button. These can be used to alter the look of the button based on external factors.

States variable - the runtime variable which is used to evaluate the state. The value of this variable is compared against the value of each state to decide which is the active state. If no match is found, the component will be displayed using its default values.

Test value - this is a test value that can be used to change the active state at design time. It simulates receiving the test value as the state variable value.

States - the list of defined states. Use the green button to add a new state:

State properties

Trigger - Chooses the trigger value for the state. If set to Value, the HMI will compare the value received through the States variable against the provided numeric value. If set to Variable, it will evaluate the variable value and compare it against the States variable value. If the two values are equal, the compoent will switch to this state.

Background color - the background color of the component. A hex value can be input in one the formats:

• #RRGGBB
• #RRGGBBAA
• #RGB
• #RGBA

Where:

• R=red color component
• G=green color component
• B=blue color component
• A=alpha (transparency) component

Alternatively, the integrated color picker can be used to visually pick a color:

Image - the background image. If no image is provided, the component is rendered with it's default look.

Text color - the color used for the component text.

Border color - the color used for the component border.

Opacity - controls the transparency of the component.

note

The opacity and background alpha component both affect the transparency of the component, but have different behaviors. The opacity affects the whole component, while the background alpha affects only the background transparency.

Behavior - allows special behavior in the specified state:

• none - no special behavior (component is rendered normally)
• blink - the component will blink periodically
• disabled - the component is rendered as disabled and will not respond to mouse or keyboard interaction
• hide - the component is completely hidden

note

The hide behavior is different than using an opacity of 0. A hidden component will not receive any mouse or keyboard interaction, instead any component below it will receive them. On the contrary, a component with 0 opacity (fully transparent) still exists on the layout and will receive mouse or keyboard interactions.

Typography

The typography section contains properties that affect the text of the button:

Text - the button text label

Icon - if set, it will display an icon on the left of the button text

Font size - the size of the font used for the button text

Text align- the horizontal alignment of the button text with regard to the button border

Layout

Border width - controls the width of the border on each side. Values can be manually input as:

• <top>px <right>px <bottom>px <left>px
• <top_bottom>px <left_right>px
• <all>px

Alternatively, the built-in border editor can be used for a visual input:

Padding: Distance from the border to the inner contents in pixels.

Border radius: Border radius for the border corners. Values can be manually input as:

• <top-left>px <top-right>px <bottom-left>px <bottom-right>px
• <left>px <right>px
• <all>px

Alternatively, the built-in border radius editor can be used for a visual input:

Interactions

The interactions section allows defining color changes that take effect when the mouse cursor hovers over the component:

Hover color - the background color when the mouse cursor hovers over the component.

Hover text color - the foreground (text) color when the mouse cursor hovers over the component.

Hover border color - the border color when the mose cursor hovers over the component.

Position

The position section contains properties which affect the position and size of the component. These can be changed by dragging and resizing the component with the mouse, or directly, by manually entering the values:

Left - distance from the left edge in pixels

Top - distance from the top edge in pixels

Width - component width in pixels

Height - component height in pixels