API Reference > ui-components > Tree > BeInspireTree BeInspireTree<TNodePayload> Class Bentley wrapper for 'inspire-tree' Methods Name Description constructor(props: BeInspireTreeProps<TNodePayload>): BeInspireTree collapsed(): BeInspireTreeNodes<TNodePayload> Get a flat list of collapsed nodes deepest(): BeInspireTreeNodes<TNodePayload> Get a flat list of available leaf nodes deselectAll(muteEvents: boolean = true): void Deselects all nodes expanded(): BeInspireTreeNodes<TNodePayload> Get a flat list of expanded nodes flatten(): BeInspireTreeNodes<TNodePayload> Get flat list of all available nodes getVisibleNodesBetween(node1: BeInspireTreeNode<TNodePayload>, node2: BeInspireTreeNode<TNodePayload>): Array<BeInspireTreeNode<TNodePayload>> Returns all visible nodes that are located between the two input nodes (inclusive). mute(events: BeInspireTreeEvent[]): EventsMuteContext Stop emitting the specified events until the returned node(id: string): BeInspireTreeNode<TNodePayload> | undefined Get root node with the specified id nodes(ids?: string[]): BeInspireTreeNodes<TNodePayload> Get root nodes with the specified ids on(event: BeInspireTreeEvent | BeInspireTreeEvent[], listener: (...values: any[]) => void): this Add a listener for specific event pauseRendering(allowedRendersBeforePause: number = 0): EventsMuteContext Stop calling the renderer method until the returned reload(): Promise<void> Reload the tree removeAllListeners(event?: BeInspireTreeEvent | BeInspireTreeEvent[]): void Remove all listeners for specific event(s) removeListener(event: BeInspireTreeEvent | BeInspireTreeEvent[], listener: (...values: any[]) => void): this Remove listener for specific event requestNodeLoad(parent: BeInspireTreeNode<TNodePayload> | undefined, index: number): Promise<void> Request a node at the specified index to be loaded for the given parent. selectBetween(node1: BeInspireTreeNode<TNodePayload>, node2: BeInspireTreeNode<TNodePayload>, muteEvents: boolean = true): Array<BeInspireTreeNode<TNodePayload>> Selects all visible nodes that are located between the two input nodes (inclusive). selected(): BeInspireTreeNodes<TNodePayload> Get a flat list of selected nodes updateNodesCheckboxes(nodes: BeInspireTreeNodes<TNodePayload>, checkboxInfo: (payload: TNodePayload) => CheckBoxInfo | Promise<CheckBoxInfo>, muteEvents: boolean = true): Promise<void> Updates checkbox states of provided nodes based on checkboxInfo callback function updateNodesSelection(nodes: BeInspireTreeNodes<TNodePayload> | TreeNodes, nodesToSelect?: string[] | (payload: TNodePayload) => boolean, muteEvents: boolean = true): void Updates selection state of provided nodes based on nodesToSelect criteria updateTreeCheckboxes(checkboxInfo: (payload: TNodePayload) => CheckBoxInfo | Promise<CheckBoxInfo>, muteEvents: boolean = true): Promise<void> Updates checkbox states of the whole tree using the checkboxInfo callback function updateTreeSelection(nodesToSelect?: string[] | (payload: TNodePayload) => boolean, muteEvents: boolean = true): void Deselects everything and selects only nodes that meet the nodesToSelect criteria visible(): BeInspireTreeNodes<TNodePayload> Get a flat list of visible nodes Properties Name Type Description props BeInspireTreeProps<TNodePayload> ready Accessor ReadOnly Promise<void> Defined in ui/components/src/ui-components/tree/component/BeInspireTree.ts Line 235 Last Updated: 13 June, 2024