PresentationTreeDataProviderProps Interface

building APIs (see https://github.com/iTwin/presentation/blob/33e79ee8d77f30580a9bab81a72884bda008db25/README.md#the-packages).

Properties for creating a PresentationTreeDataProvider instance.

Extends

Properties

Name Type Description
appendChildrenCountForGroupingNodes boolean | undefined Should grouping nodes have a suffix with grouped nodes count.  
customizeTreeNodeItem (item: Partial<DelayLoadedTreeNodeItem>, node: Partial<Node>) => void | undefined Callback which provides a way to customize how data is mapped between Node and TreeNodeItem.  
dataSourceOverrides Partial<PresentationTreeDataProviderDataSourceEntryPoints> | undefined By default the provider uses PresentationManager accessed through Presentation.presentation to request  
hierarchyLevelSizeLimit number | undefined The limit for how many ECInstances should be loaded for a single hierarchy level.  
imodel IModelConnection IModel to pull data from.  
onHierarchyLimitExceeded () => void | undefined Callback for when the hierarchy limit is exceeded while loading nodes.  
pagingSize number | undefined Paging size for obtaining nodes.  
ruleset string | Ruleset Id of the ruleset to use when requesting content or a ruleset itself.  

Inherited properties

Name Type Inherited from Description
devDiagnostics Inherited { backendVersion?: boolean, handler: ClientDiagnosticsHandler, perf?: boolean | { minimumDuration: number }, severity?: DiagnosticsLoggerSeverity } | undefined DiagnosticsProps Settings for capturing rules engine diagnostics.
ruleDiagnostics Inherited { handler: ClientDiagnosticsHandler, severity?: DiagnosticsLoggerSeverity } | undefined DiagnosticsProps Settings for capturing rule diagnostics.

Defined in

Last Updated: 17 December, 2024