PresentationTreeDataProvider Class

Presentation Rules-driven tree data provider.

Implements

Methods

Name Description
constructor(props: PresentationTreeDataProviderProps): PresentationTreeDataProvider Constructor.  
createRequestOptions(parentKey: NodeKey, instanceFilter?: InstanceFilterDefinition): { instanceFilter: undefined | InstanceFilterDefinition, parentKey: undefined | NodeKey, sizeLimit?: number } Creates options for nodes requests.  
dispose(): void Destructor.  
getFilteredNodePaths(filter: string): Promise<NodePathElement[]> Returns filtered node paths.  
getNodeKey(node: TreeNodeItem): NodeKey Returns a NodeKey from given TreeNodeItem. Deprecated  
getNodes(parentNode?: TreeNodeItem, pageOptions?: PageOptions): Promise<DelayLoadedTreeNodeItem[]> Returns nodes  
getNodesCount(parentNode?: TreeNodeItem): Promise<number> Returns the total number of nodes  

Properties

Name Type Description
hierarchyLevelSizeLimit number | undefined    
imodel Accessor ReadOnly IModelConnection IModelConnection used by this data provider  
pagingSize Accessor undefined | number Paging options for obtaining nodes.  
props Accessor ReadOnly Readonly<PresentationTreeDataProviderProps>    
rulesetId Accessor ReadOnly string Id of the ruleset used by this data provider  

Defined in

Last Updated: 15 November, 2024