Shape Item

Introduction

A shape is a sequence of lines and curves to defined a 2-dimensional item. Shapes can be drawn as:

To draw simple shapes use one of the Add Shape Tools.

To draw complex shapes use the Drawing Wizard to select a symbol from a library.

Shape Properties

Shape Properties define how the shape appears on the graphic page. For example, the FillColor property defines the color of the shape interior.

When one or more shapes are selected, the Shape Properties are shown in the Properties Window. To make changes just enter new values for the appropriate property.

All Shapes support these properties:

Properties
Comment A field to store notes and information about the item. The comment property has no effect on how the item is displayed or behaves.
Style How the shape is drawn: Line Only, Fill Only, Line and Fill.
Visible The initial visibility in run mode. To dynamically display or hide the item use the DataBindVisible data binding, or the GraphicItemSetVisible() function.
Line Attributes
LineCapEndFor thick lines how the end point is terminated. Does not apply to closed shapes.
LineCapStartFor thick lines how the start point is terminated. Does not apply to closed shapes.
LineColorThe line color.
LineJoinTypeHow thick lines are joined: Bevel, Miter, or Round.
LineWidthThe width of the line in canvas units.
Fill Attributes
FillColorDefines the fill color of the shape. Fill colors can be solid or a gradient fill.
FillColorDataBoundStopsDefines which gradient stops are changed by the DataBindFillColor data binding.
FillGradientAngleFor gradient fills, the angle of the gradient fill (in degrees).
Blink Attributes
BlinkFillColorThe alternate fill color when the blink mode is Alternate Color.
BlinkLineColorThe alternate line color when the blink mode is Alternate Color.
BlinkModeDefines how the shape item blinks: Invisible or Alternate Color.
BlinkSpeedDefines how fast the shape item blinks: Slow, Medium or Fast.
General Data Bindings
DataBindDisableActions A Data Binding which if evaluates to TRUE disables all actions on this item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindTooltip A Data Binding which specifies the tooltip to display if a user hovers the cursor over the item. Note: Tooltips are not currently supported in the Android Operator Interface.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Size Position Data Bindings
ClipRegionHorizontal When the DataBindClipHorizontal data binding is defined, this value specifies whether the left or right side of the item is clipped.
ClipRegionVertical When the DataBindClipVertical data binding is defined, this value specifies whether the top or bottom of the item is clipped.
DataBindClipHorizontal A Data Binding which specifies how much of the item to clip horizontally. A value less than or equal to zero clips the entire item. A value greater than or equal to one does not clip the item. Values between zero and one clip the corresponding portion of the item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindClipVertical A Data Binding which specifies how much of the item to clip vertically. A value less than or equal to zero clips the entire item. A value greater than or equal to one does not clip the item. Values between zero and one clip the corresponding portion of the item.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindOffsetX A Data Binding which moves the item in the horizontal direction. The offset is specified in canvas units.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindOffsetY A Data Binding which moves the image in the vertical direction. The offset is specified in canvas units.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindRotation A Data Binding which rotates the shape from its original position by the specified number of degrees.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindRotationSpeed A Data Binding which causes the shape to rotate the specified number of degrees per second.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindScaleX A Data Binding which resizes the image in the horizontal direction. A value less than 1.0 shrinks the item horizontally. A value greater than 1.0 expands the item horizontally.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindScaleY A Data Binding which resizes the image in the vertical direction. A value less than 1.0 shrinks the item vertically. A value greater than 1.0 expands the item vertically.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Fill Data Bindings
DataBindFillBlink A Data Binding which if evaluates to TRUE causes the shape fill to blink.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindFillColor A Data Binding which determines the fill color.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindFillVisible A Data Binding which if evaluates to FALSE hides the shape fill.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Line Data Bindings
DataBindLineBlink A Data Binding which if evaluates to TRUE causes the shape line to blink.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindLineColor A Data Binding which determines the line color.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
DataBindLineVisible A Data Binding which if evaluates to FALSE hides the shape line.
Click the Browse button Property browse button to edit the data binding using the Data Binding Editor.
Actions
ActionButtonDown An Operator Action script to run when the operator presses the left mouse button down, or touches the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionButtonShortcut A keyboard shortcut to emulate a button press on the item. Click the Browse button Property browse button to edit the shortcut using the Shortcut Editor.
ActionButtonUp An Operator Action script to run when the operator releases the left mouse button, or removes touch from the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionButtonWhileDown An Operator Action script to run at intervals while the operator holds the left mouse button down, or continuously touches the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionDoubleClick An Operator Action script to run when the operator double clicks the left mouse button, or double taps the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
ActionContextMenu An Operator Action script to run when the operator clicks the right mouse button, or does a long press on the display.
Click the Browse button Property browse button to edit the operator action using the Operator Action Editor.
WhileDownInterval The interval between each execution of the ActionButtonWhileDown script.

LineJoinType

The LineJoinType property defines how thick lines (more than 3 pixels wide) are drawn:

BevelBevel line join
MiterMiter line join
RoundRound line join

Further Information

Data Bindings

For a complete description of all data binding options.

Graphic Editor Toolbar

For the different tools available to edit graphic pages.

Graphic Editor

For information about editing graphic pages in Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.