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

NameDescriptionProperty TypeScriptingCategory
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

The border is unaffected by rotation.

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 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"

[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"

[DB:/:ignition:default]machine_1/


As of 8.1.10, the historical tag tree mode also accepts the following formats:


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
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated

Scripting

Component Functions

This component does not have component functions associated with it.

Extension Functions

  • Description

Called for each Tag loaded into Tag browse tree. Return false to hide this Tag from the tree.

Note that this is called for each Tag, not any folders that appear in the component.

  • Parameters

Component self- A reference to the component that is invoking this function.

Tag Object tag - The Tag itself.

  • Return

Boolean

  • Description

Returns a popup menu that will be displayed when the user triggers a popup menu (right click) on the tree. Use system.gui.createPopupMenu to create the popup menu.

  • Parameters

Component self- A reference to the component that is invoking this function.

Tag Object clickedTag - The Tag of the clicked on tree path.

List selectedTags - The Tags of the selected paths of the tree.

  • Return

JPopupMenu


Examples

# 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.getCurrentValue().value)
		system.gui.messageBox(value)


	def showLastChange(self):
		lastChange = str(clickedTag.getCurrentValue().timestamp)
		system.gui.messageBox(lastChange)

	itemsDict = {"Show Value": showValue, "Show Last Change":showLastChange}
	JPopupMenu = system.gui.createPopupMenu(itemsDict)
	return JPopupMenu