figuredisplay module

class FigureDisplay(label, figure_func, inputs, states=None, output=None, clickdata_func=None, as_type=None, **kwargs)

Bases: ModuleBase

This module is used to display a plotly figure in the editing framework.

It simplifies connecting a figure to the variable selector and allows for any figure to be used as long as it works in Dash. It also allows for click data to be processed and passed to the variable selector.

Parameters:

  • label (str)

  • figure_func (Callable[[...], Any])

  • inputs (list[str])

  • states (list[str] | None)

  • output (str | None)

  • clickdata_func (Callable[[...], Any] | None)

  • as_type (Literal['Tab', 'Window'] | None)

  • kwargs (Any)

icon: str | Component
implemented_as: Literal['Tab', 'Window'] | None
label: str
layout()

Create the layout of the module itself, without tab/window wrapping.

Return type:

Div

module_callbacks()

Define the callbacks for the module.

Return type:

None

module_id: str
module_layout: Div | Tab
module_name: str
module_number: int