Shape Properties

Introduction

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

Outline only
Filled only
Both filled and outlined.

To draw shapes use one of these tools:

Shape Properties define how the shape appears on the graphic page. For example:

The LineColor property defines the color of the shape outline.
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, enter new values for the appropriate property.

Property List

All Shapes support these properties:

Identification
	Label	An optional label to attach to the item.
Properties
	Comment	A place 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
	Tooltip	The text to display in a tooltip. To enter multiple lines of text, Click the Browse button . Note: A data binding configured in DataBindTooltip will override this property.
	Visible	The initial visibility in run mode. To dynamically display or hide the item use one of these: DataBindVisible Data Binding GraphicItemSetVisible Function
Line Attributes
	LineWidth	The width of the line in canvas units.
	LineColor	The line color. See Color Values for the different ways you can configure a color. This property supports the color value 'Auto', which selects a contrast color to the graphic page background color.
	LineJoinType	How thick lines are joined: Bevel, Miter, or Round.
	LineJoinMiterLimit	How far to project the miter when the LineJoinType is Miter. The miter can be very long when the angle between two connected lines is small. This property defines the upper limit for miter length. LineJoinMiterLimit uses canvas units.
	LineCapStart	For thick lines how the start point is terminated. Does not apply to closed shapes.
	LineCapEnd	For thick lines how the end point is terminated. Does not apply to closed shapes.
Fill Attributes
	FillColor	Defines the fill color of the shape. Fill colors can be solid or a gradient fill with up to 6 gradient stops.
	FillColorGradientType	When FillColor is a gradient color, this property defines the type of gradient: Linear Gradient Radial Gradient
	FillGradientAngle	For a Linear Gradient, the angle of the gradient fill (in degrees). The angle is measured in relation to vertical. When FillGradientAngle is zero or 180 degrees, the boundaries between colors are vertical. When FillGradientAngle is +90 or -90 degrees, the boundaries between colors are horizontal. Does not apply to a Radial Gradient.
Line Blink Attributes
	LineBlink	Whether the Shape Line blinks. A data binding configured in DataBindLineBlink will override this property.
	LineBlinkColor	The alternate line color when the LineBlinkMode is Alternate Color.
	LineBlinkMode	Defines how the Shape Line blinks. The options are: Invisible Alternate Color
	LineBlinkSpeed	Defines how fast the Shape Line blinks. The options are: Slow Medium Fast
Fill Blink Attributes
	FillBlink	Whether the Shape Fill blinks. A data binding configured in DataBindFillBlink will override this property.
	FillBlinkColor	The alternate fill color when the FillBlinkMode is Alternate Color. This property can be a solid color, or a gradient fill color with up to 6 gradient stops. Notes: If you define more gradient stops in FillBlinkColor than FillColor, the extra stops are ignored. If you define fewer gradient stops in FillBlinkColor than FillColor, the missing stops are copied from FillColor.
	FillBlinkMode	Defines how the Shape Fill blinks. The options are: Invisible Alternate Color
	FillBlinkSpeed	Defines how fast the Shape Fill blinks. The options are: Slow Medium Fast
General Data Bindings
	DataBindDisableActions	A Data Binding to disable all actions on the item. If DataBindDisableActions evaluates to TRUE, actions on the item are disabled. Click the Browse button to edit the data binding using the Data Binding Editor.
	DataBindTooltip	A Data Binding which sets 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 to edit the data binding using the Data Binding Editor.
Size Position Data Bindings
	ClipRegionHorizontal	When the DataBindClipHorizontal data binding is defined, this value chooses whether the left or right side of the item is clipped.
	ClipRegionVertical	When the DataBindClipVertical data binding is defined, this value chooses whether the top or bottom of the item is clipped.
	DataBindClipHorizontal	A Data Binding which defines 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 to edit the data binding using the Data Binding Editor.
	DataBindClipVertical	A Data Binding which defines 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 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 in canvas units. Click the 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 in canvas units. Click the 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 a number of degrees. Click the Browse button to edit the data binding using the Data Binding Editor.
	DataBindRotationSpeed	A Data Binding which causes the shape to rotate a number of degrees per second. Click the 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 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 to edit the data binding using the Data Binding Editor.
Fill Data Bindings
	DataBindFillBlink	A Data Binding that causes the shape fill to blink. If DataBindBlink evaluates to TRUE, the shape fill will blink. Click the 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 to edit the data binding using the Data Binding Editor.
	DataBindFillVisible	A Data Binding which hides the shape fill. If DataBindVisible is defined, and evaluates to FALSE, the shape fill is hidden. Click the Browse button to edit the data binding using the Data Binding Editor.
	FillColorDataBoundStops	Defines which gradient stops are changed by the DataBindFillColor data binding.
Line Data Bindings
	DataBindLineBlink	A Data Binding that causes the shape line to blink. If DataBindBlink evaluates to TRUE, the shape line will blink. Click the 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 to edit the data binding using the Data Binding Editor.
	DataBindLineVisible	A Data Binding which hides the shape line. If DataBindVisible is defined, and evaluates to FALSE, the shape line is hidden. Click the 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 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 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 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 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 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 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:

Bevel
Miter
Round

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.