SVG

The SVG component enables the uploading of custom SVG symbols, offering several customization options and multi-state functionality.

Quick Start

The SVG can be placed onto the dashboard by either dragging the component or selecting and drawing it in the work area. The Quick Start below demonstrates how to upload an SVG image into the SVG.

SVG: Quick Start

Generic Settings

Each IOTA Component has a set of generic settings shared among most of the components. The generic settings are described below:

Workspace

These settings are applicable to the whole view.

Grid Properties

The grid is provided for convenience when developing dashboards as visual guides and snapping capability.

Workspace Settings: Grid

By default the work area grid is enabled and can be customized or even disabled in this menu.

Property Name	Description
Grid Color	Color of the grid
Grid Size	Size of the grid step
Snap to Grid	Enable/Disable snapping to the grid
Show Grid Lines	Show the grid as lines
Show Grid Dots	Show the grid as dots

Align Controls

The Align controls provides a means to align and distribute selected objects on the display.

Workspace Settings: Align Controls

Align Objects

• You can align several components horizontally using the Align-left, Align-center or Align-right controls
• You can align several components vertically using the Align-top, Align-vertical-center or Align-bottom controls

Distribute Objects

• You can distribute several components on the vertical/horizontal axis by selecting them (select at least 3 components) and pressing Align-vertical/Align-horizontal
• You can make all the selected components the same width/height by selecting them and pressing Adjust Width/Adjust Height

Tips

Hold the Ctrl button to select several components. The eldest component is used as a reference.

Anchor Points Options

The anchor points are eight squares around an object that allow you to resize the object. The anchor point options allow you to define the appearance of the anchor points.

Workspace Settings: Anchor Points Options

Property Name	Description
Reference Point Color	Sets the color of the reference point (see Rotation and Position for more details)
Anchor Points Color	Sets the color of the rest of the seven anchor points
Point Options Color	Sets the color of the point options (only for Line and Bezier Curve)
Show Point Options	Show/Hide the point options

Locked View Options

These options define the appearance of the component border in the locked view for the selected component.

Workspace Settings: Locked View Options

Property Name	Description
Active Border Fill	Sets the fill color of the border
Active Border Width	Sets the width of the border

Variable

Variable Settings

Every component has a unique variable name. This variable name can be used to reference the component in multi-state configurations and other scripts.
On creation, every component is given a default name. This can be overwritten to be more user-friendly. To do so simply overwrite the value in the variable input field.

Arrange / Remove

Arrange / Remove Settings

• Send Backward - move object one layer down
• Bring Forward - move object one layer up
• Send to Back - place object under all layers
• Bring to Front - place object above all layers
  To send/bring objects to the front/back use the first four buttons.
• Any set of components can be deleted by either using the button or delete/del keyboard keys.

Rotation and Position

Rotation and Position Settings

• Reference Anchor Point - allows you to select one of the anchor points as a reference so that you can set an Angle (clockwise) of incline relative to this point. By default the reference anchor point is the top left corner. You can also rotate the component by dragging one of the yellow corner points.
• You can set the position of the component by setting the X and Y coordinates relative to theReference Anchor Point and the top-left corner of the work area.
• You can drag any of the anchor points to change the width and height of the component, or you can set it manually by editing the Width and Height boxes.
• Set Lock Aspect Ratio so that while changing width and height, the component width to height ratio stays the same
• Transform allows you to view the component as a mirror or a reflection of itself

Actions

Actions or multi-states are programmable conditional states handled by user-generated code.

Actions Settings

Note

Actions that have script handlers are marked with a circle

in the top right corner.

The currently supported actions are described in the table below:

Action	Trigger
OnCreate	When the component is created
OnFocus	When the component is selected
onClick	When the component is clicked or the selection is changed
onData	Each time the data changes for assigned channels
onTick	20 times per second
onDblClick	On mouse double click
onHover	When the mouse is over the component (and not when the mouse is not)

Further Reading

For helping you in writing your own actions, consider exploring the available Actions Deep Dive, as well as the Quick Start manual.
Also, multiple articles are available in Actions Section in IOTA's Knowledge Base.

Channels

The Channels section lists data that is assigned/mapped onto the component.
In this menu, you can change the data value color, adjust the display properties and un-assign or remove the data from the component.

Channels Menu

Properties

The properties menu for Channels allows you:

• to modify the Label of the DataSource
• to set UOM, lower and upper values
• to choose number format and displayed digits
• to adjust the line formatting for trend line components
• to configure the additional regression lines that can be plotted for supported components

Channels: Properties Menu

Supported Multi-state Parameters

Each of the the visual parameters listed below can be used as a multi-state, i.e. used in actions and scripts:

• Title and Text
  • Text
• Rotation and Position
  • Rotation
• Common
  • Blink
  • Hidden
• Visual Properties
  • Fill Option
  • Fill Color
  • Background Color
  • svg
• Tooltip
  • showCurrentValue
  • showlastValues
  • numberValues
  • showTimeRange
  • timeRangeInterval
  • Summary

SVG Settings

Visual Properties

The Visual Properties section provides options for customizing the component's appearance by changing the color schema.

SVG: Visual Properties

• Fill Option: Defines the fill style of the svg component (shaded, original, solid, none)
• Fill Color: Defines the fill color for the svg component
• Background Color: Defines the color of the area behind the component

To pick color of your interest

1. To change color for specific visual property, click on the color box next to property description. The color picker dialog will be displayed.

Visual Properties: Color Picker Dialog

2. Pick the color of interest. The video below shows how to choose a solid, gradient or theme color.

Color Picker Dialog: Workspace

You can add Gradient Stops by double clicking and to remove - by pulling it up.

3. To close the color-picker dialog - click on the property color box (Step 1).

Closing color-picker dialog

Clicking on the workspace area instead of Settings Tab area -
component settings will disappear since component focus will be lost.

Color Picker Dialog: Workspace

Tooltip

The Tooltip Setting provides data reference for PI AF attributes and descriptive statistics when user interacts with a component by hovering over it.

Tooltip Setting

• Show Current Value : Shows Current Value
• Show Archive Values : Shows Archive Values, the number can be set in Number Values
• Show Summaries : Shows Summaries for set Time Range Interval (can be set in seconds (s), minutes (m), hours (h), days (d), weeks (w), months (mo), years (y))

Summary Types :

• Average : the average value in the set period
• Minimum: the minimum value in the set period
• Maximum: the maximum value in the set period
• PercentGood: the percent good value in the set period
• StdDeviation: The standard deviation of the value in the set period
• PStdDeviation: The percent standard deviation of the value in the set period
• Total: The sum of the values in the set period
• Count: The number of data points in the set period
• Range: The difference between the largest and smallest value in the set period

Tooltip Setting: Example