Skip to main content
Version: 8.1

Vision - Tag Browse Tree

Component Palette Icon:

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

PropertyDescriptionProperty TypeScriptingCategory
BorderThe border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border.
Note: The border is unaffected by rotation.

Changed in 8.1.21
As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
FontFont of text on this component.Font.fontAppearance
Include Historical TagsWhether or not to display historical Tags.boolean.showHistoricalRealtime Tag Tree Settings
Include Realtime TagsWhether or not to display non-historical Tags.boolean.showRealtimeRealtime Tag Tree Settings
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Root Node PathThe 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"
[default]machine_1/

Historical Tag Tree: [HistoricalProvider:/:GatewayName:TagProvider]FolderPath/
The example below is using a historical provider 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".
This example should work with both Datasource History Providers and DB Table Historian Providers.
[DB:/:ignition:default]machine_1/

Changed in 8.1.10
As of 8.1.10, the historical tag tree mode also accepts the following formats that will only work with DB Table Historian Providers:
histprov:HistoricalProvider:/drv:GatewayName:TagProvider:/tag:FolderPath/
histprov:HistoricalProvider:/drv:GatewayName:TagProvider
[HistoricalProvider/GatewayName:TagProvider]FolderPath/
String.rootNodePathData
Selected PathsContains the paths that should be selected on the tree which should be in the format of a single string column.Dataset.selectedPathsData
Selection ModeWhat kind of selection regions does the tree allow. Options are Single, Multiple - Contiguous, and Multiple - Discontiguous.int.selectionModeBehavior
Show Root HandlesWhether or not to show handles next to parent nodes.boolean.showRootNodeHandlesAppearance
Show Root NodeWhether or not to show the root node of the tree.boolean.showRootNodeAppearance
Tag Tree ModeChoose whether the tree is built using Tags from the default provider or the historical provider.int.treeModeAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon

Deprecated Properties

PropertyDescriptionProperty TypeScriptingCategory
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated

Scripting

See the Vision - 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

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