Data types

ColorChannels

Defines the channels of a color format. Is an array of objects that have the following attributes and each describe a color channel:

Property	Data type	Description
`color`	`SolidColor`	Display color of the channel.
`maxValue`	`Number`	Upper limit of the allowed value range. The lower limit is always 0.
`float`	`Boolean`	Defines whether the channel is described by a float or by an integer.

Used, for example, in Color Control.

ColorSymbol

Defines a symbol with a ColorValue compatible data type.

ColorValue

Defines a value that can be interpreted as a color. Is either a number describing a grayscale value or a 3- or 4-element array describing a color with a corresponding number of channels.

Valid values are for example:

0
128
[0, 0, 255]
[0, 0, 255, 255]

Orientation

Defines the orientation of a display element. Possible values are "Horizontal" and "Vertical".

TcVnRotatedRectangle

Represents a rectangle, which can be rotated. Is an object with the following properties:

Property	Data type	Description
`aCenter`	`TcVnPoint2_REAL`	Center of the rectangle .
`fAngle`	`DINT`	Angle by which the rectangle is rotated.
`stSize`	`TcVnSize2_REAL`	Size of the rectangle around the center point.

ShapeType

Defines the type of selectable shape in Image Watch Control. Is an enum with the following values:

Point
Line
Square
Rectangle
Circle
Ellipse
Polygon

TcVnRectangle

Represents an axis-aligned rectangle and is an object with the following properties:

Property	Data type	Description
`nHeight`	`DINT`	Height of the rectangle.
`nWidth`	`DINT`	Width of the rectangle.
`nX`	`DINT`	X coordinate of the upper right corner.
`nY`	`DINT`	Y-coordinate of the upper right corner.

UsageMode

Defines the display and editability of display elements. Possible values:

Value	Description
Hidden	The element is not displayed.
ViewOnly	The element is displayed, but is not editable.
Editable	The element is displayed and editable.

Mainly used in Color Control.