Skip to content

Commit

Permalink
docs(tree-view): Document new render params
Browse files Browse the repository at this point in the history
  • Loading branch information
ewuerger committed Feb 22, 2024
1 parent cc8ceb2 commit 5f64d03
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/tree_view.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ classes is its own partition.
- DIRECTION_UP
- DIRECTION_DOWN

Additionally the following render parameters are offered:

1. depth - The depth of the computed tree. Defaults to `None` such that the
whole tree is computed. `depth=1` means that only first level properties and
generalizations are collected.
2. super - Generalizations from the `super` attribute, can be set to
- ALL
- ROOT
3. sub - Generalizations from the `sub` attribute, can be set to
- ALL
- ROOT

Here is an example that shows how convenient these parameters can be passed
before rendering:

Expand Down

0 comments on commit 5f64d03

Please sign in to comment.