PresentationTreeDataProvider Class
Deprecated in 5.7. All tree-related APIs have been deprecated in favor of the new generation hierarchy
building APIs (see https://github.com/iTwin/presentation/blob/33e79ee8d77f30580a9bab81a72884bda008db25/README.md#the-packages).
Presentation Rules-driven tree data provider.
Implements
- IPresentationTreeDataProvider
- __global.Disposable
Methods
| Name | Description | |
|---|---|---|
| constructor(props: PresentationTreeDataProviderProps): PresentationTreeDataProvider | Constructor. | |
| [dispose](): void | Destructor. | |
| createRequestOptions(parentKey: NodeKey, instanceFilter?: InstanceFilterDefinition): { instanceFilter: undefined | InstanceFilterDefinition, parentKey: undefined | NodeKey, sizeLimit?: number } | Creates options for nodes requests. | |
| dispose(): void | Deprecated | |
| 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: 17 December, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.