TreeProps Interface

Deprecated  Use ControlledTree instead. Will be removed in iModel.js 3.0.

Properties for the DEPRECATED_Tree component

Extends

Methods

Name Description
checkboxInfo(node: TreeNodeItem): CheckBoxInfo | Promise<CheckBoxInfo> Optional Alternative source of truth for node checkbox information.  
onCheckboxClick(stateChanges: { newState: CheckBoxState, node: TreeNodeItem }[]): void Optional Called when nodes change their checkbox state.  
onChildrenLoaded(parent: TreeNodeItem, children: TreeNodeItem[]): void Optional Callback that's called when child nodes are loaded.  
onNodeCollapsed(node: TreeNodeItem): void Optional Callback that's called when node is collapsed  
onNodeExpanded(node: TreeNodeItem): void Optional Callback that's called when node is expanded  
onNodesRender(): void Optional    
onRender(): void Optional    
onRootNodesLoaded(nodes: TreeNodeItem[]): void Optional Callback that's called when root nodes are loaded.  
onSelectionLoadCanceled(): void Optional Called when selection load is canceled.  
onSelectionLoadFinished(): void Optional Called when selection load is finished  
onSelectionLoadProgress(loaded: number, total: number, cancel: () => void): void Optional Called to report progress of selection load.  

Properties

Name Type Description
bulkCheckboxActionsDisabled undefined | boolean Set to true to remove the ability to control multiple checkboxes using a single click.  
cellEditing undefined | EditableTreeProps Properties for cell editing logic.  
dataProvider TreeDataProvider Nodes provider  
disposeChildrenOnCollapse undefined | boolean Should child nodes be disposed when parent node is collapsed.  
imageLoader undefined | ITreeImageLoader Custom image loader.  
nodeHighlightingProps undefined | HighlightableTreeProps Properties for node highlighting logic.  
pageSize undefined | number Size of a single page that's requested from dataProvider (only  
propertyValueRendererManager undefined | PropertyValueRendererManager Custom property value renderer manager  
renderOverrides undefined | { renderCheckbox?: NodeCheckboxRenderer, renderNode?: } Contains render overrides for different pieces of the tree component  
rowHeight number | (node?: TreeNodeItem, index?: number) => number A constant value for row height, or a function that calculates row height based on rendered node  
selectedNodes string[] | (node: TreeNodeItem) => boolean Describes nodes that should be selected.  
selectionMode undefined | SelectionMode Mode of nodes' selection in the tree  
showDescriptions undefined | boolean Turns on node description rendering when enabled  
showIcons undefined | boolean Turns on icon rendering when enabled  

Inherited properties

Name Type Inherited from Description
className undefined | string CommonProps Custom CSS class name
style undefined | CSSProperties CommonProps Custom CSS style properties

Defined in

Last Updated: 12 June, 2024