Tag Browse Tree

Component Palette Icon:

Description

The Tag Browse Tree component is similar to the Tag Browser in the Designer, allowing tags to be browsed in both the Designer and the Client, and dragged on to other components like the Easy Chart. Unlike the Tag Browser, tags can not be edited, tag properties can not be displayed, and UDT definitions can not be displayed. Tags in the component can be refreshed through scripting by calling refresh().

Properties

Name	Description	Property Type	Scripting	Category
Antialias	Draw with antialias on? Makes text smoother.	boolean	.antialias	Appearance
Border	The border surrounding this component. NOTE that the border is unaffected by rotation.	Border	.border	Common
Data Quality	The data quality code for any tag bindings on this component.	int	.dataQuality	Data
Include Historical Tags	Whether or not to display historical tags.	boolean	.showHistorical	Realtime Tag Tree Settings
Include Realtime Tags	Whether or not to display non-historical tags.	boolean	.showRealtime	Realtime Tag Tree Settings
Mouseover Text	The text that is displayed in the tooltip which pops up on mouseover of this component.	String	.toolTipText	Common
Name	The name of this component.	String	.name	Common
Root Node Path	The path of the root of this tree structure, or "" if no selection. When intentionally setting the root node, the exact syntax changes depending on what the Tag Tree Mode property is set to: Realtime Tag Tree: [TagProvider]FolderPath/ The example below is using the "default" tag provider, and a folder named "machine_1" Example [default]machine_1``/ Historical Tag Tree: [DatabaseConnection/GatewayName:TagProvider]FolderPath/ The example below is using a database connection named "DB", the system name of the Gateway is "ignition", the tag provider is "default" and will set the path to a folder named "machine_1" Example [DB``/``ignition:default]machine_1``/	String	.rootNodePath	Data
Selected Paths	Contains the paths that should be selected on the tree which should be in the format of a single string column.	Dataset	.selectedPaths	Data
Selection Mode	What kind of selection regions does the tree allow.	int	.selectionMode	Behavior
Show Root Handles	Whether or not to show handles next to parent nodes.	boolean	.showRootNodeHandles	Appearance
Show Root Node	Whether or not to show the root node of the tree.	boolean	.showRootNode	Appearance
Tag Tree Mode	Choose whether the tree is built using tags from the default provider or the historical provider.	.treeMode	Appearance
Visible	If disabled, the component will be hidden.	boolean	.visible	Common

Scripting

See the Tag Browse Tree Scripting Functions page for the full list of scripting functions available for this component.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page.

Customizers

• Component Customizers

Example

Code Snippet

# The following code shows a right-click popup menu.
# Add these lines after the """ """ section of the createPopupMenu extension function. 
# Note how lines below are indented, the first def command should line up with the
# indentation of the """ """ section of the Extension Function.
  
    def showValue(self):
        value = str(clickedTag.value.value)
        system.gui.messageBox(value)
 
 
    def showLastChange(self):
        lastChange = str(clickedTag.value.timestamp)
        system.gui.messageBox(lastChange)
 
    itemsDict = {"Show Value": showValue, "Show Last Change":showLastChange}
    JPopupMenu = system.gui.createPopupMenu(itemsDict)
    return JPopupMenu