Component Palette Icon:





The Tag Browse Tree component displays a tree hierarchy based on an array of objects. Icons can be chosen for the nodes of the tree, and different icons can be used when an node is expanded or collapsed.


Properties


NameDescriptionProperty Type
root

Configuration for the path from which the displaying folder/Tag structure will start.

NameDescriptionProperty Type
pathString value representing the "starting path" from which the Tag structure will begin displaying.string
object
selection

Configuration for the selected Tag.

NameDescriptionProperty Type
modeMode used when selecting Tags. Choose between single to limit selection to only one Tag, or multiple to allow selection of multiple Tags at once.string
valuesList of the selected Tag paths in the order in which selection occurred. array
object
display

Display settings for the component.

NameDescriptionProperty Type
refreshIcon

Display settings for the refresh icon.

NameDescriptionProperty Type
visibleVisibility setting for the refresh icon.boolean
pathPath to the icon used to represent the "refresh" action.string
styleSets a style for the refresh icon. Full menu of style options is available. You can also specify a style class.object
object
object
style

Sets a style for this component. Full menu of style options is available. You can also specify a style class.

object


Component Events

The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.

Fires whenever a node is clicked. 

Object PathTypeDescription
event.nameStringThe name of the node that was clicked.
event.pathStringThe Tag path of the node that was clicked.

Fires whenever a node is double-clicked.

Object PathTypeDescription
event.nameStringThe name of the node that was clicked.
event.pathStringThe Tag path of the node that was clicked.

Fires whenever a node is right-clicked.

Object PathTypeDescription
event.nameStringThe name of the node that was clicked.
event.pathStringThe Tag path of the node that was clicked.


Component Functions

  • Description

Called for each Tag before it is displayed in the Tag Browse Tree. Provides an opportunity to create a complex filter for the Tags in the Tag Browse Tree. filerBrowseNode is best used alongside the Tag Browse Tree's root.path property to specify where the filter should begin filtering. Return False to exclude the Tag from displayed results.

  • Parameters

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

NodeBrowseInfo node - The Tag returned as type NodeBrowseInfo. See the Ignition JavaDocs for usage.

  • Return

Boolean - The function must return either a True or False. 

Example

# This example will filter out any nodes (both Tags and folders included) that do not match the string Ramp.
if node.name == "Ramp":
	return True
else:
	return False


Example

PropertyValue

selection.mode

multiple
selection.values.0_Generic Simulator_/_Controls_/Base Rate
selection.values.1_Generic Simulator_/_Controls_/Program Counter
selection.values.2_Generic Simulator_/_Controls_/Reset