[Tree Widget]: Filter out unwanted elements in the tree?

[glewis-bentley]

Package
@itwin/tree-widget-react

In the classification tree, we have some child elements that we do not want to show to the user, because these sub-elements are not something the user deals with directly. An example is a Pipe element - it has PipingPort elements as children elements, but those are not directly edited by the user so it would be good to be able to hide them.

Is there was a way to provide a filter to the elements that are being shown in the tree, or is this something that could be considered as a future enhancement?

Thanks!

[JonasDov]

Currently, classifications tree doesn't offer a way to filter out specific child elements from the hierarchy.

How would you identify elements which shouldn't be shown: specific class / property value / relationship / something else?

[glewis-bentley]

In this particular case it would be great to specify the class name that shouldn't be shown

[grigasp]

I think there are ways for us to allow consumers specify an additional instance filter for the hierarchy. However, what I'm most worried about is visibility control. Image the following hierarchy:

- Classification table
  - Classification
    - Parent element
      - Child element (filtered-out)

Should "Child element" participate in visibility workflows? E.g.:

1. if its visibility is turned off, should that affect visibility state of ancestor nodes in the tree?
2. if its visibility is turned on and I disable display of "Classification" node, should display of the child element also be turned off?

[JonasDov]

Would you expect this filtering to apply only to the classifications tree, or consistently across all trees (classifications + models + categories)? If your application shows multiple trees, it could be confusing that an element is not shown in classifications tree but is shown in categories/models trees.

[glewis-bentley]

@grigasp Are you referring to visibility in the viewport? If so, I think I'd expect the child element to follow the visibility of its ancestors, i.e., if the parent elements are turned on then the child element should also be shown in the viewport, and vice versa.

@JonasDov @Rock2000 do you have any ideas for this? I think I would expect that it would be best to keep it consistent and we wouldn't show the PipingPort elements in the other trees?