Skip to main content

i4designer Knowledge Base

Symbols

Abstract

Here are the i4designer Symbols components for your new project created on the i4scada platform. Check out more details in this article.

The components available in the Symbols category of the i4designer Toolbox panel are described, individually, in the upcoming articles.

Electric symbol
Abstract

Check out this article in order to learn more details about the i4designer Electrical symbol component and the properties provided by it.

The i4designer Electric symbol component is a state-driven, icon-type extension that can represent a multitude of electric parts and components.

electric_symbol.jpg

The Electrical symbol component

Category

Property

Description

Common

Name

The name of the component, visible in other Designer locations (such as Page explorer).

Name.jpg

Object ID

Sets the Object ID of the component. By defining an object ID for the control, it can be passed as SignalPrefix when using parameter passing in navigation. The value of the Object ID can be used via a placeholder [OID] in other properties of this extension. The placeholder is supported in all signal properties, symbolic text, and states.

Example: Setpoint [OID]

object_id.jpg

Tooltip text

Optional tooltip text, that will be shown on mouseover at runtime.

tooltip.jpg

Configuration

Dialog header title

Allows the user to set the text of the dialog header title

dialog_header_title.jpg

Draggable

Sets the capability to drag the component on the page surface for both Modal and Popover behaviors. By default, the property is set to False

draggable.jpg

Page behavior

Sets the runtime behavior of the component, allowing the user to choose between Modal (modal dialog) and Popover (contextual dialog)

page_behavior.jpg

Security

System authorization/ Permission

The system authorization required to display the component. If the logged in user does not have this system authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled for all users. Further on, the user can also add multiple System authorizations / Permissions, separated by comma (,).

This property is named "System authorization" for projects created on i4scada platform.

system_authorizations.jpg

This property is named "Permissions" for projects created on i4connected platform.

permissions.jpg

Project authorization / Role

The project authorization required for displaying the component. If the logged in user does not have this project authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled to all users. Further on, the user can also add multiple Project authorizations / Roles, separated by comma (,).

This property is named "Project authorization" for projects created on i4scada platform.

project_authorization.jpg

This property is named "Role" for projects created on i4connected platform.

roles.jpg

Security access behavior

Sets the behavior of the element to either disabled (grayed out) or hidden, when the logged in user doesn't meet the conditions imposed by the Project authorization / Roles and System authorization / Permissions properties. In case both Project authorization / Roles and System authorization / Permissions properties are set, the logged user needs to meet both conditions to be able to see and utilize the component, at run-time.

security_access_behavior.jpg

Layout

Layout mode

Sets the behavior of the component related to the page placement. The user can select the component layout from the options available in the drop-down list: Default, Dock top, Dock bottom, Dock left, Dock right, Stretched, Pin top left, Pin top center, Pin top right, Pin right middle, Pin bottom right, Pin bottom center, Pin bottom left, Pin left middle and Pin center.

layout_mode.jpg

Margin

Sets the margin of the component relative to the drawing board area. The supported values are the standard CSS values for the margin.

The top, bottom, left and right values can either be typed in the main property field or by using the Margin editor.

margin_1.jpg

The Margin editor can be opened by clicking the Open button.

margin_2.jpg

The components margins can be updated by setting the margin value and selecting the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Navigation

Is external

Allows the possibility to set the link target to internal or external

If the property is set to False, a current project page can be set as a target. The user can select the project page for the Link property or manually type in the path pointing to it

is_external.jpg

Page parameters

Allows the possibility to add additional parameters for the navigation, by clicking the Add new item button

page_parameters.jpg

Page url

Sets the URL of the external or internal page, displayed at run-time within the Pipe vertical component. In case of an external URL, please make sure that the targeted website is either a locally hosted website or that the link is embeddable

page_url.jpg

Effects

Opacity

Sets the opacity of the component. The Opacity values should be numbers from 0 to 1 representing the opacity of the component. When the component has a value of 0 the element is completely invisible; a value of 1 is completely opaque (solid).

By default, the Component's opacity is set to value 1. Using the up/down arrows the user can control the opacity degree.

opacity_1.jpg

By clicking the Open button the view is extended to display the Opacity slider.

opacity_2.jpg

Shadow color

Sets the color of the component's shadow. The user can either manually type in the HEX color code or use the color picker tool.

shadow_color.jpg

Shadow offset X

Sets the offset of the shadow on the horizontal axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_x.jpg

Shadow offset Y

Sets the offset of the shadow on the vertical axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_y.jpg

Shadow size

Sets the width of the component shadow. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_size.jpg

Symbols

Symbol

Sets the symbol class name to be displayed by the component. The symbol element can be selected by clicking the Open panel to see the icon list button.

The list of icons allows the user to toggle between actual icons and icon names. A simple filtering mechanism is also provided to support the user to easily pinpoint the desired icon.

symbol.jpg

Appearance

Dialog height

Sets the height of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_height.jpg

Dialog width

Sets the width of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_width.jpg

Padding

Sets the padding of the component (defines the space between the component contents and its border).

The top, bottom, left and right values can either be typed in the main property field or by using the Padding editor.

padding_1.jpg

The Padding editor can be opened by clicking the Open button.

padding_2.jpg

The components padding can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Preferred popover position

Sets the positioning of the Pipe vertical popover panel. The position can be selected from the drop-down list options: (default), top, left, and right

popover_position.jpg

Palette

Fill

Sets the color of the SVG file. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

fill.jpg

Stroke color

Sets the color of the SVG stroke. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

stroke_color.jpg

Container background

Sets the color of the container background. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_background.jpg

Container border color

Sets the color of the container border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_border_color.jpg

Dialog header background

Sets the background of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_background.jpg

Dialog header foreground

Sets the foreground of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_foreground.jpg

Style

Container border width

Sets the width of the container border in pixels. The border width value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows.

container_border_width.jpg

The components border width can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Container border radius

Sets the curvature of the border corners expressed in pixels or percentages. The border-radius value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows

This field supports the standard CSS notation

container_border_radius.jpg

Stroke width

Sets the stroke width of the graphical component.

stroke_color.jpg

Transform

Width

Sets the width of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component width can also be adjusted directly on the design surface by means of mouse manipulation.

width.jpg

Height

Sets the height of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component height can also be adjusted directly on the design surface by means of mouse manipulation.

height.jpg

Angle

Sets the rotation angle using the up and down arrows to increase and decrease, or by manually typing the desired degree value.

The component angle can also be adjusted directly on the design surface by means of mouse manipulation.

angle.jpg

Left

Specifies the X (horizontal) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component X coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

left.jpg

Top

Specifies the Y (vertical) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component Y coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

top.jpg

Disable flip

Disables any flip transformation for this component. This keeps the component in the default position even when its container is flipped.

disable_flip.jpg

Horizontal flip

Flips the selected component horizontally.

horizontal_flip.jpg

Vertical flip

Flips the selected component vertically.

vertical_flip.jpg

States

Current States

A component can have multiple states, each carrying its own set of properties. The user can add states, by clicking the Add new state button.

current_states.jpg

Furthermore, the following actions are available for each state:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Clone state clone_state.jpg

  • Remove state remove_state.jpg

State Name

By setting the Name property, the respective state will inherit that name, making the States easier to read.

name_of_state.jpg

State# Condition rule

The required rule for the extension to enter the state. The signal names must be always surrounded by percentage (%) characters, followed by logical operators and the Signal value.

For example: %Setpoint 1% != 0

The Condition rule can be either manually typed in or generated, using the State editor. The State editor can be opened by clicking the Expand array list button. This way, the user can easily generate a Condition rule, as follows:

  • Signal name - allows the user to select a Signal name for the Condition rule.

  • Comparator - allows the user to select the logical operator to construct the Condition rule.

  • Signal value - allows the user to add the Signal value, used to trigger the state condition.

condition_rule.jpg

State# CSS class name

Sets the behavior of the element when the logged-in user doesn't belong to the project authorization indicated by the projectAuthorization property. In this case, the element can be either disabled or hidden.

css_class_name.jpg

State# Symbolic text

The language-agnostic text (which is automatically translated) is displayed by the extension.

symbolic_text.jpg

State# Display state

Sets the component visibility and accessibility when the state evolution passed. The user can choose from the following options:

  • Normal - the component will be displayed when the state evolution passed.

  • Hidden - the component will be hidden when the state evolution passed.

  • Disabled - the component will be displayed as disabled when the state evolution passed.

display_state.jpg

State# Foreground

Sets the foreground color of the button. Applying this property will override the default CSS class.

foreground_states.jpg

State# Background

Sets the background color of the button. Applying this property will override the default CSS class.

background_states.jpg

State# Animation

Sets the component animation class when the state evolution passed. The user can select the animation class from the drop-down list options: Fade in, Fade out or Blink.

animation_states.jpg

Load from assets

Lists the State assets defined under the Assets management page, of the global actions area.

A simple filtering mechanism is also provided to support the user to easily pinpoint the desired state asset.

After selecting an asset from the list view, the user can click the Load button to apply it.

load_from_assets.jpg

Save to assets

Allows the user the possibility to save a state asset defined during the current session. In this view, the user can either click the Generate name button to set a name for the asset or type in the name in the designated field.

By clicking the Apply button, the new state asset will be made available for further management actions in the Assets management page, of the global actions area. Also, the asset can be reused for other Component states.

save_to_assets.jpg
HVAC symbol
Abstract

Check out this article in order to learn more details about the i4designer Hvac symbol component and the properties provided by it.

The i4designer Hvac symbol component is a state-driven, icon-type extension capable to display multiple HVAC parts and components.

hvac_symbol.jpg

The HVAC symbol component

Category

Property

Description

Common

Name

The name of the component, visible in other Designer locations (such as Page explorer).

Name.jpg

Object ID

Sets the Object ID of the component. By defining an object ID for the control, it can be passed as SignalPrefix when using parameter passing in navigation. The value of the Object ID can be used via a placeholder [OID] in other properties of this extension. The placeholder is supported in all signal properties, symbolic text, and states.

Example: Setpoint [OID]

object_id.jpg

Tooltip text

Optional tooltip text, that will be shown on mouseover at runtime.

tooltip.jpg

Configuration

Dialog header title

Allows the user to set the text of the dialog header title

dialog_header_title.jpg

Draggable

Sets the capability to drag the component on the page surface for both Modal and Popover behaviors. By default, the property is set to False

draggable.jpg

Page behavior

Sets the runtime behavior of the component, allowing the user to choose between Modal (modal dialog) and Popover (contextual dialog)

page_behavior.jpg

Security

System authorization/ Permission

The system authorization required to display the component. If the logged in user does not have this system authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled for all users. Further on, the user can also add multiple System authorizations / Permissions, separated by comma (,).

This property is named "System authorization" for projects created on i4scada platform.

system_authorizations.jpg

This property is named "Permissions" for projects created on i4connected platform.

permissions.jpg

Project authorization / Role

The project authorization required for displaying the component. If the logged in user does not have this project authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled to all users. Further on, the user can also add multiple Project authorizations / Roles, separated by comma (,).

This property is named "Project authorization" for projects created on i4scada platform.

project_authorization.jpg

This property is named "Role" for projects created on i4connected platform.

roles.jpg

Security access behavior

Sets the behavior of the element to either disabled (grayed out) or hidden, when the logged in user doesn't meet the conditions imposed by the Project authorization / Roles and System authorization / Permissions properties. In case both Project authorization / Roles and System authorization / Permissions properties are set, the logged user needs to meet both conditions to be able to see and utilize the component, at run-time.

security_access_behavior.jpg

Layout

Layout mode

Sets the behavior of the component related to the page placement. The user can select the component layout from the options available in the drop-down list: Default, Dock top, Dock bottom, Dock left, Dock right, Stretched, Pin top left, Pin top center, Pin top right, Pin right middle, Pin bottom right, Pin bottom center, Pin bottom left, Pin left middle and Pin center.

layout_mode.jpg

Margin

Sets the margin of the component relative to the drawing board area. The supported values are the standard CSS values for the margin.

The top, bottom, left and right values can either be typed in the main property field or by using the Margin editor.

margin_1.jpg

The Margin editor can be opened by clicking the Open button.

margin_2.jpg

The components margins can be updated by setting the margin value and selecting the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Navigation

Is external

Allows the possibility to set the link target to internal or external

If the property is set to False, a current project page can be set as a target. The user can select the project page for the Link property or manually type in the path pointing to it

is_external.jpg

Page parameters

Allows the possibility to add additional parameters for the navigation, by clicking the Add new item button

page_parameters.jpg

Page url

Sets the URL of the external or internal page, displayed at run-time within the Pipe vertical component. In case of an external URL, please make sure that the targeted website is either a locally hosted website or that the link is embeddable

page_url.jpg

Effects

Opacity

Sets the opacity of the component. The Opacity values should be numbers from 0 to 1 representing the opacity of the component. When the component has a value of 0 the element is completely invisible; a value of 1 is completely opaque (solid).

By default, the Component's opacity is set to value 1. Using the up/down arrows the user can control the opacity degree.

opacity_1.jpg

By clicking the Open button the view is extended to display the Opacity slider.

opacity_2.jpg

Shadow color

Sets the color of the component's shadow. The user can either manually type in the HEX color code or use the color picker tool.

shadow_color.jpg

Shadow offset X

Sets the offset of the shadow on the horizontal axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_x.jpg

Shadow offset Y

Sets the offset of the shadow on the vertical axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_y.jpg

Shadow size

Sets the width of the component shadow. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_size.jpg

Symbols

Symbol

Sets the symbol class name to be displayed by the component. The symbol element can be selected by clicking the Open panel to see the icon list button.

The list of icons allows the user to toggle between actual icons and icon names. A simple filtering mechanism is also provided to support the user to easily pinpoint the desired icon.

symbol_hvac.jpg

Appearance

Dialog height

Sets the height of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_height.jpg

Dialog width

Sets the width of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_width.jpg

Padding

Sets the padding of the component (defines the space between the component contents and its border).

The top, bottom, left and right values can either be typed in the main property field or by using the Padding editor.

padding_1.jpg

The Padding editor can be opened by clicking the Open button.

padding_2.jpg

The components padding can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Preferred popover position

Sets the positioning of the Pipe vertical popover panel. The position can be selected from the drop-down list options: (default), top, left, and right

popover_position.jpg

Palette

Fill

Sets the color of the SVG file. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

fill.jpg

Stroke color

Sets the color of the SVG stroke. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

stroke_color.jpg

Container background

Sets the color of the container background. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_background.jpg

Container border color

Sets the color of the container border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_border_color.jpg

Dialog header background

Sets the background of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_background.jpg

Dialog header foreground

Sets the foreground of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_foreground.jpg

Style

Container border width

Sets the width of the container border in pixels. The border width value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows.

container_border_width.jpg

The components border width can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Container border radius

Sets the curvature of the border corners expressed in pixels or percentages. The border-radius value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows

This field supports the standard CSS notation

container_border_radius.jpg

Stroke width

Sets the stroke width of the graphical component.

stroke_color.jpg

Transform

Width

Sets the width of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component width can also be adjusted directly on the design surface by means of mouse manipulation.

width.jpg

Height

Sets the height of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component height can also be adjusted directly on the design surface by means of mouse manipulation.

height.jpg

Angle

Sets the rotation angle using the up and down arrows to increase and decrease, or by manually typing the desired degree value.

The component angle can also be adjusted directly on the design surface by means of mouse manipulation.

angle.jpg

Left

Specifies the X (horizontal) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component X coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

left.jpg

Top

Specifies the Y (vertical) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component Y coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

top.jpg

Disable flip

Disables any flip transformation for this component. This keeps the component in the default position even when its container is flipped.

disable_flip.jpg

Horizontal flip

Flips the selected component horizontally.

horizontal_flip.jpg

Vertical flip

Flips the selected component vertically.

vertical_flip.jpg

States

Current States

A component can have multiple states, each carrying its own set of properties. The user can add states, by clicking the Add new state button.

current_states.jpg

Furthermore, the following actions are available for each state:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Clone state clone_state.jpg

  • Remove state remove_state.jpg

State Name

By setting the Name property, the respective state will inherit that name, making the States easier to read.

name_of_state.jpg

State# Condition rule

The required rule for the extension to enter the state. The signal names must be always surrounded by percentage (%) characters, followed by logical operators and the Signal value.

For example: %Setpoint 1% != 0

The Condition rule can be either manually typed in or generated, using the State editor. The State editor can be opened by clicking the Expand array list button. This way, the user can easily generate a Condition rule, as follows:

  • Signal name - allows the user to select a Signal name for the Condition rule.

  • Comparator - allows the user to select the logical operator to construct the Condition rule.

  • Signal value - allows the user to add the Signal value, used to trigger the state condition.

condition_rule.jpg

State# CSS class name

Sets the behavior of the element when the logged-in user doesn't belong to the project authorization indicated by the projectAuthorization property. In this case, the element can be either disabled or hidden.

css_class_name.jpg

State# Symbolic text

The language-agnostic text (which is automatically translated) is displayed by the extension.

symbolic_text.jpg

State# Display state

Sets the component visibility and accessibility when the state evolution passed. The user can choose from the following options:

  • Normal - the component will be displayed when the state evolution passed.

  • Hidden - the component will be hidden when the state evolution passed.

  • Disabled - the component will be displayed as disabled when the state evolution passed.

display_state.jpg

State# Foreground

Sets the foreground color of the button. Applying this property will override the default CSS class.

foreground_states.jpg

State# Background

Sets the background color of the button. Applying this property will override the default CSS class.

background_states.jpg

State# Animation

Sets the component animation class when the state evolution passed. The user can select the animation class from the drop-down list options: Fade in, Fade out or Blink.

animation_states.jpg

Load from assets

Lists the State assets defined under the Assets management page, of the global actions area.

A simple filtering mechanism is also provided to support the user to easily pinpoint the desired state asset.

After selecting an asset from the list view, the user can click the Load button to apply it.

load_from_assets.jpg

Save to assets

Allows the user the possibility to save a state asset defined during the current session. In this view, the user can either click the Generate name button to set a name for the asset or type in the name in the designated field.

By clicking the Apply button, the new state asset will be made available for further management actions in the Assets management page, of the global actions area. Also, the asset can be reused for other Component states.

save_to_assets.jpg
Icon symbol
Abstract

Check out this article in order to learn more details about the i4designer Icon symbol component and the properties provided by it.

The i4designer Icon symbol component is a state-driven, icon-type extension that can represent a multitude of icons.

icon_symbol.jpg

The Icon symbol component

Category

Property

Description

Common

Name

The name of the component, visible in other Designer locations (such as Page explorer).

Name.jpg

Object ID

Sets the Object ID of the component. By defining an object ID for the control, it can be passed as SignalPrefix when using parameter passing in navigation. The value of the Object ID can be used via a placeholder [OID] in other properties of this extension. The placeholder is supported in all signal properties, symbolic text, and states.

Example: Setpoint [OID]

object_id.jpg

Tooltip text

Optional tooltip text, that will be shown on mouseover at runtime.

tooltip.jpg

Configuration

Dialog header title

Allows the user to set the text of the dialog header title

dialog_header_title.jpg

Draggable

Sets the capability to drag the component on the page surface for both Modal and Popover behaviors. By default, the property is set to False

draggable.jpg

Page behavior

Sets the runtime behavior of the component, allowing the user to choose between Modal (modal dialog) and Popover (contextual dialog)

page_behavior.jpg

Security

System authorization/ Permission

The system authorization required to display the component. If the logged in user does not have this system authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled for all users. Further on, the user can also add multiple System authorizations / Permissions, separated by comma (,).

This property is named "System authorization" for projects created on i4scada platform.

system_authorizations.jpg

This property is named "Permissions" for projects created on i4connected platform.

permissions.jpg

Project authorization / Role

The project authorization required for displaying the component. If the logged in user does not have this project authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled to all users. Further on, the user can also add multiple Project authorizations / Roles, separated by comma (,).

This property is named "Project authorization" for projects created on i4scada platform.

project_authorization.jpg

This property is named "Role" for projects created on i4connected platform.

roles.jpg

Security access behavior

Sets the behavior of the element to either disabled (grayed out) or hidden, when the logged in user doesn't meet the conditions imposed by the Project authorization / Roles and System authorization / Permissions properties. In case both Project authorization / Roles and System authorization / Permissions properties are set, the logged user needs to meet both conditions to be able to see and utilize the component, at run-time.

security_access_behavior.jpg

Layout

Layout mode

Sets the behavior of the component related to the page placement. The user can select the component layout from the options available in the drop-down list: Default, Dock top, Dock bottom, Dock left, Dock right, Stretched, Pin top left, Pin top center, Pin top right, Pin right middle, Pin bottom right, Pin bottom center, Pin bottom left, Pin left middle and Pin center.

layout_mode.jpg

Margin

Sets the margin of the component relative to the drawing board area. The supported values are the standard CSS values for the margin.

The top, bottom, left and right values can either be typed in the main property field or by using the Margin editor.

margin_1.jpg

The Margin editor can be opened by clicking the Open button.

margin_2.jpg

The components margins can be updated by setting the margin value and selecting the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Navigation

Is external

Allows the possibility to set the link target to internal or external

If the property is set to False, a current project page can be set as a target. The user can select the project page for the Link property or manually type in the path pointing to it

is_external.jpg

Page parameters

Allows the possibility to add additional parameters for the navigation, by clicking the Add new item button

page_parameters.jpg

Page url

Sets the URL of the external or internal page, displayed at run-time within the Pipe vertical component. In case of an external URL, please make sure that the targeted website is either a locally hosted website or that the link is embeddable

page_url.jpg

Effects

Opacity

Sets the opacity of the component. The Opacity values should be numbers from 0 to 1 representing the opacity of the component. When the component has a value of 0 the element is completely invisible; a value of 1 is completely opaque (solid).

By default, the Component's opacity is set to value 1. Using the up/down arrows the user can control the opacity degree.

opacity_1.jpg

By clicking the Open button the view is extended to display the Opacity slider.

opacity_2.jpg

Shadow color

Sets the color of the component's shadow. The user can either manually type in the HEX color code or use the color picker tool.

shadow_color.jpg

Shadow offset X

Sets the offset of the shadow on the horizontal axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_x.jpg

Shadow offset Y

Sets the offset of the shadow on the vertical axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_y.jpg

Shadow size

Sets the width of the component shadow. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_size.jpg

Symbols

Symbol

Sets the symbol class name to be displayed by the component. The symbol element can be selected by clicking the Open panel to see the icon list button.

The list of icons allows the user to toggle between actual icons and icon names. A simple filtering mechanism is also provided to support the user to easily pinpoint the desired icon.

symbol_icon.jpg

Appearance

Dialog height

Sets the height of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_height.jpg

Dialog width

Sets the width of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_width.jpg

Padding

Sets the padding of the component (defines the space between the component contents and its border).

The top, bottom, left and right values can either be typed in the main property field or by using the Padding editor.

padding_1.jpg

The Padding editor can be opened by clicking the Open button.

padding_2.jpg

The components padding can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Preferred popover position

Sets the positioning of the Pipe vertical popover panel. The position can be selected from the drop-down list options: (default), top, left, and right

popover_position.jpg

Palette

Fill

Sets the color of the SVG file. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

fill.jpg

Stroke color

Sets the color of the SVG stroke. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

stroke_color.jpg

Container background

Sets the color of the container background. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_background.jpg

Container border color

Sets the color of the container border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_border_color.jpg

Dialog header background

Sets the background of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_background.jpg

Dialog header foreground

Sets the foreground of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_foreground.jpg

Style

Container border width

Sets the width of the container border in pixels. The border width value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows.

container_border_width.jpg

The components border width can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Container border radius

Sets the curvature of the border corners expressed in pixels or percentages. The border-radius value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows

This field supports the standard CSS notation

container_border_radius.jpg

Stroke width

Sets the stroke width of the graphical component.

stroke_color.jpg

Transform

Width

Sets the width of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component width can also be adjusted directly on the design surface by means of mouse manipulation.

width.jpg

Height

Sets the height of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component height can also be adjusted directly on the design surface by means of mouse manipulation.

height.jpg

Angle

Sets the rotation angle using the up and down arrows to increase and decrease, or by manually typing the desired degree value.

The component angle can also be adjusted directly on the design surface by means of mouse manipulation.

angle.jpg

Left

Specifies the X (horizontal) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component X coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

left.jpg

Top

Specifies the Y (vertical) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component Y coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

top.jpg

Disable flip

Disables any flip transformation for this component. This keeps the component in the default position even when its container is flipped.

disable_flip.jpg

Horizontal flip

Flips the selected component horizontally.

horizontal_flip.jpg

Vertical flip

Flips the selected component vertically.

vertical_flip.jpg

States

Current States

A component can have multiple states, each carrying its own set of properties. The user can add states, by clicking the Add new state button.

current_states.jpg

Furthermore, the following actions are available for each state:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Clone state clone_state.jpg

  • Remove state remove_state.jpg

State Name

By setting the Name property, the respective state will inherit that name, making the States easier to read.

name_of_state.jpg

State# Condition rule

The required rule for the extension to enter the state. The signal names must be always surrounded by percentage (%) characters, followed by logical operators and the Signal value.

For example: %Setpoint 1% != 0

The Condition rule can be either manually typed in or generated, using the State editor. The State editor can be opened by clicking the Expand array list button. This way, the user can easily generate a Condition rule, as follows:

  • Signal name - allows the user to select a Signal name for the Condition rule.

  • Comparator - allows the user to select the logical operator to construct the Condition rule.

  • Signal value - allows the user to add the Signal value, used to trigger the state condition.

condition_rule.jpg

State# CSS class name

Sets the behavior of the element when the logged-in user doesn't belong to the project authorization indicated by the projectAuthorization property. In this case, the element can be either disabled or hidden.

css_class_name.jpg

State# Symbolic text

The language-agnostic text (which is automatically translated) is displayed by the extension.

symbolic_text.jpg

State# Display state

Sets the component visibility and accessibility when the state evolution passed. The user can choose from the following options:

  • Normal - the component will be displayed when the state evolution passed.

  • Hidden - the component will be hidden when the state evolution passed.

  • Disabled - the component will be displayed as disabled when the state evolution passed.

display_state.jpg

State# Foreground

Sets the foreground color of the button. Applying this property will override the default CSS class.

foreground_states.jpg

State# Background

Sets the background color of the button. Applying this property will override the default CSS class.

background_states.jpg

State# Animation

Sets the component animation class when the state evolution passed. The user can select the animation class from the drop-down list options: Fade in, Fade out or Blink.

animation_states.jpg

Load from assets

Lists the State assets defined under the Assets management page, of the global actions area.

A simple filtering mechanism is also provided to support the user to easily pinpoint the desired state asset.

After selecting an asset from the list view, the user can click the Load button to apply it.

load_from_assets.jpg

Save to assets

Allows the user the possibility to save a state asset defined during the current session. In this view, the user can either click the Generate name button to set a name for the asset or type in the name in the designated field.

By clicking the Apply button, the new state asset will be made available for further management actions in the Assets management page, of the global actions area. Also, the asset can be reused for other Component states.

save_to_assets.jpg
Pid symbol
Abstract

Check out this article in order to learn more details about the i4designer Pid symbol component and the properties provided by it.

The i4designer Pid symbol component is a state-driven, icon-type extension that can represent a multitude of PID symbols.

pyd_symbol.jpg

The Pid symbol component

Category

Property

Description

Common

Name

The name of the component, visible in other Designer locations (such as Page explorer).

Name.jpg

Object ID

Sets the Object ID of the component. By defining an object ID for the control, it can be passed as SignalPrefix when using parameter passing in navigation. The value of the Object ID can be used via a placeholder [OID] in other properties of this extension. The placeholder is supported in all signal properties, symbolic text, and states.

Example: Setpoint [OID]

object_id.jpg

Tooltip text

Optional tooltip text, that will be shown on mouseover at runtime.

tooltip.jpg

Configuration

Dialog header title

Allows the user to set the text of the dialog header title

dialog_header_title.jpg

Draggable

Sets the capability to drag the component on the page surface for both Modal and Popover behaviors. By default, the property is set to False

draggable.jpg

Page behavior

Sets the runtime behavior of the component, allowing the user to choose between Modal (modal dialog) and Popover (contextual dialog)

page_behavior.jpg

Security

System authorization/ Permission

The system authorization required to display the component. If the logged in user does not have this system authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled for all users. Further on, the user can also add multiple System authorizations / Permissions, separated by comma (,).

This property is named "System authorization" for projects created on i4scada platform.

system_authorizations.jpg

This property is named "Permissions" for projects created on i4connected platform.

permissions.jpg

Project authorization / Role

The project authorization required for displaying the component. If the logged in user does not have this project authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled to all users. Further on, the user can also add multiple Project authorizations / Roles, separated by comma (,).

This property is named "Project authorization" for projects created on i4scada platform.

project_authorization.jpg

This property is named "Role" for projects created on i4connected platform.

roles.jpg

Security access behavior

Sets the behavior of the element to either disabled (grayed out) or hidden, when the logged in user doesn't meet the conditions imposed by the Project authorization / Roles and System authorization / Permissions properties. In case both Project authorization / Roles and System authorization / Permissions properties are set, the logged user needs to meet both conditions to be able to see and utilize the component, at run-time.

security_access_behavior.jpg

Layout

Layout mode

Sets the behavior of the component related to the page placement. The user can select the component layout from the options available in the drop-down list: Default, Dock top, Dock bottom, Dock left, Dock right, Stretched, Pin top left, Pin top center, Pin top right, Pin right middle, Pin bottom right, Pin bottom center, Pin bottom left, Pin left middle and Pin center.

layout_mode.jpg

Margin

Sets the margin of the component relative to the drawing board area. The supported values are the standard CSS values for the margin.

The top, bottom, left and right values can either be typed in the main property field or by using the Margin editor.

margin_1.jpg

The Margin editor can be opened by clicking the Open button.

margin_2.jpg

The components margins can be updated by setting the margin value and selecting the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Navigation

Is external

Allows the possibility to set the link target to internal or external

If the property is set to False, a current project page can be set as a target. The user can select the project page for the Link property or manually type in the path pointing to it

is_external.jpg

Page parameters

Allows the possibility to add additional parameters for the navigation, by clicking the Add new item button

page_parameters.jpg

Page url

Sets the URL of the external or internal page, displayed at run-time within the Pipe vertical component. In case of an external URL, please make sure that the targeted website is either a locally hosted website or that the link is embeddable

page_url.jpg

Effects

Opacity

Sets the opacity of the component. The Opacity values should be numbers from 0 to 1 representing the opacity of the component. When the component has a value of 0 the element is completely invisible; a value of 1 is completely opaque (solid).

By default, the Component's opacity is set to value 1. Using the up/down arrows the user can control the opacity degree.

opacity_1.jpg

By clicking the Open button the view is extended to display the Opacity slider.

opacity_2.jpg

Shadow color

Sets the color of the component's shadow. The user can either manually type in the HEX color code or use the color picker tool.

shadow_color.jpg

Shadow offset X

Sets the offset of the shadow on the horizontal axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_x.jpg

Shadow offset Y

Sets the offset of the shadow on the vertical axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_y.jpg

Shadow size

Sets the width of the component shadow. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_size.jpg

Symbols

Symbol

Sets the symbol class name to be displayed by the component. The symbol element can be selected by clicking the Open panel to see the icon list button.

The list of icons allows the user to toggle between actual icons and icon names. A simple filtering mechanism is also provided to support the user to easily pinpoint the desired icon.

symbol_pid.jpg

Appearance

Dialog height

Sets the height of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_height.jpg

Dialog width

Sets the width of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_width.jpg

Padding

Sets the padding of the component (defines the space between the component contents and its border).

The top, bottom, left and right values can either be typed in the main property field or by using the Padding editor.

padding_1.jpg

The Padding editor can be opened by clicking the Open button.

padding_2.jpg

The components padding can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Preferred popover position

Sets the positioning of the Pipe vertical popover panel. The position can be selected from the drop-down list options: (default), top, left, and right

popover_position.jpg

Palette

Fill

Sets the color of the SVG file. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

fill.jpg

Stroke color

Sets the color of the SVG stroke. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

stroke_color.jpg

Container background

Sets the color of the container background. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_background.jpg

Container border color

Sets the color of the container border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_border_color.jpg

Dialog header background

Sets the background of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_background.jpg

Dialog header foreground

Sets the foreground of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_foreground.jpg

Style

Container border width

Sets the width of the container border in pixels. The border width value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows.

container_border_width.jpg

The components border width can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Container border radius

Sets the curvature of the border corners expressed in pixels or percentages. The border-radius value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows

This field supports the standard CSS notation

container_border_radius.jpg

Stroke width

Sets the stroke width of the graphical component.

stroke_color.jpg

Transform

Width

Sets the width of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component width can also be adjusted directly on the design surface by means of mouse manipulation.

width.jpg

Height

Sets the height of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component height can also be adjusted directly on the design surface by means of mouse manipulation.

height.jpg

Angle

Sets the rotation angle using the up and down arrows to increase and decrease, or by manually typing the desired degree value.

The component angle can also be adjusted directly on the design surface by means of mouse manipulation.

angle.jpg

Left

Specifies the X (horizontal) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component X coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

left.jpg

Top

Specifies the Y (vertical) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component Y coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

top.jpg

Disable flip

Disables any flip transformation for this component. This keeps the component in the default position even when its container is flipped.

disable_flip.jpg

Horizontal flip

Flips the selected component horizontally.

horizontal_flip.jpg

Vertical flip

Flips the selected component vertically.

vertical_flip.jpg

States

Current States

A component can have multiple states, each carrying its own set of properties. The user can add states, by clicking the Add new state button.

current_states.jpg

Furthermore, the following actions are available for each state:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Clone state clone_state.jpg

  • Remove state remove_state.jpg

State Name

By setting the Name property, the respective state will inherit that name, making the States easier to read.

name_of_state.jpg

State# Condition rule

The required rule for the extension to enter the state. The signal names must be always surrounded by percentage (%) characters, followed by logical operators and the Signal value.

For example: %Setpoint 1% != 0

The Condition rule can be either manually typed in or generated, using the State editor. The State editor can be opened by clicking the Expand array list button. This way, the user can easily generate a Condition rule, as follows:

  • Signal name - allows the user to select a Signal name for the Condition rule.

  • Comparator - allows the user to select the logical operator to construct the Condition rule.

  • Signal value - allows the user to add the Signal value, used to trigger the state condition.

condition_rule.jpg

State# CSS class name

Sets the behavior of the element when the logged-in user doesn't belong to the project authorization indicated by the projectAuthorization property. In this case, the element can be either disabled or hidden.

css_class_name.jpg

State# Symbolic text

The language-agnostic text (which is automatically translated) is displayed by the extension.

symbolic_text.jpg

State# Display state

Sets the component visibility and accessibility when the state evolution passed. The user can choose from the following options:

  • Normal - the component will be displayed when the state evolution passed.

  • Hidden - the component will be hidden when the state evolution passed.

  • Disabled - the component will be displayed as disabled when the state evolution passed.

display_state.jpg

State# Foreground

Sets the foreground color of the button. Applying this property will override the default CSS class.

foreground_states.jpg

State# Background

Sets the background color of the button. Applying this property will override the default CSS class.

background_states.jpg

State# Animation

Sets the component animation class when the state evolution passed. The user can select the animation class from the drop-down list options: Fade in, Fade out or Blink.

animation_states.jpg

Load from assets

Lists the State assets defined under the Assets management page, of the global actions area.

A simple filtering mechanism is also provided to support the user to easily pinpoint the desired state asset.

After selecting an asset from the list view, the user can click the Load button to apply it.

load_from_assets.jpg

Save to assets

Allows the user the possibility to save a state asset defined during the current session. In this view, the user can either click the Generate name button to set a name for the asset or type in the name in the designated field.

By clicking the Apply button, the new state asset will be made available for further management actions in the Assets management page, of the global actions area. Also, the asset can be reused for other Component states.

save_to_assets.jpg
Valves symbol
Abstract

Check out this article in order to learn more details about the i4designer Valves symbol component and the properties provided by it.

The i4designer Valves symbol component is a state-driven, icon-type extension that can represent a multitude of valve types.

valves_symbol.jpg

The Valves symbol component

Category

Property

Description

Common

Name

The name of the component, visible in other Designer locations (such as Page explorer).

Name.jpg

Object ID

Sets the Object ID of the component. By defining an object ID for the control, it can be passed as SignalPrefix when using parameter passing in navigation. The value of the Object ID can be used via a placeholder [OID] in other properties of this extension. The placeholder is supported in all signal properties, symbolic text, and states.

Example: Setpoint [OID]

object_id.jpg

Tooltip text

Optional tooltip text, that will be shown on mouseover at runtime.

tooltip.jpg

Configuration

Dialog header title

Allows the user to set the text of the dialog header title

dialog_header_title.jpg

Draggable

Sets the capability to drag the component on the page surface for both Modal and Popover behaviors. By default, the property is set to False

draggable.jpg

Page behavior

Sets the runtime behavior of the component, allowing the user to choose between Modal (modal dialog) and Popover (contextual dialog)

page_behavior.jpg

Security

System authorization/ Permission

The system authorization required to display the component. If the logged in user does not have this system authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled for all users. Further on, the user can also add multiple System authorizations / Permissions, separated by comma (,).

This property is named "System authorization" for projects created on i4scada platform.

system_authorizations.jpg

This property is named "Permissions" for projects created on i4connected platform.

permissions.jpg

Project authorization / Role

The project authorization required for displaying the component. If the logged in user does not have this project authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled to all users. Further on, the user can also add multiple Project authorizations / Roles, separated by comma (,).

This property is named "Project authorization" for projects created on i4scada platform.

project_authorization.jpg

This property is named "Role" for projects created on i4connected platform.

roles.jpg

Security access behavior

Sets the behavior of the element to either disabled (grayed out) or hidden, when the logged in user doesn't meet the conditions imposed by the Project authorization / Roles and System authorization / Permissions properties. In case both Project authorization / Roles and System authorization / Permissions properties are set, the logged user needs to meet both conditions to be able to see and utilize the component, at run-time.

security_access_behavior.jpg

Layout

Layout mode

Sets the behavior of the component related to the page placement. The user can select the component layout from the options available in the drop-down list: Default, Dock top, Dock bottom, Dock left, Dock right, Stretched, Pin top left, Pin top center, Pin top right, Pin right middle, Pin bottom right, Pin bottom center, Pin bottom left, Pin left middle and Pin center.

layout_mode.jpg

Margin

Sets the margin of the component relative to the drawing board area. The supported values are the standard CSS values for the margin.

The top, bottom, left and right values can either be typed in the main property field or by using the Margin editor.

margin_1.jpg

The Margin editor can be opened by clicking the Open button.

margin_2.jpg

The components margins can be updated by setting the margin value and selecting the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Navigation

Is external

Allows the possibility to set the link target to internal or external

If the property is set to False, a current project page can be set as a target. The user can select the project page for the Link property or manually type in the path pointing to it

is_external.jpg

Page parameters

Allows the possibility to add additional parameters for the navigation, by clicking the Add new item button

page_parameters.jpg

Page url

Sets the URL of the external or internal page, displayed at run-time within the Pipe vertical component. In case of an external URL, please make sure that the targeted website is either a locally hosted website or that the link is embeddable

page_url.jpg

Effects

Opacity

Sets the opacity of the component. The Opacity values should be numbers from 0 to 1 representing the opacity of the component. When the component has a value of 0 the element is completely invisible; a value of 1 is completely opaque (solid).

By default, the Component's opacity is set to value 1. Using the up/down arrows the user can control the opacity degree.

opacity_1.jpg

By clicking the Open button the view is extended to display the Opacity slider.

opacity_2.jpg

Shadow color

Sets the color of the component's shadow. The user can either manually type in the HEX color code or use the color picker tool.

shadow_color.jpg

Shadow offset X

Sets the offset of the shadow on the horizontal axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_x.jpg

Shadow offset Y

Sets the offset of the shadow on the vertical axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_y.jpg

Shadow size

Sets the width of the component shadow. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_size.jpg

Symbols

Symbol

Sets the symbol class name to be displayed by the component. The symbol element can be selected by clicking the Open panel to see the icon list button.

The list of icons allows the user to toggle between actual icons and icon names. A simple filtering mechanism is also provided to support the user to easily pinpoint the desired icon.

symbol_valve.jpg

Appearance

Dialog height

Sets the height of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_height.jpg

Dialog width

Sets the width of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_width.jpg

Padding

Sets the padding of the component (defines the space between the component contents and its border).

The top, bottom, left and right values can either be typed in the main property field or by using the Padding editor.

padding_1.jpg

The Padding editor can be opened by clicking the Open button.

padding_2.jpg

The components padding can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Preferred popover position

Sets the positioning of the Pipe vertical popover panel. The position can be selected from the drop-down list options: (default), top, left, and right

popover_position.jpg

Palette

Fill

Sets the color of the SVG file. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

fill.jpg

Stroke color

Sets the color of the SVG stroke. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

stroke_color.jpg

Container background

Sets the color of the container background. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_background.jpg

Container border color

Sets the color of the container border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_border_color.jpg

Dialog header background

Sets the background of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_background.jpg

Dialog header foreground

Sets the foreground of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_foreground.jpg

Style

Container border width

Sets the width of the container border in pixels. The border width value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows.

container_border_width.jpg

The components border width can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Container border radius

Sets the curvature of the border corners expressed in pixels or percentages. The border-radius value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows

This field supports the standard CSS notation

container_border_radius.jpg

Stroke width

Sets the stroke width of the graphical component.

stroke_color.jpg

Transform

Width

Sets the width of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component width can also be adjusted directly on the design surface by means of mouse manipulation.

width.jpg

Height

Sets the height of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component height can also be adjusted directly on the design surface by means of mouse manipulation.

height.jpg

Angle

Sets the rotation angle using the up and down arrows to increase and decrease, or by manually typing the desired degree value.

The component angle can also be adjusted directly on the design surface by means of mouse manipulation.

angle.jpg

Left

Specifies the X (horizontal) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component X coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

left.jpg

Top

Specifies the Y (vertical) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component Y coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

top.jpg

Disable flip

Disables any flip transformation for this component. This keeps the component in the default position even when its container is flipped.

disable_flip.jpg

Horizontal flip

Flips the selected component horizontally.

horizontal_flip.jpg

Vertical flip

Flips the selected component vertically.

vertical_flip.jpg

States

Current States

A component can have multiple states, each carrying its own set of properties. The user can add states, by clicking the Add new state button.

current_states.jpg

Furthermore, the following actions are available for each state:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Clone state clone_state.jpg

  • Remove state remove_state.jpg

State Name

By setting the Name property, the respective state will inherit that name, making the States easier to read.

name_of_state.jpg

State# Condition rule

The required rule for the extension to enter the state. The signal names must be always surrounded by percentage (%) characters, followed by logical operators and the Signal value.

For example: %Setpoint 1% != 0

The Condition rule can be either manually typed in or generated, using the State editor. The State editor can be opened by clicking the Expand array list button. This way, the user can easily generate a Condition rule, as follows:

  • Signal name - allows the user to select a Signal name for the Condition rule.

  • Comparator - allows the user to select the logical operator to construct the Condition rule.

  • Signal value - allows the user to add the Signal value, used to trigger the state condition.

condition_rule.jpg

State# CSS class name

Sets the behavior of the element when the logged-in user doesn't belong to the project authorization indicated by the projectAuthorization property. In this case, the element can be either disabled or hidden.

css_class_name.jpg

State# Symbolic text

The language-agnostic text (which is automatically translated) is displayed by the extension.

symbolic_text.jpg

State# Display state

Sets the component visibility and accessibility when the state evolution passed. The user can choose from the following options:

  • Normal - the component will be displayed when the state evolution passed.

  • Hidden - the component will be hidden when the state evolution passed.

  • Disabled - the component will be displayed as disabled when the state evolution passed.

display_state.jpg

State# Foreground

Sets the foreground color of the button. Applying this property will override the default CSS class.

foreground_states.jpg

State# Background

Sets the background color of the button. Applying this property will override the default CSS class.

background_states.jpg

State# Animation

Sets the component animation class when the state evolution passed. The user can select the animation class from the drop-down list options: Fade in, Fade out or Blink.

animation_states.jpg

Load from assets

Lists the State assets defined under the Assets management page, of the global actions area.

A simple filtering mechanism is also provided to support the user to easily pinpoint the desired state asset.

After selecting an asset from the list view, the user can click the Load button to apply it.

load_from_assets.jpg

Save to assets

Allows the user the possibility to save a state asset defined during the current session. In this view, the user can either click the Generate name button to set a name for the asset or type in the name in the designated field.

By clicking the Apply button, the new state asset will be made available for further management actions in the Assets management page, of the global actions area. Also, the asset can be reused for other Component states.

save_to_assets.jpg
Shapes
Abstract

Check out this article in order to learn more details about the i4designer Shapes component and the properties provided by it.

The i4designer Shapes component is a state-driven, icon-type extension that can represent a multitude of shapes.

shapes.jpg

The Shapes component

Category

Property

Description

Common

Name

The name of the component, visible in other Designer locations (such as Page explorer).

Name.jpg

Object ID

Sets the Object ID of the component. By defining an object ID for the control, it can be passed as SignalPrefix when using parameter passing in navigation. The value of the Object ID can be used via a placeholder [OID] in other properties of this extension. The placeholder is supported in all signal properties, symbolic text, and states.

Example: Setpoint [OID]

object_id.jpg

Tooltip text

Optional tooltip text, that will be shown on mouseover at runtime.

tooltip.jpg

Configuration

Dialog header title

Allows the user to set the text of the dialog header title

dialog_header_title.jpg

Draggable

Sets the capability to drag the component on the page surface for both Modal and Popover behaviors. By default, the property is set to False

draggable.jpg

Page behavior

Sets the runtime behavior of the component, allowing the user to choose between Modal (modal dialog) and Popover (contextual dialog)

page_behavior.jpg

Security

System authorization/ Permission

The system authorization required to display the component. If the logged in user does not have this system authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled for all users. Further on, the user can also add multiple System authorizations / Permissions, separated by comma (,).

This property is named "System authorization" for projects created on i4scada platform.

system_authorizations.jpg

This property is named "Permissions" for projects created on i4connected platform.

permissions.jpg

Project authorization / Role

The project authorization required for displaying the component. If the logged in user does not have this project authorization, the component will not be visible or enabled (depending on the set Security access behavior). If the property is left empty, the component will be visible and enabled to all users. Further on, the user can also add multiple Project authorizations / Roles, separated by comma (,).

This property is named "Project authorization" for projects created on i4scada platform.

project_authorization.jpg

This property is named "Role" for projects created on i4connected platform.

roles.jpg

Security access behavior

Sets the behavior of the element to either disabled (grayed out) or hidden, when the logged in user doesn't meet the conditions imposed by the Project authorization / Roles and System authorization / Permissions properties. In case both Project authorization / Roles and System authorization / Permissions properties are set, the logged user needs to meet both conditions to be able to see and utilize the component, at run-time.

security_access_behavior.jpg

Layout

Layout mode

Sets the behavior of the component related to the page placement. The user can select the component layout from the options available in the drop-down list: Default, Dock top, Dock bottom, Dock left, Dock right, Stretched, Pin top left, Pin top center, Pin top right, Pin right middle, Pin bottom right, Pin bottom center, Pin bottom left, Pin left middle and Pin center.

layout_mode.jpg

Margin

Sets the margin of the component relative to the drawing board area. The supported values are the standard CSS values for the margin.

The top, bottom, left and right values can either be typed in the main property field or by using the Margin editor.

margin_1.jpg

The Margin editor can be opened by clicking the Open button.

margin_2.jpg

The components margins can be updated by setting the margin value and selecting the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Navigation

Is external

Allows the possibility to set the link target to internal or external

If the property is set to False, a current project page can be set as a target. The user can select the project page for the Link property or manually type in the path pointing to it

is_external.jpg

Page parameters

Allows the possibility to add additional parameters for the navigation, by clicking the Add new item button

page_parameters.jpg

Page url

Sets the URL of the external or internal page, displayed at run-time within the Pipe vertical component. In case of an external URL, please make sure that the targeted website is either a locally hosted website or that the link is embeddable

page_url.jpg

Effects

Opacity

Sets the opacity of the component. The Opacity values should be numbers from 0 to 1 representing the opacity of the component. When the component has a value of 0 the element is completely invisible; a value of 1 is completely opaque (solid).

By default, the Component's opacity is set to value 1. Using the up/down arrows the user can control the opacity degree.

opacity_1.jpg

By clicking the Open button the view is extended to display the Opacity slider.

opacity_2.jpg

Shadow color

Sets the color of the component's shadow. The user can either manually type in the HEX color code or use the color picker tool.

shadow_color.jpg

Shadow offset X

Sets the offset of the shadow on the horizontal axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_x.jpg

Shadow offset Y

Sets the offset of the shadow on the vertical axis. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_offset_y.jpg

Shadow size

Sets the width of the component shadow. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

shadow_size.jpg

Symbols

Symbol

Sets the symbol class name to be displayed by the component. The symbol element can be selected by clicking the Open panel to see the icon list button.

The list of icons allows the user to toggle between actual icons and icon names. A simple filtering mechanism is also provided to support the user to easily pinpoint the desired icon.

symbol_shapes.jpg

Appearance

Dialog height

Sets the height of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_height.jpg

Dialog width

Sets the width of the dialog measured in pixels. The default value can be increased or decreased, either by manually typing in the desired value or by using the up and down arrows.

dialog_width.jpg

Padding

Sets the padding of the component (defines the space between the component contents and its border).

The top, bottom, left and right values can either be typed in the main property field or by using the Padding editor.

padding_1.jpg

The Padding editor can be opened by clicking the Open button.

padding_2.jpg

The components padding can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Preferred popover position

Sets the positioning of the Pipe vertical popover panel. The position can be selected from the drop-down list options: (default), top, left, and right

popover_position.jpg

Palette

Fill

Sets the color of the SVG file. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

fill.jpg

Stroke color

Sets the color of the SVG stroke. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

stroke_color.jpg

Container background

Sets the color of the container background. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_background.jpg

Container border color

Sets the color of the container border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the default CSS class.

container_border_color.jpg

Dialog header background

Sets the background of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_background.jpg

Dialog header foreground

Sets the foreground of the dialog header, either by manually typing in the HEX color code or by using the color picker tool. As the component colors are injected by the default CSS, changing the color will overwrite the CSS

dialog_header_foreground.jpg

Style

Container border width

Sets the width of the container border in pixels. The border width value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows.

container_border_width.jpg

The components border width can be updated by setting the value and the desired unit:

  • Ems (em) - The em is a scalable unit. One em is equal to the current font size;

  • Pixels (px) - Pixels are fixed-size units. One pixel is equal to one dot on the computer screen (the smallest division of a screen’s resolution).

  • Percent (%) - The percent unit is much like the “em” unit. When using the Percent unit the component remains fully scalable for mobile devices and accessibility.

Container border radius

Sets the curvature of the border corners expressed in pixels or percentages. The border-radius value can be either manually typed in the designated field or increased/decreased by clicking the up and down arrows

This field supports the standard CSS notation

container_border_radius.jpg

Stroke width

Sets the stroke width of the graphical component.

stroke_color.jpg

Transform

Width

Sets the width of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component width can also be adjusted directly on the design surface by means of mouse manipulation.

width.jpg

Height

Sets the height of the component using the up and down arrows to increase and decrease, or by manually typing the desired pixels value.

The component height can also be adjusted directly on the design surface by means of mouse manipulation.

height.jpg

Angle

Sets the rotation angle using the up and down arrows to increase and decrease, or by manually typing the desired degree value.

The component angle can also be adjusted directly on the design surface by means of mouse manipulation.

angle.jpg

Left

Specifies the X (horizontal) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component X coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

left.jpg

Top

Specifies the Y (vertical) coordinate of the component, on the grid, using the up and down arrows to increase and decrease, or by manually typing the desired value.

The component Y coordinate can also be adjusted directly on the design surface by means of mouse manipulation.

top.jpg

Disable flip

Disables any flip transformation for this component. This keeps the component in the default position even when its container is flipped.

disable_flip.jpg

Horizontal flip

Flips the selected component horizontally.

horizontal_flip.jpg

Vertical flip

Flips the selected component vertically.

vertical_flip.jpg

States

Current States

A component can have multiple states, each carrying its own set of properties. The user can add states, by clicking the Add new state button.

current_states.jpg

Furthermore, the following actions are available for each state:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Clone state clone_state.jpg

  • Remove state remove_state.jpg

State Name

By setting the Name property, the respective state will inherit that name, making the States easier to read.

name_of_state.jpg

State# Condition rule

The required rule for the extension to enter the state. The signal names must be always surrounded by percentage (%) characters, followed by logical operators and the Signal value.

For example: %Setpoint 1% != 0

The Condition rule can be either manually typed in or generated, using the State editor. The State editor can be opened by clicking the Expand array list button. This way, the user can easily generate a Condition rule, as follows:

  • Signal name - allows the user to select a Signal name for the Condition rule.

  • Comparator - allows the user to select the logical operator to construct the Condition rule.

  • Signal value - allows the user to add the Signal value, used to trigger the state condition.

condition_rule.jpg

State# CSS class name

Sets the behavior of the element when the logged-in user doesn't belong to the project authorization indicated by the projectAuthorization property. In this case, the element can be either disabled or hidden.

css_class_name.jpg

State# Symbolic text

The language-agnostic text (which is automatically translated) is displayed by the extension.

symbolic_text.jpg

State# Display state

Sets the component visibility and accessibility when the state evolution passed. The user can choose from the following options:

  • Normal - the component will be displayed when the state evolution passed.

  • Hidden - the component will be hidden when the state evolution passed.

  • Disabled - the component will be displayed as disabled when the state evolution passed.

display_state.jpg

State# Foreground

Sets the foreground color of the button. Applying this property will override the default CSS class.

foreground_states.jpg

State# Background

Sets the background color of the button. Applying this property will override the default CSS class.

background_states.jpg

State# Animation

Sets the component animation class when the state evolution passed. The user can select the animation class from the drop-down list options: Fade in, Fade out or Blink.

animation_states.jpg

Load from assets

Lists the State assets defined under the Assets management page, of the global actions area.

A simple filtering mechanism is also provided to support the user to easily pinpoint the desired state asset.

After selecting an asset from the list view, the user can click the Load button to apply it.

load_from_assets.jpg

Save to assets

Allows the user the possibility to save a state asset defined during the current session. In this view, the user can either click the Generate name button to set a name for the asset or type in the name in the designated field.

By clicking the Apply button, the new state asset will be made available for further management actions in the Assets management page, of the global actions area. Also, the asset can be reused for other Component states.

save_to_assets.jpg