Top  | Previous | Next

Tag Browse Tree

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

Appearance

Tag Tree Mode

Choose whether the tree is built using tags from the default provider or the historical provider.

Scripting name

treeMode

Data type

int

Values

0

Realtime Tag Tree

1

Historical Tag Tree

Show Root Node

Whether or not to show the root node of the tree.

Scripting name

showRootNode

Data type

boolean

Show Root Handles

Whether or not to show handles next to parent nodes.

Scripting name

showRootNodeHandles

Data type

boolean

Antialias

Draw with antialias on? Makes text smoother

Scripting name

antialias

Data type

boolean

Flags

expert

Behavior

Selection Mode

What kind of selection regions does the tree allow.

Scripting name

selectionMode

Data type

int

Values

1

Single Selection

2

Multiple - Contiguous

4

Multiple - Discontiguous

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name

toolTipText

Data type

String

Data

Root Node Path

The path of the root of this tree structure, or "" if no selection.

Scripting name

rootNodePath

Data type

String

Flags

bindable

Selected Paths

Contains the paths that should be selected on the tree which should be in the format of a single string column.

Scripting name

selectedPaths

Data type

Dataset

Flags

bindable

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Realtime Tag Tree Settings

Include Historical Tags

Whether or not to display historical tags.

Scripting name

showHistorical

Data type

boolean

Flags

bindable

Include Realtime Tags

Whether or not to display non-historical tags.

Scripting name

showRealtime

Data type

boolean

Flags

bindable

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

mouse
mouseMotion
propertyChange

 

Scripting Functions

This component has no special scripting functions.

Extension Functions

The tag browse tree has the following extension functions. See each function's doc string for usage details.

createPopupMenu()
filterTag()