kd_ext.vis API

Koda visualization functionality.

Subcategory	Description
AccessType	Types of accesses that can appear in an access path.
DataSliceVisOptions	Options for visualizing a DataSlice.
DescendMode	Create a collection of name/value pairs.

kd_ext.vis.AccessType(*values)

Types of accesses that can appear in an access path.

kd_ext.vis.DataSliceVisOptions(num_items: int = 48, unbounded_type_max_len: int = 256, detail_width: int | str | None = None, detail_height: int | str | None = 300, attr_limit: int | None = 20, item_limit: int | None = 20, repr_depth: int = 2, max_folds: int = 2)

Options for visualizing a DataSlice.

kd_ext.vis.DescendMode(*values)

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

- attribute access:

  >>> Color.RED
  <Color.RED: 1>

- value lookup:

  >>> Color(1)
  <Color.RED: 1>

- name lookup:

  >>> Color['RED']
  <Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own
attributes -- see the documentation for details.

kd_ext.vis.register_formatters() -> bool

Register DataSlice visualization in IPython.

Returns:
  True if the formatters were registered, False if they were already
  registered.

kd_ext.vis.unregister_formatters() -> bool

Unregister DataSlice visualization in IPython.

Returns:
  True if the formatters were unregistered, False if they were not registered.

kd_ext.vis.visualize_slice(ds: DataSlice, options: DataSliceVisOptions | None = None) -> _DataSliceViewState

Visualizes a DataSlice as a html widget.