Bitmap Image

Introduction

A Bitmap Image displays picture consisting of a matrix of dots on a Graphic Page.

To add Bitmap Image to a graphic page do one of the following:

Use the Import File Tool.
Copy and paste an image using the clipboard. To do this:
1. Copy the source image to the clipboard.
2. Right-click the drawing canvas, then select Paste.

Bitmap Image Properties define how the picture appears on the graphic page.

When a Bitmap Image is selected, the Image Properties are shown in the Properties Window. To make changes, enter new values for the appropriate property.

Property List

A Bitmap Image supports 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.
	Tooltip	The text to display in a tooltip. To enter multiple lines of text, Click the Browse button . 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
Blink Attributes
	Blink	Whether the Bitmap Image blinks. A data binding configured in DataBindBlink will override this property.
	BlinkSpeed	Defines how fast the Bitmap Image blinks when blinking is enabled. The options are: Slow, Medium or Fast. Blinking is enabled using any of these options: The Blink Property is set to True. DataBindBlink evaluates to True. A script function calls GraphicItemSetBlink() with the Blink parameter set to True.
Fit & Alignment
	PreserveAspectRatio	When False the image is stretched to fit the space exactly. When True the image is padded or cropped to maintain its aspect ratio.
	HorizontalAlignment	Defines how the image should be aligned horizontally when PreserveAspectRatio is True: Left Center Right HorizontalAlignment has no effect when PreserveAspectRatio is False.
	VerticalAlignment	Defines how the image should be aligned vertically when PreserveAspectRatio is True: Top Center Bottom VerticalAlignment has no effect when PreserveAspectRatio is False.
	ImageFitMode	Defines how the image should should fill the available space when PreserveAspectRatio is True: Pad Image Crop Image ImageFitMode has no effect when PreserveAspectRatio is False.
General Data Bindings
	DataBindBlink	A Data Binding that causes the item to blink. If DataBindBlink evaluates to TRUE, the item will blink. Click the Browse button to edit the data binding using the Data Binding Editor.
	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.
	DataBindVisible	A Data Binding which hides the item. If DataBindVisible is defined, and evaluates to FALSE, the item is hidden. 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 sets whether the left or right side of the item is clipped.
	ClipRegionVertical	When the DataBindClipVertical data binding is defined, this value sets whether the top or bottom of the item is clipped.
	DataBindClipHorizontal	A Data Binding which sets 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 sets 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 image 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 image from its original position by the number of degrees. Click the Browse button to edit the data binding using the Data Binding Editor.
	DataBindRotationSpeed	A Data Binding which causes the image to rotate by the 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.
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.

Fit & Alignment Properties

A Bitmap Image may not fit the allocated space on the graphic page. The Fit & Alignment properties define how the Bitmap Image should be displayed when this happens.

When PreserveAspectRatio is False, the Bitmap Image is stretched to fit the available space:

Shows how bitmap images are stretched to fit the available space when PreserveAspectRatio is False.

When PreserveAspectRatio is True, the aspect ratio of the Bitmap Image is preserved. The HorizontalAlignment, VerticalAlignment and ImageFitMode define how the Bitmap Image is displayed. For example when there is more space available horizontally:

Shows how the Fit and Alignment Properties affect bitmap images when there is more space available horizontally.

When there is more space available vertically:

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.