Clara Viz Widgets API Reference

clara-viz-widgets: Jupyter widgets for Clara Viz.

class clara.viz.widgets.Widget(*args, **kwargs)[source]

An interactive render widget.

settings

a dict with render settings

width

width of the video stream

height

height of the video stream

frame_rate

frame rate of the video stream

bit_rate

bit rate of the video stream

__init__(renderer=None, data_definition=None, **kwargs)[source]

Construct a widget

Parameters
  • renderer – renderer to use, if not specified the widget is creating a renderer (optional)

  • data_definition – dataset definition (optional)

bit_rate

An int trait.

frame_rate

A float trait.

height

An int trait.

select_data_definition(data_definition: clara.viz.core.datadefinition.DataDefinition)[source]

Select data from a DataDefinition.

Parameters

dataset_definition – a DataDefinition object

set_settings()[source]

Update the render settings.

width

An int trait.