---
title: "Perspective - Tag Browse Tree Scripting"
---

# Perspective - Tag Browse Tree Scripting

> This page details the component-specific events and functions available for Perspective's [Tag Browse Tree](perspective-tag-browse-tree.md) component. Right-click on the component or select Components from the Designer menubar to access the Configure Events and Configure Scripts popups.

## Component Events

The [Perspective Event Types Reference](appendix/reference-pages/perspective-event-types-reference.md) page describes all the possible component event types for Perspective components.  

### onNodeClick
Fires whenever a node is clicked.

|Object Path|Type|Description|
|--|--|--|
|event.name |String |The name of the node that was clicked. | 
|event.path |String |The Tag path of the node that was clicked. |

### onNodeDoubleClick
Fires whenever a node is double-clicked.

|Object Path|Type|Description|
|--|--|--|
|event.name|String|	The name of the node that was clicked.|
|event.path	|String	|The Tag path of the node that was clicked.|

### onNodeContextMenu
Fires whenever a node is right-clicked.

|Object Path|Type|Description|
|--|--|--|
|event.name|	String	|The name of the node that was clicked.|
|event.path|	String	|The Tag path of the node that was clicked.|

## Component Functions
This component does not have component functions associated with it.

## Extension Functions

### filterBrowseNode

* 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

```python title="filterBrowseNode 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
```

![](image2022-4-15_13-1-30.png)