IFilteredPresentationTreeDataProvider Interface

Filtered presentation tree data provider.

Extends

Methods

Name Description
countFilteringResults(nodePaths: undefined): number Counts all filter matches.  
getActiveMatch(index: number): undefined | ActiveMatchInfo Returns active match for given index.  
nodeMatchesFilter(node: TreeNodeItem): boolean Checks whether node matches applied filter or not.  

Inherited methods

Name Inherited from Description
dispose(): void IPresentationTreeDataProvider Disposes of any resources owned by this object.
getFilteredNodePaths(filter: string): Promise<NodePathElement[]> IPresentationTreeDataProvider Returns filtered node paths.
getNodeKey(node: TreeNodeItem): NodeKey IPresentationTreeDataProvider Returns a NodeKey from given TreeNodeItem.
getNodes(parent?: TreeNodeItem, page?: PageOptions): Promise<DelayLoadedTreeNodeItem[]> IPresentationTreeDataProvider  
getNodesCount(parent?: TreeNodeItem): Promise<number> IPresentationTreeDataProvider  
loadHierarchy(): Promise<void> Optional IPresentationTreeDataProvider Loads the hierarchy so on-demand requests and filtering works quicker

Properties

Name Type Description
filter string Applied filter.  

Inherited properties

Name Type Inherited from Description
imodel Readonly IModelConnection IPresentationTreeDataProvider IModelConnection used by this data provider
onTreeNodeChanged undefined | BeEvent<TreeDataChangesListener> IPresentationTreeDataProvider  
rulesetId Readonly string IPresentationTreeDataProvider Id of the ruleset used by this data provider

Defined in

Last Updated: 11 June, 2024