useControlledTreeFiltering Function

Deprecated  Use useControlledPresentationTreeFiltering

Beta   A custom hook that creates filtered model source and node loader for supplied filter. If filter string is not provided or filtering is still in progress it returns supplied model source and node loader.

useControlledTreeFiltering(props: ControlledPresentationTreeFilteringProps): { filteredModelSource: TreeModelSource, filteredNodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>, isFiltering: boolean, matchesCount: undefined | number, nodeHighlightingProps: undefined | HighlightableTreeProps }

note It is required for the tree to use IPresentationTreeDataProvider.

Parameter Type Description
props ControlledPresentationTreeFilteringProps  

Returns - { filteredModelSource: TreeModelSource, filteredNodeLoader: AbstractTreeNodeLoaderWithProvider<IPresentationTreeDataProvider>, isFiltering: boolean, matchesCount: undefined | number, nodeHighlightingProps: undefined | HighlightableTreeProps }

Defined in

Last Updated: 12 June, 2024