display#
- treescope.display(value: Any, ignore_exceptions: bool = False, roundtrip_mode: bool = False, autovisualize: bool | Autovisualizer | None = None, streaming: bool = True, compress_html: bool = True)[source]#
Displays a value as an interactively foldable object.
Uses the default renderer.
- Parameters:
value – Value to display.
ignore_exceptions – Whether to catch errors during rendering of subtrees and show a fallback for those subtrees.
roundtrip_mode – Whether to start in roundtrip mode.
autovisualize – Optional autovisualizer override. If True, renders using the default autovisualizer (usually an array autovisualizer). If False, disables automatic visualization. If a function or object, uses that autovisualizer. If None (the default), uses the current active autovisualizer (if any) without overriding it.
streaming – Whether to render in streaming mode, which immediately displays the structure of the output while computing more expensive leaf renderings. This is useful in interactive contexts, but can mess with other users of IPython’s formatting because the final rendered HTML is empty.
compress_html – Whether to zlib-compress (i.e. zip) treescope renderings to reduce their size when transmitted to the browser or saved into a notebook.
- Raises:
RuntimeError – If IPython is not available.