From b57de03a24f9d733c319a7bcad32e63c963c952d Mon Sep 17 00:00:00 2001 From: ewuerger Date: Thu, 22 Feb 2024 15:59:12 +0100 Subject: [PATCH] docs(tree-view): Document new render params --- docs/tree_view.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/tree_view.md b/docs/tree_view.md index e054a0f6..ee7de1f4 100644 --- a/docs/tree_view.md +++ b/docs/tree_view.md @@ -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: