Skip to main content
Version: 2027.02 Beta
View as Markdown

Perspective - Tag Browse Tree

Component Palette Icon:

Description​

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​

Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective. This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.

NameDescriptionProperty Type
rootConfiguration for the path from which the displaying folder/tag structure will start.
  • path: String value representing the "starting path" from which the tag structure will begin displaying. Value is string.
object
filterTree filtering configuration.
  • enabled: Enables the visibility of the filter. Value is boolean.
  • text: The filter text. Value is string.
object
selectionConfiguration for the selected tag.
  • mode: Mode used when selecting tags. Choose between single to limit selection to only one tag, or multiple to allow selection of multiple tags at once. Value is string.
  • values: List of the selected tag paths in the order in which selection occurred. Value is an array.
object
displayDisplay settings for the component.
  • refreshIcon: Display settings for the refresh icon.
    • visible: Visibility setting for the refresh icon.Value is boolean.
    • path: Path to the icon used to represent the "refresh" action. Value is string.
    • style: Sets a style for the refresh icon. Full menu of style options is available. You can also specify a style class.
object
styleSets a style for this component. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.object

Component Scripts and Events​

Further component interaction and functionality can be configured for all components through scripting and event actions. Right-click on the component or select Components from the Designer menubar to access the configuration popups for both of these options:

  • Configure Events: Accesses the Event Configuration popup where you can configure actions to run in response to events to make the component dynamic. The Events Configurations page shows how to configure events and actions on a Perspective component.

  • Configure Scripts: Accesses the Script Configuration popup where custom methods and message handlers can be added. The Scripting in Perspective section details scripting fundamentals, creating custom methods, and using message handlers.

The Tag Browse Tree component also has Component Events and Extension Functions associated with it. See the Perspective - Tag Browse Tree Scripting page for more information.

Example​

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