Side Bar

The side bar panel allows creating a fixed area on the left/right side of the page where elements can be placed.

Features

Configuration

Display content - controls how elements inside the side bar will be displayed:

• Absolute - positions elements at fixed coordinates inside the side bar
• Left - arranges side bar elements from the left side of the side bar
• Centered - arranges side bar elements by aligning them relative to the center of the side bar
• Right - arranges side bar elements to the right of the side bar
• Spaced evenly - distributes side bar elements across the entire width of the side bar, with equal spaces between

Stretch content - when set, it stretches the panel items to the width of the side bar

Content spacing - the margin in pixels applied to each side bar element (on all sides)

Placement - the page side where the sidebar will be placed (Left / Right)

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:

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

Border color - the color used for the side bar border.

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:

Border color - the color used for the side bar 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.

Position

Height - the height of the panel in pixels

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:

Collapse button position - if the Is collapsible option is set, it will display a button to expand/collapse the side bar. This property controls the positioning of the button

Is collapsible - toggles the display of the collapse/expand button.

Placement - the placement of the panel:

• Absolute - the component will have fixed coordinates and size
• Stretch horizontal - uses fixed vertical position and stretches the contents horizontally
• Stretch vertical - uses fixed horizontal position and stretches the contents vertically
• Stretch - stretches the contents both horizontally and vertically
• Pin left - pins the contents to the left of the page, while keeping its size
• Pin middle - pins the contents to the middle of the page, while keeping its size
• Pin right - pins the contents to the right of the page, while keeping its size
• Pin top - pins the contents to the top of the page, while keeping its size
• Pin bottom - pins the contents to the bottom of the page, while keeping its size

Offset left - the left offset when using any placement except Absolute

Offset top - the top offset when using any placement except Absolute

Offset bottom - the bottom offset when using any placement except Absolute

Offset right - the right offset when using any placement except Absolute

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