Hierarchy Browser Node (Tree) Component

This component is used within the Tree Browser Component.

For an interface recipe using the hierarchy browser tree, see the Contact Management application page. For more information on how the hierarchy browser tree works, see the detailed explanation.

Function

a!hierarchyBrowserFieldTreeNode( id, label, description, details, image, link, isDrillable, nextLevelCount, showWhen )

Returns a Tree Node, used in the Node Configurations parameter of the Tree Browser Component to determine how items in the hierarchy are displayed.

Parameters

Name Keyword Types Description

Identifier

id

Any Type

Required unique identifier of the node. This value only needs to be unique within the nodes level.

Label

label

Text

Required text to display in the node.

Description

description

Text

Text to display below the node label.

Details

details

Text

Text to display below the node description.

Image

image

Image

Required image to display in the node, created with:

Link

link

Array of Links

Optional link to display in the node s label title. Create links with:

Node is drillable

isDrillable

Boolean

If true, clicking the node will drill into it, saving the tree browsers navigation path and revealing another level to the user. If false, clicking the node's will not reveal another level, but the navigation path will still be saved (default: true).

Next Level Count

nextLevelCount

Integer

Optional count of nodes that would be displayed in the next level were this node in the navigation path.

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false the component is hidden and is not evaluated. Default: true.

Usage considerations

Drillable and non-drillable elements

You can see some of these terms and parameters labeled in the following screenshot.

screenshot of a tree browser with annotated nodes

  • The hierarchy browser tree component does not permit links in images in node configurations.
  • The identifier field can be any value, but using long strings or large data types could cause performance problems. We recommended using a data type's primary key, if available.

Using the nodeConfigs parameter

  • The variable fv!nodeValue is only available when the node is used in either the nodeConfigs or nextColumnValues parameters of the browser.
  • A hierarchy browser tree node can only be displayed if passed to the nodeConfigs parameter of the hierarchy browser tree.

Examples

For an example of how to configure a hierarchy browser tree node, see the example in the Tree Browser Component page.

Open in Github Built: Fri, Oct 22, 2021 (11:11:24 AM)

On This Page

FEEDBACK