Hierarchy Browser Node (Columns) Component

Function

a!hierarchyBrowserFieldColumnsNode( id, label, image, link, isSelectable, isDrillable, nextColumnCount, showWhen )

Returns a Browser Field Columns Node, used in the Node Configurations parameter of the Columns Browser 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 column.

Label

label

Text

Required text to display in the node.

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 selectable

isSelectable

Boolean

If true, clicking the node will save the columns browser's selection value and navigation path. If false, clicking the node will not save the selection value. It may still save the navigation path if the node is drillable. On hover, a selectable node will have a unique display. (default: true)

Node is drillable

isDrillable

Boolean

If true, clicking the node will save the columns browser's navigation path, revealing another column to the user. If false, clicking the node will not reveal another column. It may still save the navigation path if the node is selectable. On hover, a drillable node will have a unique display. (default: true)

Next Column Count

nextColumnCount

Integer

The number of nodes that would be displayed if the user drilled into this node. This value is optional and is displayed on mobile only.

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 selectable nodes

You can see some of these terms and parameters (isDrillable and isSelectable) labeled in the following screenshot.

screenshot of the columns browsers with annotated nodes

Using the nodeConfigs and identifier parameters

  • A columns browser node can only be displayed if passed to the nodeConfigs parameter of the columns browser.
  • The variable fv!nodeValue is only available when the columns browser node is used in either the nodeConfigs or nextColumnValues parameters of the columns browser.
  • 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.
  • The columns browser component does not support dynamic links nor submit links node configurations.
  • The columns browser component does not permit links in images in node configurations.

Examples

For an example of how to configure a columns browser node, see the example in the Columns Browser.

The following patterns include usage of the Hierarchy Browser Node (Columns) Component.

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

On This Page

FEEDBACK