Property Index

211 properties. Select a property for its description and the components that use it.

Property Accepts Description Used in
A
accessPassword string (deprecated) When set, this password is required to use the component. 12 components
accessTimeout seconds (int) (deprecated) When set, this will persist authorization for access to the component for the time specified. 12 components
allowedGroups number (bitmask) Bitmask of user groups allowed to interact with this component. Groups 1-16 map to bits 0-15, so a value of 3 allows groups 1 and 2. Used when authorize is set to useLoggedUser. 12 components
allowPLC true, false Defines whether a PLC can override the User Access system when calling this screen. 2 components
alwaysOnTop boolean Displays this overlay above other non-modal overlays. Modal overlays are always stacked above alwaysOnTop overlays. 1 component
appendTag tag When this tag's value is non-zero, written data is appended to the file instead of overwriting it. 1 component
authorize freeAccess, useLoggedUser, onEachAccess Determines access protections for this component. 12 components
autoLoop true, false If true, then video will automatically loop when ended. 1 component
autorepeat true, false When true, the action of the button will be repeated while the button is held. 3 components
autorepeatDelay int (milliseconds) When autorepeat is enabled, this specifies the delay in milliseconds before the action is repeated. 3 components
autorepeatPeriod int (milliseconds) When autorepeat is enabled, this specifies the delay between repeating the action of the button. 3 components
B
backcolor color Sets background color. Images are allowed to set this to transparent to support images with alpha masks. 25 components
barColor color Sets the color of the value-bar. 1 component
beginArrow true, false When true, an arrow will be displayed at the beginning point. 1 component
beginPoint x, y (ints) X/Y coordinates of the line's begin point, editable as x and y sub-rows in the property editor. 1 component
beginXTag tag Tag that dynamically sets the X coordinate of the line's begin point. At startup OI writes the design-time coordinate to this tag, then follows the tag's value. 1 component
beginYTag tag Tag that dynamically sets the Y coordinate of the line's begin point. At startup OI writes the design-time coordinate to this tag, then follows the tag's value. 1 component
blinkColor color Sets the color the background will change to while blinking. 2 components
borderWidth int (pixels) Set the size of the border in pixels. 0 removes the border. 10 components
buttonBackColor color Sets the color of the drop-down buttons background. 1 component
buttonForeColor color Sets the color of the drop-down buttons arrow. 1 component
C
camID string String that will be stored with the image in the database to designate which Camera was written. Can be used later to filter. 1 component
clickThrough 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. 12 components
client vnc, rdesktop Specifies whether to connect using VNC or Remote Desktop. 1 component
closeTriggerOnEvent 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. 2 components
closeTriggerTag tag Component will watch this tag to determine whether to trigger an action. See closeTriggerOnEvent property. 2 components
color color Sets the drawing color: the line/outline color for Line, Circle and Rectangle components, and the text color for Static Text. 4 components
column:colHeading string Static text for the header of this column. 1 component
column:dbColName string This sets the column name from the database table that should be displayed. 1 component
column:width int Width in pixels for display. 1 component
confirmationPanelNumber int The dynamic screen number that will be shown when the push button is pressed. 4 components
confirmationReadTag tag Tag that controls the confirmation panel. When the button is pressed the panel opens and this tag is set to 0. Writing 1 confirms - the button press and release are simulated (writing pushValue then releaseValue) and the panel closes. Writing 2 cancels and closes the panel. 4 components
currentRecordTag tag Tag where the component writes the record number (1-based) of the current record. The value is clamped to the record count: if a table has 10 rows and findRecordTag is set to 20, currentRecordTag reads 10. 2 components
D
dataSourceSQL string SQL query providing data for this component. DB Read can accept a table name. DB Edit accepts only tablenames. 1 component
dataSourceTable string Selects the database table to display. Use either dataSourceTable for a whole table or dataSourceSQL for a custom SELECT query. 1 component
DB Connection databaseName string Sets the name of the database to connect to. 1 component
DB Connection driver SQLite Sets the database driver to use. 1 component
DB Source databaseSource DB Source Sets which of the sources to use from the Database Sources dialog. 5 components
decimalPointPosition 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. 2 components
description string A space to provide a description of the current component, useful for documenting intent. 44 components
dialColor color Sets the color of the center of the dial. 1 component
disabledColor color Sets color of text when this input is disabled. 2 components
disableTag tag When tag value is an integer other than zero, interaction with this component is disabled. 2 components
E
endArrow true, false When true, an arrow will be displayed at the ending point. 1 component
endPoint x, y (ints) X/Y coordinates of the line's end point, editable as x and y sub-rows in the property editor. 1 component
endXTag tag Tag that dynamically sets the X coordinate of the line's end point. At startup OI writes the design-time coordinate to this tag, then follows the tag's value. 1 component
endYTag tag Tag that dynamically sets the Y coordinate of the line's end point. At startup OI writes the design-time coordinate to this tag, then follows the tag's value. 1 component
execArguments string Additional arguments that will be added to the end of the execution string. 1 component
executable string The command line program that will be executed with this component. 1 component
executeOnStartup true, false When true, the script is executed once at application startup. Input tags are not passed on this run; instead a parameter named _STARTUP_ with value 1 is passed - as POST data for HTTP scripts ($_POST['_STARTUP_']) and as the command-line argument -_STARTUP_=1 for Shell scripts. 2 components
executeTemplate User_Specified, Windows_Chrome OIB Functionality only – when set will auto-populate fields based on the template. 1 component
F
featureIDTag tag Tag specifies where the featureID data will be read from. This is stored with the image in the database. 1 component
fieldWidth int Number of characters used to display the value, clamped to 1-12. When the formatted number does not fit, the entire field is filled with # characters. 2 components
fileLocation USB_Flash, HardDrive, InternalFlash Specifies where the file should be stored. 2 components
fileName string Name of file to use for read or write operation. 2 components
fileNameTag tag When set, file operations will use the value of this tag for the filename. 2 components
fillColor color Sets the color of the filled in area. 3 components
filled true, false When true, the shape will be filled with the fillColor. 3 components
fillWithZeroes true, false When true, the number will be prepended with zeros up to fieldWidth. 2 components
filter When readOnly is false, this will filter the results. Valid entries are SQL expressions. 1 component
filterInTag tag The string value of this tag is used to filter available choices on the component. States whose filterText matches the filterInTag according to the rules in filterMatchingMode will be kept in the list. The comparison is case sensitive. 3 components
filterMatchingMode WholeWordsOnly, AnyOccurence Determines how the filter tag value is matched against each state's filterText. WholeWordsOnly (default) matches the tag value as a whole word within the filterText; AnyOccurence matches any substring occurrence. 3 components
filterOutTag tag Tag used for filtering out list items. States whose filterText matches the filterOutTag value (per filterMatchingMode) will be excluded from the list. 3 components
filterText string Per-state filter text used with filterInTag/filterOutTag: when a filter tag is set, only states whose filterText matches (per filterMatchingMode) are shown in the list. 2 components
findRecordTag 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. 3 components
foreColor color Sets foreground color (usually text). 19 components
fullScreen true, false When true, the video will be scaled to show fullscreen. When false, the video will be shown at original size. 1 component
G
geometry 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. 43 components
goToScreenNum int Sets the screen number that will be displayed when button is pushed. 1 component
grid x, y Defines the x/y spacing of the snap grid in the OI Builder screen editor. Each axis is clamped to 2-50 pixels; the default is 10 x 10. 2 components
H
hAlignment Left, Right, HCenter Sets how the text is aligned on the component horizontally: left, right, or centered. 5 components
hasCloseButton true, false When true, a close button is overlayed which will close the application being run. 1 component
hasRaiseOIButton true, false When true, a button labeled OI is shown in the bottom right that, when pressed, will return OI as the currently displayed application. The application will still be open. 1 component
headerBackColor color Sets background color for the row/column headings. 1 component
headerForeColor color Sets the color of text for the row/column headings. 1 component
hidden true, false When true, the component will not be visible on the screen. 3 components
hideTag tag When tag value is an integer other than zero, the component is not displayed on the screen. 29 components
highlightBackColor color Sets background color for selected list item. 3 components
highlightForeColor color Sets text color for selected list item. 3 components
holdTime int (milliseconds) When set to non-zero, the button will be held in the pushed state for this many milliseconds. 1 component
homeUrl string Url that is loaded at startup and on reloads. 1 component
host string Sets the host remote desktop server to connect to. 1 component
I
image image The image that will be displayed. Images are selected from the applications image collection. 11 components
imageSource string URL for image, or local path to image device (such as /dev/video0 ) 1 component
imageUrl string Sets the URL for the image to be displayed. 1 component
incDecButtons true, false When true, increment and decrement buttons are shown with the component. False will not display these buttons. 1 component
indexChangeUpdatesDst true, false When true, changes to the indexTag will trigger copy events, when false a trigger is needed to execute. 1 component
indexColumn string Column used to uniquely identify rows for editing. There is no default - editing is refused with an index error until it is set. Tables created by OI include the __id__ primary key column, which is the usual choice. 1 component
indexGroupReadTag tag Tag where the component writes the index of the tag group that was just read, or -1 when the read failed. 1 component
indexGroupToReadTag 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. 1 component
indexTag tag When set, only the nth set of tag-copy items will be executed. 1 component
indexTagOffset 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). 1 component
inputTags 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). 2 components
isDoneTag tag Tag written when the operation completes: with triggerOnEvent ZeroToNonZero it is set to 1; with AnyChange it alternates between 0 and 1 on successive runs. 4 components
isModal boolean When true, this overlay will visually dim the underlying screen and prevent interactions with elements outside the overlay. 1 component
isOverlay boolean (read-only) Read-only property derived from the screen type: true for dynamic panels and the alarm overlay screen. It cannot be set directly. 1 component
K
keypad true, false When true, will display numeric keypad for entry. False will not display the keypad. 1 component
knobColor color Sets the color of the button used to slide. 2 components
knobMarkerColor color Sets the color of the position indictor on the knob. 1 component
L
labelText text Sets the text that is displayed on the dials label. 1 component
lineWidth int (pixels) Sets the width of the line in pixels. 3 components
M
maxMajorTicks int Sets the maximum of major tick marks on the displays scale. 4 components
maxMinorTicks int Sets the maximum of minor tick marks on the displays scale. 4 components
maxValue number Sets the maximum value the component will accept. If a larger value is entered manually an error will be displayed and keypad shown again. 1 component
maxValueTag tag Tag providing a dynamic maximum. The component uses the more restrictive of maxValue and this tag's value. 1 component
mayOpenFile true, false When true, operators can navigate and open other files. 2 components
minValue number Sets the minimum value the component will accept. If a lesser value is entered manually an error will be displayed and keypad shown again. 1 component
minValueTag tag Tag providing a dynamic minimum. The component uses the more restrictive of minValue and this tag's value. 1 component
monoImage true, false When true, converts the image to black and white. 11 components
multistate true, false When true, some of this component’s properties can be changed based on the state of the readvalue. 2 components
multistatePushButton 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. 1 component
N
name string Provide a name for the component. This can be helpful when using the "Used Components" tool in the tag editor. 44 components
needleColor color Sets the color of the value-indicating needle. 1 component
numOfColumns 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. 1 component
numOffset number Offset added to the tag value before it is displayed (displayed value = tag value x numScale + numOffset). Applied together with the numScale property. 2 components
O
offset x, y (ints) Two meanings by component: on Image and Multistate Indicator, the x/y distance the image is translated; on Dial, Knob, Fill Slide and Pointer Slide, a numeric value added to the tag value before display (displayed = value x scale + offset). 2 components
offsetEnabled 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). 1 component
openTriggerOnEvent ZeroToNonZero, AnyChange Determines when a change in the openTriggerTag triggers the component. ZeroToNonZero (default) fires only on a change from zero to a non-zero value; AnyChange fires on every value change. 2 components
openTriggerTag tag Component will watch this tag to determine whether to trigger an action. See openTriggerOnEvent property. 2 components
orderBy When readOnly is false, this will set the ordering of rows. Valid entries are names of the column. 1 component
orientation Horizontal, Vertical Sets the orientation of the component between a vertical slide or horizontal slide. 2 components
outputTags 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). 2 components
P
panelNumber number Per-state panel selection: the screen number of the dynamic panel to display when the readTag matches this state's tagValue. 1 component
partIDTag tag Tag specifies where the partID data will be read from. This is stored with the image in the database. 1 component
password string Password used to connect to the remote server. Shared by both the VNC and RDesktop client modes. 1 component
password1 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. 3 components
password2 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. 3 components
password3 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. 3 components
password4 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. 3 components
password5 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. 3 components
passwordMode true, false When true, the value of the readTag is obscured. 4 components
playSound true, false When true, the video player will play the audio. When false, the audio is muted. 1 component
playVideoTag 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. 2 components
pushValue int This sets the value that will be written to the writeTag when the button is in the pushed state. 1 component
R
rangeMax int Sets the maximum value the dial/slide displays. 4 components
rangeMaxTag tag Defines the rangeMax value of the component from the value of this tag. 4 components
rangeMin int Sets the minimum value the dial/slide displays. 4 components
rangeMinTag tag Defines the rangeMin value of the component from the value of this tag. 4 components
rdesktopUser string Sets the user to be used to connect to the remote computer. 1 component
readOnly 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). 1 component
readTag tag Tag specifies where to read the data that will be displayed. 14 components
readTagValueLogic 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). 3 components
redirectRFID true, false When true, RFID values will be passed through as keyboard events. 1 component
refreshDoneTag tag When a database refresh is completed, this tag will be set to 1. During a refresh it will be set to 0. 2 components
refreshOnEvent ZeroToNonZero, AnyChange Determines when a change in the refreshTag triggers a refresh. ZeroToNonZero (default) fires only on a change from zero to a non-zero value; AnyChange fires on every value change. 5 components
refreshTag tag Component will watch this tag to determine when to refresh data. See refreshOnEvent property. 5 components
refreshTime int Time in seconds that the contents of this component will be refreshed. 2 components
releaseValue int This sets the value that will be written to the writeTag when the button is released following a push. 1 component
reloadOnEvent ZeroToNonZero, AnyChange Determines when a change in the reloadTag triggers a reload. ZeroToNonZero (default) fires only on a change from zero to a non-zero value; AnyChange fires on every value change. 1 component
reloadTag tag Component will watch this tag to determine when to reload the homeUrl of the embedded web panel. 1 component
reloadTime int Time in seconds that the embedded web component’s homeUrl will be reloaded. 1 component
rotation 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. 2 components
rotationOrigin x, y (ints) Sets rotation point of the component. Values are relative to the top-left of the component (0,0). 2 components
rotationTag tag Read tag – value defined in degrees the image is rotated around the rotationOrigin point. 2 components
rowHeight number Sets the height in pixels of each row in the table. 1 component
rtspVideoUrl URL RTSP connection string for an RTSP feed. Supports username/password in the URL. Use format rtsp://user:password@rtsp_server.com 1 component
S
scale number Numeric multiplier applied to the tag value before display: displayed = value x scale + offset (Dial, Knob, Fill Slide, Pointer Slide). Numeric Display and Numeric Input use the equivalent numScale property. 6 components
scaleBackgroundColor color Sets the color of the outer ring of the dial. 1 component
scaleColor color Sets the color of the scale (tick marks). 4 components
scaledImage 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. 5 components
screenNumber 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. 2 components
script string Filename of script to run – will only run scripts in the application script directory ___shellscripts. 1 component
scriptUrl 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 ). 1 component
showLiveImageInOIB true, false When true, OIB will attempt to load the image specified in imageUrl and display the image in OIB. Helpful for debugging. 1 component
showLiveInOIB true, false When true the embedded web viewer contents will be loaded and shown in OIB. 1 component
showNavigator true, false When true, shows an overlay with navigation controls. 2 components
showTag tag Tag that triggers showing a dynamic panel: the panel is shown while the tag value is non-zero. Only available on screens whose system class is dynamic_panel. 1 component
showToolBar true, false When true the browsers toolbar will be displayed at the top of the components contents. 1 component
sliderAreaColor color Sets the color of the area the knob slides over. 1 component
startupFile string Sets the file to load when the viewer is opened. 2 components
startupPage int Sets the page number to navigate to when the viewer is opened. 1 component
startUpUrl string Sets the URL that will be loaded when the component opens. 1 component
startupZoom int (-5..5, 0 = fit width) Zoom step used when the document opens: an integer from -5 to 5, where 0 means fit to page width. 1 component
stateTextChangedWriteTag tag Write tag toggled between 0 and 1 whenever any of the component's read tags change (not only on a state change). 1 component
stateTextWriteTag tag Write tag – writes the contents of the current states text to this tag. 1 component
statusTag tag Tag reporting component status; the meaning varies by component. Database Write: 1 = record not found/error, 0 = OK. Database Image Write: 1 = ready, 0 = busy. Web Browser and Generic Run: 1 = running/open, 0 = closed. 4 components
stepValue int Sets the amount the value changes when pressing the increment/decrement buttons. 1 component
T
tagList list of tags List of tags used to write values. See component details for more information. 4 components
tagValue 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. 5 components
text text Sets the text that is displayed on the component. 13 components
textBold true, false When true, the text will be displayed in heavier type. 21 components
textColor color Sets the color of text. 4 components
textSize int (pixels) Sets the text size in pixels (clamped to 8-400; default 12). 21 components
textWrap NoWrap, WordWrap, WrapAnywhere Controls line wrapping of displayed text: NoWrap (default), WordWrap (break at word boundaries), or WrapAnywhere (break mid-word when needed). 5 components
toolBarColor color Sets the background color of the toolbar (if toolbar is visible). 1 component
totalRecordsTag tag Sets the value of the tag to the total number of rows available. 2 components
totalTagsWrittenTag tag The number of tags that have been written is recorded to this tag. 1 component
transparent true, false When true, the background is not painted. 4 components
transparentBack 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. 1 component
transparentBackground true, false When true, the component does not fill in space around displayed elements. 2 components
transparentFore 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. 1 component
triggerOnEvent 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. 7 components
triggerRefreshTag tag Component will watch this tag to determine whether to trigger a refresh of its data. See triggerOnEvent property. 1 component
triggerTag tag Component will watch this tag to determine whether to trigger an action. See triggerOnEvent property. 7 components
V
vAlignment Top, Bottom, VCenter Sets how the text is aligned on the component vertically: top, bottom, or center. 5 components
videoFile string Filename of video to play. 1 component
vncDebug true, false When true, the VNC viewer is started with verbose logging written to /var/log/oi.log (TigerVNC builds only; TightVNC builds do not support logging). 1 component
W
width int Sets the size of the slide (width for vertical, height for horizontal). Remaining space within the component is used for the scale. 2 components
writeTag tag Tag specifies where the component will write data on changes. 7 components
X
xClickWriteTag 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). 1 component
xmlRpcFunction string Undocumented 1 component
xmlRpcParameters string Undocumented 1 component
xmlRpcServer string Undocumented 1 component
xOffsetTag tag Updates the image x position by this value in screen pixels. 1 component
Y
yClickWriteTag 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). 1 component
yOffsetTag tag Updates the image y position by this value in screen pixels. 1 component
Z
zoomPerc int Percentage zoom used to scale contents of embedded web panel. 1 component
zoomX 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. 1 component
zoomY float Sets the height of the component to the height of the image times this value (result clamped to 5-2000 pixels). 1 component

No properties match “”.