i4designer Knowledgebase

Content

Abstract

Here are the i4designer Content components for your new project allowing you to insert various contents to your projects.

The upcoming article describes the Panel and Frames components in the Content category.

Panel
Abstract

Check out this article in order to learn more details about the i4designer Panel component and the properties it provides.

The i4designer Panel component is a simple configurable content container, providing the user with possibility to insert a header and a footer area.

Panel_comp.jpg

The Panel 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_text.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. If the property is left empty, the component will be visible to all users.

This property is named "System authorization" for projects created on i4SCADA platform and "Permission" on i4connected platform projects.

System_authorization.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. If the property is left empty, the component will be visible to all users.

This property is named "Project authorization" for projects created on i4SCADA platform and "Role" on i4connected platform projects.

Project_authorization.jpg

Security access authorization

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.

Security_access_behavior.jpg

Layout

Layout mode

Sets the behaviour 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.

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

Margin_small.jpg

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

Margin_large.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 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.

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.jpg

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

Opacity_slider.jpg

Shadow color

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).

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

Navigation

Page link

The Url to an internal or external page or file, opened when clicking the Link button.

Page_link.jpg

Navigation parameters

Allows possibility to add additional items for writing multiple signals, by clicking the Add new item button.

Add_item.jpg

In order to see the list of items the user can click on the Expand array list button.

Signal_write_items.jpg

Further more, the following actions are available for each item:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Remove item remove_state.jpg

Write item# Parameter name

Sets the name of the signal that will be represented or manipulated by the component.

Signa_write_item_name.jpg

Write item# Value

Sets the signal value that will be considered, at run-time, by the component.

Value.jpg

Palette

Footer background

Sets the color of the panel footer. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the deafult css class.

Footer_background.jpg

Footer border color

Sets the color of the footer top border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the deafult css class.

Footer_border_color.jpg

Header border color

Sets the color of the panel header bottom border. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the deafult css class.

Header_border_color.jpg

Header foreground

Sets the color of the panel header text. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the deafult css class.

Header_foreground.jpg

Background color

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

Background_color.jpg

Icon color

Sets the color of the icon. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the deafult css class.

Icon_color.jpg

Border color

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

Border_color.jpg

Header background

Sets the background color of the panel header. The user can either manually type in the HEX color code or use the color picker tool. Applying this property will overwrite the deafult css class.

Header_background.jpg

Style

Border radius

Sets the curvature of the border corners expressed in pixels or percentage. 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.

Border_radius.jpg

Header style

Sets the style of the header, providing the user with a set of predefined options: Flat or Glossy.

Header_style.jpg

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.

Border_width.jpg

Configuration

Content mode

Sets the mode in which the content of the frame is displayed, allowing the user to select from the drop-down list options: default, stretched, horizontal flexbox, vertical flexbox.

Content_mode.jpg

Header title

Sets the text of the header title.

Header_title.jpg

Appearance

Header height

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

Header_height.jpg

Header text alignment

Sets the panel header text alignment selecting from the drop-down list options: left, right or center.

Header_text_alignment.jpg

Typography

Font family

Sets the font family of the component, by selecting from the drop-down list options:

Font_family.jpg

Header font size

Sets the header font size, using the up and down arrows to increase and decrease, or by manually typing the desired value.

Header_font_size.jpg

Header font weight

Sets the header font weight, selecting from the drop-down list options: normal, 900 (fat), 800 (extra-bold), 700 (bold), 600 (semi-bold), 500 (medium), 400 (regular), 300 (light), 200 (extra-light) and 100 (thin).

Header_font_weight.jpg

Icon

Icon class

Sets the CSS class for the icon of the component.

The icon can be selected from a large amount of icons accessible 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 pin-point the desired icon.

Icon_class.jpg

Miscellaneous

Overflow

Sets the display of the content that exceeds the panel container at run-time, allowing the user to select from the drop-down list options: hidden, visible or auto.

Overflow.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.

Control_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.

Control_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
Frame
Abstract

Check out this article in order to learn more details about the particularities involved by the Frame component and what you can do with it.

The i4designer Frame component allows the user with possibility to insert external or internal navigation links. This component can be used to integrate certain external functionality, that otherwise is not provided by the i4designer application.

Frame.jpg

The Frame 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 texts and states.

Example: Setpoint [OID]

Object_ID.jpg

Tooltip text

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

Tooltip_text.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. If the property is left empty, the component will be visible to all users.

This property is named "System authorization" for projects created on i4SCADA platform and "Permission" on i4connected platform projects.

System_authorization.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. If the property is left empty, the component will be visible to all users.

This property is named "Project authorization" for projects created on i4SCADA platform and "Role" on i4connected platform projects.

Project_authorization.jpg

Security access behavior

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.

Security_access_behavior.jpg

Layout

Layout mode

Sets the behaviour 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_small.jpg

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

Margin_large.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 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.

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.jpg

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

Opacity_slider.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

Navigation

Is external

Allows possibility to set the link target to external if property is set to True.

Is_external.jpg

Page link

The Url to an internal or external page or file, opened when clicking the Link button.

Page_link.jpg

Page parameters

Sets additional set of page parameters, each carrying their own set of properties. The user can add page parameters by clicking the Add new item button.

Page_parameters.jpg

In order to see the list of items the user can click on the Expand array list button:

Expand.jpg

Further more, the following actions are available for each item:

  • Move up move_up.jpg

  • Move down move_down.jpg

  • Remove item remove_state.jpg

Write item# Name

Sets the name of the signal that will be represented or manipulated by the component.

Write_item_name.jpg

Write item# Value

Sets the signal value that will be considered, at run-time, by the component.

Write_item_value.jpg

Palette

Background color

Sets the background color of the menu component. The user can either manually type in the HEX color code or use the color picker tool.

As the color palette is injected to this component by means of the default CSS class, applying this property the CSS class settings will be overwritten.

Background_color.jpg

Border color

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

As the color palette is injected to this component by means of the default CSS class, applying this property the CSS class settings will be overwritten.

Border_color.jpg

Style

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.

Border_width.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.

Control_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.

Control_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