accessPassword
Accepts values: string
(deprecated) When set, this password is required to use the component.
Used in:
Dynamic Panel
Embedded Web Browser
Knob Input
Listbox Input
Numeric Input
PDF Viewer
Pointer Slide
Push Button
Remote Desktop Viewer
Screen
Text Input
Video Viewer
accessTimeout
Accepts values: seconds (int)
(deprecated) When set, this will persist authorization for access to the component for the time specified.
Used in:
Dynamic Panel
Embedded Web Browser
Knob Input
Listbox Input
Numeric Input
PDF Viewer
Pointer Slide
Push Button
Remote Desktop Viewer
Screen
Text Input
Video Viewer
allowedGroups
Accepts values: int
Integer value for which groups should be allowed to interact with this component.
Used in:
Dynamic Panel
Embedded Web Browser
Knob Input
Listbox Input
Numeric Input
PDF Viewer
Pointer Slide
Push Button
Remote Desktop Viewer
Screen
Text Input
Video Viewer
allowPLC
Accepts values: true, false
Defines whether a PLC can override the User Access system when calling this screen.
Used in:
alwaysOnTop
Accepts values: boolean
When true, this overlay will always be displayed over other overlays that do not have this property set to true, even if those overlays are triggered later.
Used in:
appendTag
Accepts values: tag
When the value of this tag is 1, write operations will append to the file. When 0, the file is overwritten.
Used in:
authorize
Accepts values: freeAccess, useLoggedUser, onEachAccess
Determines access protections for this component.
Used in:
Dynamic Panel
Embedded Web Browser
Knob Input
Listbox Input
Numeric Input
PDF Viewer
Pointer Slide
Push Button
Remote Desktop Viewer
Screen
Text Input
Video Viewer
autoLoop
Accepts values: true, false
If true, then video will automatically loop when ended.
Used in:
autorepeat
Accepts values: true, false
When true, the action of the button will be repeated while the button is held.
Used in:
Listbox Input Buttons
Numeric Input Buttons
Push Button
autorepeatDelay
Accepts values: int (milliseconds)
When autorepeat is enabled, this specifies the delay in milliseconds before the action is repeated.
Used in:
Listbox Input Buttons
Numeric Input Buttons
Push Button
autorepeatPeriod
Accepts values: int (milliseconds)
When autorepeat is enabled, this specifies the delay between repeating the action of the button.
Used in:
Listbox Input Buttons
Numeric Input Buttons
Push Button
backBlink
Accepts values: true, false
When true, the background will blink between backColor and blinkColor.
Used in:
Multistate Indicator
Push Button
backcolor
Accepts values: color
Sets background color. Images are allowed to set this to transparent to support images with alpha masks.
Used in:
Back Screen
Combo-box Input
Config Screen
Database Table
Dial
Dynamic Panel
Fill Slide
Goto Screen
Image
Knob Input
Listbox
Listbox Input
Listbox Input Buttons
Multistate Indicator
Numeric Input
Numeric Input Buttons
Numeric Output
Pointer Slide
Push Button
Remote Desktop Viewer
Screen
Text Input
Text Output
Video Viewer
barColor
Accepts values: color
Sets the color of the value-bar.
Used in:
beginArrow
Accepts values: true, false
When true, an arrow will be displayed at the beginning point.
Used in:
beginPoint
Accepts values: x, y (ints)
Sets x and y position of the beginning point on the line.
Used in:
beginX
Accepts values: tag
Sets the screen X position of the beginning point. OI writes the start value from the OI application file and then reads updated values to move the component position.
Used in:
beginY
Accepts values: tag
Sets the screen Y position of the beginning point. OI writes the start value from the OI application file and then reads updated values to move the component position.
Used in:
blinkColor
Accepts values: color
Sets the color the background will change to while blinking.
Used in:
Multistate Indicator
Push Button
borderWidth
Accepts values: int (pixels)
Set the size of the border in pixels. 0 removes the border.
Used in:
Listbox
Listbox Input
Multistate Indicator
Numeric Input
Numeric Output
Push Button
Static Text
Text Input
Text Output
buttonBackColor
Accepts values: color
Sets the color of the drop-down buttons background.
Used in:
buttonForeColor
Accepts values: color
Sets the color of the drop-down buttons arrow.
Used in:
camID
Accepts values: string
String that will be stored with the image in the database to designate which Camera was written. Can be used later to filter.
Used in:
clickThrough
Accepts values: true, false
When true, click/touch events are passed through this element to elements underneath. This can be used to allow portions of an image to be buttons without needing a button to be displayed over that section of image.
Used in:
Circle
Dial
Fill Slide
Image
Line
Listbox
Listbox Input
Multistate Indicator
Numeric Output
Rectangle
Static Text
Text Output
client
Accepts values: vnc, rdesktop
Specifies whether to connect using VNC or Remote Desktop.
Used in:
closeTriggerOnEvent
Accepts values: ZeroToNonZero, AnyChange
Determines when a change in the triggerTag will be used to trigger an action. ZeroToNonzero will trigger only when the tag value goes from zero to a non-zero value, and anyChange will trigger on any change in value.
Used in:
closeTriggerTag
Accepts values: tag
Component will watch this tag to determine whether to trigger an action. See closeTriggerOnEvent property.
Used in:
color
Accepts values: color
Sets the color of the lines.
Used in:
Circle
Line
Rectangle
Static Text
column:colHeading
Accepts values: string
Static text for the header of this column.
Used in:
column:dbColName
Accepts values: string
This sets the column name from the database table that should be displayed.
Used in:
column:readOnly
Accepts values: true, false
When true, this will overwrite the readOnly setting from the DB Table element for this column.
Used in:
column:width
Accepts values: int
Width in pixels for display.
Used in:
confirmationPanelNumber
Accepts values: int
The dynamic screen number that will be shown when the push button is pressed.
Used in:
Back Screen
Config Screen
Goto Screen
Push Button
confirmationReadTag
Accepts values: tag
The tag that will be watched when the confirmation panel is shown. If the tag evaluates to 1 then the push button that triggered the panel writes the writeValue to its writeTag. If the tag evaluates to 2 then the panel is closed and no value is written.
Used in:
Back Screen
Config Screen
Goto Screen
Push Button
currentRecordTag
Accepts values: tag
Sets the value of the tag to the index of the record shown, usually the findRecordsTag value. If findRecordsTag is greater than total number of records, this will be the index of the record retrieved. So, if a table has 10 rows, and findRecordsTag is set to 20, the currentRecordsTag will read 11. 1
Used in:
Database Edit
Database Read
dataSourceSQL
Accepts values: string
SQL query providing data for this component. DB Read can accept a table name. DB Edit accepts only tablenames.
Used in:
DB Connection databaseName
Accepts values: string
Sets the name of the database to connect to.
Used in:
DB Connection driver
Accepts values: DB Driver
Sets the database driver to use.
Used in:
DB Source databaseSource
Accepts values: DB Source
Sets which of the sources to use from the Database Sources dialog.
Used in:
Database Edit
Database Image Viewer
Database Image Write
Database Read
Database Write
decimalPointPosition
Accepts values: int (-1, 0, 1+)
Sets the number of digits that appear to the right of the decimal point. 0 will disable the decimal point, and -1 will attempt to automatically place the decimal based on the value of the number. When decimals are set, number values are rounded to fit, so 1.49 displayed on an input with 0 decimal places will be displayed as 1 and on an input with 1 decimal place will be displayed as 1.5. On inputs, numbers can be input manually on the keypad using more precision than the display shows: an input with 0 decimal places will accept 1.49 as a value and write 1.49 to the tags value but will show 1.
Used in:
Numeric Input
Numeric Output
description
Accepts values: string
A space to provide a description of the current component, useful for documenting intent.
Used in:
Back Screen
Browser
Camera Image Viewer
Camera RTSP Video Viewer
Circle
Combo-box Input
Config Screen
CSV File Read
CSV File Write
Database Edit
Database Image Viewer
Database Image Write
Database Read
Database Table
Database Write
Dial
Dynamic Panel
Embedded Video Player
Embedded Web Browser
Fill Slide
Generic Run
Goto Screen
HTTP Script
Image
Knob Input
Line
Listbox
Listbox Input
Multistate Indicator
Numeric Input
Numeric Output
Panel Selector
PDF Viewer
Pointer Slide
Push Button
Rectangle
Remote Desktop Viewer
Screen
Shell Script
Static Text
Tag Copy
Text Input
Text Output
Video Viewer
dialColor
Accepts values: color
Sets the color of the center of the dial.
Used in:
disabledColor
Accepts values: color
Sets color of text when this input is disabled.
Used in:
disableTag
Accepts values: tag
When tag value is an integer other than zero, interaction with this component is disabled.
Used in:
endArrow
Accepts values: true, false
When true, an arrow will be displayed at the ending point.
Used in:
endPoint
Accepts values: x, y (ints)
Sets x and y position of the ending point on the line.
Used in:
endX
Accepts values: tag
Sets the screen X position of the ending point. OI writes the start value from the OI application file and then reads updated values to move the component position.
Used in:
endY
Accepts values: tag
Sets the screen Y position of the ending point. OI writes the start value from the OI application file and then reads updated values to move the component position.
Used in:
execArguments
Accepts values: string
Additional arguments that will be added to the end of the execution string.
Used in:
executable
Accepts values: string
The command line program that will be executed with this component.
Used in:
executeOnStartup
Accepts values: true, false
When true, the script will be executed once on application start. No input tags are passed into the script when executed on startup. A parameter named _STARTUP_ is passed to the script with value 1 ($_POST['_STARTUP_']==1 is true).
Used in:
executeTemplate
Accepts values: User_Specified, Windows_Chrome
OIB Functionality only – when set will auto-populate fields based on the template.
Used in:
featureIDTag
Accepts values: tag
Tag specifies where the featureID data will be read from. This is stored with the image in the database.
Used in:
fieldWidth
Accepts values: int
Sets the number of integers that the component will display/accept. If the number of digits is larger than this then the # symbol will be displayed in its place. Note: the decimal point is considered a digit itself.
Used in:
Numeric Input
Numeric Output
fileLocation
Accepts values: USB_Flash, HardDrive, InternalFlash
Specifies where the file should be stored.
Used in:
CSV File Read
CSV File Write
fileName
Accepts values: string
Name of file to use for read or write operation.
Used in:
CSV File Read
CSV File Write
fileNameTag
Accepts values: tag
When set, file operations will use the value of this tag for the filename.
Used in:
CSV File Read
CSV File Write
fillColor
Accepts values: color
Sets the color of the filled in area.
Used in:
Circle
Rectangle
Static Text
filled
Accepts values: true, false
When true, the shape will be filled with the fillColor.
Used in:
Circle
Rectangle
Static Text
fillWithZeroes
Accepts values: true, false
When true, the number will be prepended with zeros up to fieldWidth.
Used in:
Numeric Input
Numeric Output
filter
Accepts values:
When readOnly is false, this will filter the results. Valid entries are SQL expressions.
Used in:
findRecordTag
Accepts values: tag
When set to non-zero, will select the nth entry from the results. For writes, this will overwrite the nth entry from the datasource. Effectively applies an offset to the selection query.
Used in:
Database Edit
Database Read
Database Write
foreBlink
Accepts values: true, false
When true, text will blink between transparent and foreColor.
Used in:
Multistate Indicator
Push Button
foreColor
Accepts values: color
Sets foreground color (usually text).
Used in:
Back Screen
Combo-box Input
Config Screen
Database Table
Goto Screen
Image
Listbox
Listbox Input
Listbox Input Buttons
Multistate Indicator
Numeric Input
Numeric Input Buttons
Numeric Output
Push Button
Remote Desktop Viewer
Text Input
Text Output
Video Viewer
fullScreen
Accepts values: true, false
When true, the video will be scaled to show fullscreen. When false, the video will be shown at original size.
Used in:
geometry
Accepts values: x, y, width, height (ints)
Sets the visible geometry of the component: x and y from top left corner, and width/height. Editing these values can be useful when positioning/sizing finer than grid snap is needed.
Used in:
Back Screen
Browser
Camera Image Viewer
Camera RTSP Video Viewer
Circle
Combo-box Input
Config Screen
CSV File Read
CSV File Write
Database Edit
Database Image Viewer
Database Image Write
Database Read
Database Table
Database Write
Dial
Embedded Video Player
Embedded Web Browser
Fill Slide
Generic Run
Goto Screen
HTTP Script
Image
Knob Input
Listbox
Listbox Input
Listbox Input Buttons
Multistate Indicator
Numeric Input
Numeric Input Buttons
Numeric Output
Panel Selector
PDF Viewer
Pointer Slide
Push Button
Rectangle
Remote Desktop Viewer
Shell Script
Static Text
Tag Copy
Text Output
Video Viewer
gotoScreenNum
Accepts values: int
Sets the screen number that will be displayed when button is pushed.
Used in:
grid
Accepts values: x, y
(deprecated) Defines the x/y spacing of grid in OI.
Used in:
hAlignment
Accepts values: Left, Right, HCenter
Sets how the text is aligned on the component horizontally: left, right, or centered.
Used in:
Numeric Input
Numeric Output
Static Text
Text Input
Text Output
hasCloseButton
Accepts values: true, false
When true, a close button is overlayed which will close the application being run.
Used in:
hasRaiseOIButton
Accepts values: true, false
When true, a button labeled OI is shown in the bottom left that, when pressed, will return OI as the currently displayed application. The application will still be open.
Used in:
headerBackColor
Accepts values: color
Sets background color for the row/column headings.
Used in:
headerForeColor
Accepts values: color
Sets the color of text for the row/column headings.
Used in:
hidden
Accepts values: true, false
When true, the component will not be visible on the screen.
Used in:
Multistate Indicator
Push Button
hideTag
Accepts values: tag
When tag value is an integer other than zero, the component is not displayed on the screen.
Used in:
Back Screen
Camera Image Viewer
Camera RTSP Video Viewer
Circle
Combo-box Input
Config Screen
Database Image Viewer
Database Table
Dial
Embedded Video Player
Embedded Web Browser
Fill Slide
Goto Screen
Image
Knob Input
Line
Listbox
Listbox Input
Multistate Indicator
Numeric Input
Numeric Output
Pointer Slide
Push Button
Rectangle
Remote Desktop Viewer
Static Text
Text Input
Text Output
Video Viewer
highlightForeColor
Accepts values: color
Sets text color for selected list item.
Used in:
Combo-box Input
Listbox
Listbox Input
hightlightBackColor
Accepts values: color
Sets background color for selected list item.
Used in:
Combo-box Input
Listbox
Listbox Input
holdTime
Accepts values: int (milliseconds)
When set to non-zero, the button will be held in the pushed state for this many milliseconds.
Used in:
homeUrl
Accepts values: string
Url that is loaded at startup and on reloads.
Used in:
host
Accepts values: string
Sets the host remote desktop server to connect to.
Used in:
image
Accepts values: image
The image that will be displayed. Images are selected from the applications image collection.
Used in:
Back Screen
Config Screen
Goto Screen
Image
Listbox Input Buttons
Multistate Indicator
Numeric Input Buttons
PDF Viewer
Push Button
Remote Desktop Viewer
Video Viewer
imageSource
Accepts values: string
URL for image, or local path to image device (such as /dev/video0 )
Used in:
imageUrl
Accepts values: string
Sets the URL for the image to be displayed.
Used in:
incDecButtons
Accepts values: true, false
When true, increment and decrement buttons are shown with the component. False will not display these buttons.
Used in:
indexChangeUpdatesDst
Accepts values: true, false
When true, changes to the indexTag will trigger copy events, when false a trigger is needed to execute.
Used in:
indexColumn
Accepts values:
When readOnly is false, this will sets the index column of the table. Defaults to __id__ (OI automatically creates this column is using DB Write to create entries).
Used in:
indexGroupReadTag
Accepts values: tag
Writes the number of tags read to this tag.
Used in:
indexGroupToReadTag
Accepts values: tag
When set to non-zero, offsets which rows to read in the file by this tags value times number of tags in the taglist.
Used in:
indexTag
Accepts values: tag
When set, only the nth set of tag-copy items will be executed.
Used in:
indexTagOffset
Accepts values: int
Offsets the index tag for tag copy. Helpful to use -1 so that indexTag=1 will copy the first item (tag-copy starts at index 0).
Used in:
inputTags
Accepts values: list of tags
Semicolon separated list of tags that will be sent to the script. Each entry can be a tag, a tag mapped to a separate name (tag > script_tag), or a constant (“text” > script_tag).
Used in:
isDoneTag
Accepts values: tag
Tag specifies where the component will write its status to. See details for each component.
Used in:
CSV File Read
CSV File Write
HTTP Script
Shell Script
isModal
Accepts values: boolean
When true, this overlay will visually dim the underlying screen and prevent interactions with elements outside the overlay.
Used in:
isOverlay
Accepts values: boolean
Property for screen that determines whether the screen acts as an overlay instead of a normal screen.
Used in:
keypad
Accepts values: true, false
When true, will display numeric keypad for entry. False will not display the keypad.
Used in:
knobColor
Accepts values: color
Sets the color of the button used to slide.
Used in:
knobMarkerColor
Accepts values: color
Sets the color of the position indictor on the knob.
Used in:
labelText
Accepts values: text
Sets the text that is displayed on the dials label.
Used in:
lineWidth
Accepts values: int (pixels)
Sets the width of the line in pixels.
Used in:
maxMajorTicks
Accepts values: int
Sets the maximum of major tick marks on the displays scale.
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
maxMinorTicks
Accepts values: int
Sets the maximum of minor tick marks on the displays scale.
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
maxValue
Accepts values: int
Sets the maximum value the component will accept. If a larger value is entered manually an error will be displayed and keypad shown again.
Used in:
maxValueTag
Accepts values: tag
When set, the component will read the value in this tag and use that for the maxValue value.
Used in:
mayOpenFile
Accepts values: true, false
When true, operators can navigate and open other files.
Used in:
minValue
Accepts values: int
Sets the minimum value the component will accept. If a lesser value is entered manually an error will be displayed and keypad shown again.
Used in:
minValueTag
Accepts values: tag
When set, the component will read the value in this tag and use that for the minValue value.
Used in:
monoImage
Accepts values: true, false
When true, converts the image to black and white.
Used in:
Back Screen
Config Screen
Goto Screen
Image
Listbox Input Buttons
Multistate Indicator
Numeric Input Buttons
PDF Viewer
Push Button
Remote Desktop Viewer
Video Viewer
multistate
Accepts values: true, false
When true, some of this component’s properties can be changed based on the state of the readvalue.
Used in:
multiStatePushButton
Accepts values: true, false
When true, the push button will also act as a multi-state indicator. Each state can have its own display and push/release values.
Used in:
name
Accepts values: string
Provide a name for the component. This can be helpful when using the "Used Components" tool in the tag editor.
Used in:
Back Screen
Browser
Camera Image Viewer
Camera RTSP Video Viewer
Circle
Combo-box Input
Config Screen
CSV File Read
CSV File Write
Database Edit
Database Image Viewer
Database Image Write
Database Read
Database Table
Database Write
Dial
Dynamic Panel
Embedded Video Player
Embedded Web Browser
Fill Slide
Generic Run
Goto Screen
HTTP Script
Image
Knob Input
Line
Listbox
Listbox Input
Multistate Indicator
Numeric Input
Numeric Output
Panel Selector
PDF Viewer
Pointer Slide
Push Button
Rectangle
Remote Desktop Viewer
Screen
Shell Script
Static Text
Tag Copy
Text Input
Text Output
Video Viewer
needleColor
Accepts values: color
Sets the color of the value-indicating needle.
Used in:
numOfColumns
Accepts values: int
Sets the number of columns to display. Leave at 0 to auto-detect. When non-zero, properties are added to this component to specify the format of each column.
Used in:
offset
Accepts values: x, y (ints)
Distance image will be translated.
Used in:
Image
Multistate Indicator
offsetEnabled
Accepts values: true, false
Defines if offset property should be taken into account or should be ignored (applicable only for Multi-state indicator – images are placed by default in the center of the component).
Used in:
openTriggerOnEvent
Accepts values: ZeroToNonZero, AnyChange
Determines when a change in the triggerTag will be used to trigger an action. ZeroToNonzero will trigger only when the tag value goes from zero to a non-zero value, and anyChange will trigger on any change in value.
Used in:
openTriggerTag
Accepts values: tag
Component will watch this tag to determine whether to trigger an action. See openTriggerOnEvent property.
Used in:
orderBy
Accepts values:
When readOnly is false, this will set the ordering of rows. Valid entries are names of the column.
Used in:
orientation
Accepts values: Horizontal, Vertical
Sets the orientation of the component between a vertical slide or horizontal slide.
Used in:
outputTags
Accepts values: list of tags
Semicolon separated list of tags that will be read from the script. Each entry can be a tag, or a script tag mapped to an oi tag (oi_tag < script_tag).
Used in:
partIDTag
Accepts values: tag
Tag specifies where the partID data will be read from. This is stored with the image in the database.
Used in:
password1
Accepts values: string
(deprecated) When set, this password is required to use the component. Up to 5 passwords can be set for this component. If all are left blank, this method of authentication is not enabled.
Used in:
Back Screen
Config Screen
Goto Screen
password2
Accepts values: string
(deprecated) When set, this password is required to use the component. Up to 5 passwords can be set for this component. If all are left blank, this method of authentication is not enabled.
Used in:
Back Screen
Config Screen
Goto Screen
password3
Accepts values: string
(deprecated) When set, this password is required to use the component. Up to 5 passwords can be set for this component. If all are left blank, this method of authentication is not enabled.
Used in:
Back Screen
Config Screen
Goto Screen
password4
Accepts values: string
(deprecated) When set, this password is required to use the component. Up to 5 passwords can be set for this component. If all are left blank, this method of authentication is not enabled.
Used in:
Back Screen
Config Screen
Goto Screen
password5
Accepts values: string
(deprecated) When set, this password is required to use the component. Up to 5 passwords can be set for this component. If all are left blank, this method of authentication is not enabled.
Used in:
Back Screen
Config Screen
Goto Screen
passwordMode
Accepts values: true, false
When true, the value of the readTag is obscured.
Used in:
Numeric Input
Numeric Output
Text Input
Text Output
playSound
Accepts values: true, false
When true, the video player will play the audio. When false, the audio is muted.
Used in:
playVideoTag
Accepts values: tag
When non-zero, this component will attempt to play the video at the specified feed. When zero, no content will be loaded or displayed.
Used in:
Camera RTSP Video Viewer
Embedded Video Player
printCharsPerLine
Accepts values: int
Specifies how many characters will be printed on a single line.
Used in:
printColumnSeparator
Accepts values: string
Defines the separator between columns.
Used in:
printHeader
Accepts values: true, false
When true, a header containing the names of the tags will be written.
Used in:
printToPrinterOnPort
Accepts values: Disabled, LPT*, COM*, USB*, USBToSerial*
Specifies which serial port to send print commands to.
Used in:
pushValue
Accepts values: int
This sets the value that will be written to the writeTag when the button is in the pushed state.
Used in:
rangeMax
Accepts values: int
Sets the maximum value the dial/slide displays.
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
rangeMaxTag
Accepts values: int
Defines the rangeMax value of the component from the value of this tag.
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
rangeMin
Accepts values: int
Sets the minimum value the dial/slide displays.
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
rangeMinTag
Accepts values: int
Defines the rangeMin value of the component from the value of this tag.
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
rdesktopPassword
Accepts values: string
Sets the password to be used to connect to the remote computer.
Used in:
rdesktopUser
Accepts values: string
Sets the user to be used to connect to the remote computer.
Used in:
readOnly
Accepts values: true, false
When false, allows individual fields to be edited by clicking on them. This only works when datasource is a tablename (does not work with datasource that is an SQL Query).
Used in:
readTag
Accepts values: tag
Tag specifies where to read the data that will be displayed.
Used in:
Combo-box Input
Dial
Fill Slide
Knob Input
Listbox
Listbox Input
Multistate Indicator
Numeric Input
Numeric Output
Panel Selector
Pointer Slide
Push Button
Text Input
Text Output
readTagValueLogic
Accepts values: Equal, RangeGreater, RangeGreaterEqual, RangeLesser, RangeLesserEqual
Sets the logic that will be applied against the read tag. To evaluate, OI will build a comparison with the readTag value on the left, the logic type as the comparison, and the tagValue defined in the component on the right (such as a state’s tagValue).
Used in:
Dial
Fill Slide
Multistate Indicator
redirectRFID
Accepts values: true, false
When true, RFID values will be passed through as keyboard events.
Used in:
refreshDoneTag
Accepts values: tag
When a database refresh is completed, this tag will be set to 1. During a refresh it will be set to 0.
Used in:
Database Edit
Database Read
Database Table
refreshOnEvent
Accepts values: ZeroToNonZero, AnyChange
Determines when a change in the triggerTag will be used to trigger an action. ZeroToNonzero will trigger only when the tag value goes from zero to a non-zero value, and anyChange will trigger on any change in value.
Used in:
Camera Image Viewer
Database Edit
Database Image Viewer
Database Read
Database Table
refreshPeriod
Accepts values: int
Time in seconds that the contents of this component will be refreshed.
Used in:
refreshTag
Accepts values: tag
Component will watch this tag to determine when to refresh data. See refreshOnEvent property.
Used in:
Camera Image Viewer
Database Edit
Database Image Viewer
Database Read
Database Table
refreshTime
Accepts values: int
Time in seconds that the contents of this component will be refreshed.
Used in:
Camera Image Viewer
Database Edit
releaseValue
Accepts values: int
This sets the value that will be written to the writeTag when the button is released following a push.
Used in:
reloadOnEvent
Accepts values: ZeroToNonZero, AnyChange
Determines when a change in the triggerTag will be used to trigger an action. ZeroToNonzero will trigger only when the tag value goes from zero to a non-zero value, and anyChange will trigger on any change in value.
Used in:
reloadTag
Accepts values: tag
Component will watch this tag to determine when to reload the homeUrl of the embedded web panel.
Used in:
reloadTime
Accepts values: int
Time in seconds that the embedded web component’s homeUrl will be reloaded.
Used in:
rotation
Accepts values: int
Number of degrees the image is rotated around rotationOrigin point. The rotation value will be applied to the component when OI screen is loaded and rotationTag is missing, or before rotationTag value is read from PLC. This property is useful for testing rotated images in OIB during development. Default value is 0.
Used in:
Image
Multistate Indicator
rotationOrigin
Accepts values: x, y (ints)
Sets rotation point of the component. Values are relative to the top-left of the component (0,0).
Used in:
Image
Multistate Indicator
rotationTag
Accepts values: tag
Read tag – value defined in degrees the image is rotated around the rotationOrigin point.
Used in:
Image
Multistate Indicator
rtspVideoURL
Accepts values: URL
RTSP connection string for an RTSP feed. Supports username/password in the URL. Use format rtsp://user:password@rtsp_server.com
Used in:
scale
Accepts values: int
When true, will scale the value to be displayed. For inputs, the number will be unscaled when written: typing in 3 on a numeric input with a 2 scale will result in 1.5 being written to the tag.
Used in:
Dial
Fill Slide
Knob Input
Numeric Input
Numeric Output
Pointer Slide
scaleBackgroundColor
Accepts values: color
Sets the color of the outer ring of the dial.
Used in:
scaleColor
Accepts values: color
Sets the color of the scale (tick marks).
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
scaledImage
Accepts values: true, false
When true, scales the image to the size of the component. When false, the image is painted 1:1 scale, and any pixels outside the component area are not painted.
Used in:
Camera Image Viewer
Database Image Viewer
Image
Multistate Indicator
Push Button
screenNumber
Accepts values: int
This defines the number value for this screen. Used in goto-screen selectors, and in the application control and status tags to communicate current screen information to a PLC.
Used in:
script
Accepts values: string
Filename of script to run – will only run scripts in the application script directory ___shellscripts.
Used in:
scriptUrl
Accepts values: string
URL for script to run. Can be remote request (http://www.example.com/script.html), or application script relative to the application ___httpscripts folder ( script.php?t=xxx&d=yyy ).
Used in:
showLiveImageInOIB
Accepts values: true, false
When true, OIB will attempt to load the image specified in imageUrl and display the image in OIB. Helpful for debugging.
Used in:
showLiveInOIB
Accepts values: true, false
When true the embedded web viewer contents will be loaded and shown in OIB.
Used in:
showNavigator
Accepts values: true, false
When true, shows an overlay with navigation controls.
Used in:
showTag
Accepts values: tag
Tag which will trigger showing this component or dynamic panel.
Used in:
showToolBar
Accepts values: true, false
When true the browsers toolbar will be displayed at the top of the components contents.
Used in:
slideAreaColor
Accepts values: color
Sets the color of the area the knob slides over.
Used in:
startupFile
Accepts values: string
Sets the file to load when the viewer is opened.
Used in:
startupPage
Accepts values: int
Sets the page number to navigate to when the viewer is opened.
Used in:
startUpUrl
Accepts values: string
Sets the URL that will be loaded when the component opens.
Used in:
startupZoom
Accepts values: int
Sets the starting zoom factor when the component is opened.
Used in:
stateTextChanged
Accepts values: tag
Write tag – writes to this tag when the state changes. Write values alternate between 0 and 1.
Used in:
stateTextWriteTag
Accepts values: tag
Write tag – writes the contents of the current states text to this tag.
Used in:
statusTag
Accepts values: tag
Tag specifies where the component will write its status to. See details for each component. Database components write 1 for error, 0 otherwise.
Used in:
Browser
Database Image Write
Database Write
Generic Run
stepValue
Accepts values: int
Sets the amount the value changes when pressing the increment/decrement buttons.
Used in:
tableName
Accepts values: string
The name of the database table.
Used in:
tableRowsLimit
Accepts values: int
When non-zero, this will limit the number of rows in the database table. Rows added beyond this limit will result in the oldest values being removed.
Used in:
tableSizeLimitMB
Accepts values: int
When non-zero, this will limit the size of the database table based on storage size. Any entries added that exceed this size will result in the oldest rows being deleted.
Used in:
tagList
Accepts values: list of tags
List of tags used to write values. See component details for more information.
Used in:
CSV File Read
CSV File Write
Database Write
Tag Copy
tagValue
Accepts values: int/string
In the state editor for the component, this sets the value of the state. When the tags value equals this value the component will select this state. If no state matches, the Error state will be displayed.
Used in:
Multistate Indicator
Push Button
text
Accepts values: text
Sets the text that is displayed on the component.
Used in:
Back Screen
Config Screen
Database Table
Goto Screen
Listbox Input Buttons
Multistate Indicator
Numeric Input Buttons
PDF Viewer
Push Button
Remote Desktop Viewer
Static Text
Video Viewer
textBold
Accepts values: true, false
When true, the text will be displayed in heavier type.
Used in:
Back Screen
Combo-box Input
Config Screen
Database Table
Dial
Fill Slide
Goto Screen
Listbox
Listbox Input
Listbox Input Buttons
Multistate Indicator
Numeric Input
Numeric Input Buttons
Numeric Output
PDF Viewer
Push Button
Remote Desktop Viewer
Static Text
Text Input
Text Output
Video Viewer
textColor
Accepts values: color
Sets the color of text.
Used in:
Dial
Fill Slide
Knob Input
Pointer Slide
textSize
Accepts values: int (points)
Sets the text size in points.
Used in:
Back Screen
Combo-box Input
Config Screen
Database Table
Dial
Fill Slide
Goto Screen
Listbox
Listbox Input
Listbox Input Buttons
Multistate Indicator
Numeric Input
Numeric Input Buttons
Numeric Output
PDF Viewer
Push Button
Remote Desktop Viewer
Static Text
Text Input
Text Output
Video Viewer
textWrap
Accepts values: true, false
When true, line breaks are inserted to keep long text within the horizontal space of the component. Text that extends past the bottom edge is not displayed.
Used in:
Numeric Input
Numeric Output
Static Text
Text Input
Text Output
toolbarColor
Accepts values: color
Sets the background color of the toolbar (if toolbar is visible).
Used in:
totalRecordsTag
Accepts values: tag
Sets the value of the tag to the total number of rows available.
Used in:
Database Edit
Database Read
totalTagsWrittenTag
Accepts values: tag
The number of tags that have been written is recorded to this tag.
Used in:
transparent
Accepts values: true, false
When true, the background is not painted.
Used in:
Numeric Input
Numeric Output
Text Input
Text Output
transparentBack
Accepts values: true, false
When true, the part of the image that would be considered the back-color when converted to black and white (monoImage) is set to transparent. Setting transparentFore to true will change this value to false.
Used in:
transparentBackground
Accepts values: true, false
When true, the component does not fill in space around displayed elements.
Used in:
transparentFore
Accepts values: true, false
When true, the part of the image that would be considered the fore-color when converted to black and white (monoImage) is set to transparent. Setting transparentBack to true will change this value to false.
Used in:
triggerOnEvent
Accepts values: ZeroToNonZero, AnyChange
Determines when a change in the triggerTag will be used to trigger an action. ZeroToNonzero will trigger only when the tag value goes from zero to a non-zero value, and anyChange will trigger on any change in value.
Used in:
Combo-box Input
CSV File Read
CSV File Write
Database Write
HTTP Script
Shell Script
Tag Copy
triggerRefreshTag
Accepts values: tag
Component will watch this tag to determine whether to trigger a refresh of its data. See triggerOnEvent property.
Used in:
triggerTag
Accepts values: tag
Component will watch this tag to determine whether to trigger an action. See triggerOnEvent property.
Used in:
CSV File Read
CSV File Write
Database Image Write
Database Write
HTTP Script
Shell Script
Tag Copy
vAlignment
Accepts values: Top, Bottom, VCenter
Sets how the text is aligned on the component vertically: top, bottom, or center.
Used in:
Numeric Input
Numeric Output
Static Text
Text Input
Text Output
videoFile
Accepts values: string
Filename of video to play.
Used in:
vncDebug
Accepts values: true, false
If true, then more verbose logging is sent to /var/log/oi.log and a communication graph is displayed.
Used in:
width
Accepts values: int
Sets the size of the slide (width for vertical, height for horizontal). Remaining space within the component is used for the scale.
Used in:
writeTag
Accepts values: tag
Tag specifies where the component will write data on changes.
Used in:
Combo-box Input
Knob Input
Listbox Input
Numeric Input
Pointer Slide
Push Button
Text Input
xClickWriteTag
Accepts values: tag write
When set, the x position relative from the top-left corner of any touch events on this component will be written to this tag. Only the touch start event is written (the position where the touch is released and positions during drag are not written).
Used in:
xmlRpcFunction
Accepts values: string
Undocumented
Used in:
xmlRpcParameters
Accepts values: string
Undocumented
Used in:
xmlRpcServer
Accepts values: string
Undocumented
Used in:
xOffsetTag
Accepts values: tag
When true, the part of the image that would be considered the fore-color when converted to black and white (monoImage) is set to transparent. Setting transparentBack to true will change this value to false.
Used in:
yClickWriteTag
Accepts values: tag write
When set, the y position relative from the top-left corner of any touch events on this component will be written to this tag. Only the touch start event is written (the position where the touch is released and positions during drag are not written).
Used in:
yOffsetTag
Accepts values: tag
When true, the part of the image that would be considered the back-color when converted to black and white (monoImage) is set to transparent. Setting transparentFore to true will change this value to false.
Used in:
zoomPerc
Accepts values: int
Percentage zoom used to scale contents of embedded web panel.
Used in:
zoomX
Accepts values: float
Sets the width of the component to the width of the image times this value. This allows fitting images larger than the screens display resolution onto the screen.
Used in:
zoomY
Accepts values: float
Sets the width of the component to the height of the image times this value. This allows fitting images larger than the screens display resolution onto the screen.
Used in: