API Reference › presentation-components› Tree › UsePresentationTreeStateProps

UsePresentationTreeStateProps<TEventHandler extends TreeEventHandler> Interface

Properties for usePresentationTreeState hook.

Extends

Properties

Name Type Description
eventHandlerFactory (props: PresentationTreeEventHandlerProps) => undefined | TEventHandler | undefined Factory function for creating custom tree events handler.  
filteringParams { activeMatchIndex?: number, filter: string } | undefined Parameters for filtering tree.  
onHierarchyLimitExceeded () => void | undefined Callback for when the hierarchy limit is exceeded while loading nodes.  
onNodeLoaded (props: { duration: number, node: string }) => void | undefined Callback for when a tree node is loaded.  
pagingSize number Number of nodes in a single page.  
seedTreeModel TreeModel | undefined Initialize tree data with the provided tree model.  

Inherited properties

Name Type Inherited from Description
appendChildrenCountForGroupingNodes boolean | undefined PresentationTreeDataProviderProps Should grouping nodes have a suffix with grouped nodes count.
customizeTreeNodeItem (item: Partial<DelayLoadedTreeNodeItem>, node: Partial<Node>) => void | undefined PresentationTreeDataProviderProps Callback which provides a way to customize how data is mapped between Node and TreeNodeItem.
dataSourceOverrides Partial<PresentationTreeDataProviderDataSourceEntryPoints> | undefined PresentationTreeDataProviderProps By default the provider uses PresentationManager accessed through Presentation.presentation to request
devDiagnostics { backendVersion?: boolean, handler: ClientDiagnosticsHandler, perf?: boolean | { minimumDuration: number }, severity?: DiagnosticsLoggerSeverity } | undefined PresentationTreeDataProviderProps Settings for capturing rules engine diagnostics.
hierarchyLevelSizeLimit number | undefined PresentationTreeDataProviderProps The limit for how many ECInstances should be loaded for a single hierarchy level.
imodel IModelConnection PresentationTreeDataProviderProps IModel to pull data from.
ruleDiagnostics { handler: ClientDiagnosticsHandler, severity?: DiagnosticsLoggerSeverity } | undefined PresentationTreeDataProviderProps Settings for capturing rule diagnostics.
ruleset string | Ruleset PresentationTreeDataProviderProps Id of the ruleset to use when requesting content or a ruleset itself.

Defined in

Last Updated: 15 November, 2024