UsePresentationTreeStateProps<TEventHandler extends TreeEventHandler> Interface
Properties for usePresentationTreeState hook.
Extends
Properties
| Name | Type | Description | |
|---|---|---|---|
| eventHandlerFactory | undefined | (props: PresentationTreeEventHandlerProps) => undefined | TEventHandler | ||
| filteringParams | undefined | { activeMatchIndex?: number, filter: string } | Parameters for filtering tree. | |
| pagingSize | number | Number of nodes in a single page. | |
| seedTreeModel | undefined | TreeModel | Initialize tree data with the provided tree model. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| appendChildrenCountForGroupingNodes | undefined | boolean | PresentationTreeDataProviderProps | Should grouping nodes have a suffix with grouped nodes count. |
| customizeTreeNodeItem | undefined | (item: Partial<DelayLoadedTreeNodeItem>, node: Partial<Node>) => void | PresentationTreeDataProviderProps | |
| dataSourceOverrides | undefined | Partial<PresentationTreeDataProviderDataSourceEntryPoints> | PresentationTreeDataProviderProps | By default the provider uses PresentationManager accessed through Presentation.presentation to request |
| hierarchyLevelSizeLimit | undefined | number | PresentationTreeDataProviderProps | The limit for how many ECInstances should be loaded for a single hierarchy level. |
| imodel | IModelConnection | PresentationTreeDataProviderProps | IModel to pull data from. |
| ruleset | string | Ruleset | PresentationTreeDataProviderProps | Id of the ruleset to use when requesting content or a ruleset itself. |
Defined in
Last Updated: 25 March, 2024
Found something wrong, missing, or unclear on this page?
Raise an issue in our repo.