hierarchyLevelSizeLimit

hierarchyLevelSizeLimit: number | undefined

The limit for how many ECInstances should be loaded for a single hierarchy level. If the limit is exceeded, the data provider returns a single PresentationInfoTreeNodeItem asking the user to apply filtering to reduce the size of the hierarchy level.

Specifying the limit is useful when creating unlimited size result sets is not meaningful - this allows the library to return early as soon as the limit is reached, instead of creating a very large result that's possibly too large to be useful to be displayed to end users.

Warning: The data provider has no way of knowing whether hierarchy level filtering is enabled at the component level - API consumers, when using this attribute, should make sure to enable filtering or otherwise large hierarchy levels will become impossible to filter-down.

@see Hierarchies' filtering and limiting

@note Requires @itwin/presentation-frontend peer dependency to be at least 4.0, otherwise has no effect.

Defined in

• packages/components/src/presentation-components/tree/DataProvider.ts Line 85