i4designer Knowledgebase

Charts

Abstract

Here are the i4designer Charts components for your new project created on the i4connected platform.

The i4designer Charts category features the i4connected platform specific charts. More details can be found in the upcoming article.

Analysis chart
Abstract

Check out this article in order to learn more details about the i4designer Analysis chart component and the properties it features.

The i4designer Analysis chart component provides the user with possibility to graphically represent certain i4designer charts, on basis of an i4connected Objects Filter. More details about the configuration properties, can be found in the table below:

Analysis_chart.jpg

The Analysis chart component

Category

Property

Description

Configuration

Aggregate totals

If the toggle button is set to true all the measurements of the respective media and KPIs will be summed up.

Aggregate_totals.jpg

Areas

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add Areas filter patterns, the user can click the Expand array list button.

Expand_array_list_button_areas.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of Areas, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
View_list_of_areas.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple Areas, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

Auto update

Allows the user to specify whether the updating should happen automatically or not. When this option is enabled the chart pulls interval for data and updates it automatically. The Filter object property must be also filled, when enabling the Auto update property.

Auto_update.jpg

Chart date format

Selects the time and date format for the DateTime Signal values. Available tokens are - YYYY, YY, Y, Q, MM, MMM, MMMM, D, DD. Further information are available in the "Year, month, and day tokens" chapter under https://momentjs.com/docs/#/parsing/string-format/.

For example: M/d/yyyy

Chart_date_format.jpg

Chart title

Sets the title of the chart component.

Chart_title.jpg

Chart type

Sets the type of the chart, selecting from the drop-down list options: line, bar or stacked bar.

Chart_type.jpg

Devices

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add Devices filter patterns, the user can click the Expand array list button.

Expand_array_list_button_devices.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of Devices, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
List_of_devices.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple Devices, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

Direction

Sets the chart label direction measured in pixels. The value can be increased or decreased using the up / down arrows or manually added.

Direction.jpg

Display legend

Enables the chart legend display if property is set to True.

Display_legend.jpg

Display zoom area

Enables the display of the chart zoom area if property is set to True.

Display_zoom_area.jpg

KPIs

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add KPIs filter patterns, the user can click the Expand array list button.

KPIs.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of KPIs, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
KPIs_list_view.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple KPIs, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

Min Grid Distance

Sets the minimum distance supported by the chart grid.

Min_grid_distance.jpg

Organizational Units

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add Organizational Units filter patterns, the user can click the Expand array list button.

OrgUnits.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of Organizational Units, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
OrgUnits_list_view.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple Organizational Units, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

Resolution

Allows the user to select the resolution of the data rendered in the chart (the time interval between two consecutive measurements displayed on the time axis). The user can choose between five predefined resolutions (15 minutes, one hour, one day, one month and one year) or can set the option on Auto. When the Resolution is set to Auto, the system automatically adjusts the resolution based on the active Time range setting and the current zoom level.

Resolution.jpg

Sites

Allows the user to select one or multiple filtering patterns, for the run-time component's measurements. If an entity is used in multiple filter patterns, the duplicates will be automatically removed, resulting in a unique collection of i4connected entities. The filtering patterns support the wildcard filtering mechanism, by using the “*” wildcard.

To add Sites filter patterns, the user can click the Expand array list button.

Sites.jpg

The view is updated to display the Add new item button. As soon as the Add new item button is clicked, the user can click on the Expand the list button, to view the list of Sites, available for the current project.

Note

The list of entities is by default filtered to show all possible combinations. The "*" wildcard means "any".

wild_card.jpg
Sites_list_view.jpg

The user can define filter patterns, as follows:

  • by manually selecting one or multiple Sites, from the list view;

  • by inserting specific combinations of character patterns, using the "*" wildcard.

To preserve the selection, the Apply button needs to be clicked.

Time Range

Contains a set of time range configurations. By clicking the Expand array list button, a list of modular time range properties is exposed. Based on the selection made for the Date range property, the view is updated accordingly, as follows:

  • Date range Offset - allows the user to pick the current filter, on a specified date, using the design-time properties Start offset and End offset, by choosing the type (seconds, minutes, hours, days). Time frame is by default calculated and set.

    • Start offset interval - Allows the user to specify the start length offset measured in seconds, minutes, days, weeks, months or years.

    • Start offset - Allows the user to set the start offset interval.

    • End offset interval - Allows the user to set the end offset interval.

    • End offset - Allows the user to specify the end length offset measured in seconds, minutes, days, weeks, months or years.

    Offset.jpg
  • Date range Specific - allows the user to pick the desired time interval, using the Start date / End date calendar selectors.

    • Start date - sets the start date of the component measurement.

    • End date - sets the end date of the component measurement.

    Specific.jpg
  • Date range Day - allows the user to select the desired Day as time range, from the calendar view.

    • Date - sets the date range, to a specific day.

    Day.jpg
  • Date range Week - allows the user to select the desired Week as time range, from the calendar view.

    • Date - sets the date range, to a specific week.

    week.jpg
  • Date range Month - allows the user to select the desired Month as time range, from the calendar view.

    • Date - sets the date range, to a specific month.

    Month.jpg
  • Date range Year - allows the user to select the desired Year as time range, from the calendar view.

    • Date - sets the date range, to a specific year.

    year.jpg
  • Date range:

    • Current day - allows the user to select the current day, as time range. Time frame of 24 hours is by default calculated and set.

      Current_day.jpg
    • Current week - allows the user to select the current week, as time range. Time frame of 7 days is by default calculated and set.

      Current_week.jpg
    • Current month - allows the user to select the current month, as time range. Time frame is by default calculated and set.

      Curent_month.jpg
    • Current year - allows the user to select the current year, as time range. Time frame is by default calculated and set.

      Current_time_range.jpg
  • Date range Last day / Last week / Last month / Last year

    • Last day - allows the user to select the day before the current one. Time frame of 24 hours is by default calculated and set.

      Last_day.jpg
    • Last week - allows te user to select the week before the current one. Time frame of 7 days is by default calculated and set.

      Las_week.jpg
    • Last month - allows the user to select the month before the current one. Time frame is by default calculated and set.

      Last_month.jpg
    • Last year - allows the user to select the year before the current one, as time range. Time frame is by default calculated and set.

      Past_date_range.jpg

Tooltip date format

Allows the user to set the format of the date tooltip.

Tooltip_date_format.jpg

Update rate

Allows the user to specify the update rate in milliseconds. This property will be taken into consideration only if the Alarms Mode is set to Online.

Update_rate.jpg

X axis tooltip disabled

Allows the user to enable / disable the tooltip of the X axis.

X_axis_tooltip_disabled.jpg

Y axis min width

Allows the user to set the minimum width of the Y axis.

Y_axis_min_width.jpg

Y axis tooltip disabled

Allows the user to enable / disable the tooltip of the Y axis.

Y_axis_tooltip_disabled.jpg

Appearance

Padding right

Sets the right padding of the component. The padding value is expressed in pixels, allowing the user to either manually fill in the desired value or by using the up / down arrows.

Padding_right.jpg

Layout

Layout mode

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 Roles and Permissions properties.

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.

Palette

Background color

Sets the background color of the chart. 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

Header background

Sets the background color of the chart header. 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.

Header_background.jpg

Header foreground

Sets the foreground color of the chart header. 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.

Header_foreground.jpg

Typography

Header font family

Sets the font size of the chart title, displayed in the component header, using the up and down arrows to increase and decrease, or by manually typing the desired value.

Header_font_family.jpg

Header font size

Sets the font size of the chart title, displayed in the component header, using the up and down arrows to increase and decrease, or by manually typing the desired value.

header_font_size.jpg

Header font weight

header_font_weight.jpg

Sets the font thickness of the chart title, displayed in the component header, 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).

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

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