figuredisplay module¶

class FigureDisplay(label, figure_func, inputs, states=None, output=None, clickdata_func=None)¶

Bases: object

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)

layout()¶

Define the layout for the FigureDisplay module.

Because this module can be used as a a component in other modules, it needs to have a layout method that is not abstract. For implementations as tab or window, this method should still be overridden.

Returns:: A Dash HTML Div component representing the layout of the module to be displayed directly.
Return type:: html.Div

module_callbacks()¶

Define the callbacks for the module.

Return type:: None

class FigureDisplayTab(label, figure_func, inputs, states=None, output=None, clickdata_func=None)¶

Bases: TabImplementation, FigureDisplay

FigureDisplay implemented as a tab.

Parameters:

label (str)
figure_func (Callable[[...], Any])
inputs (list[str])
states (list[str] | None)
output (str | None)
clickdata_func (Callable[[...], Any] | None)

class FigureDisplayWindow(label, figure_func, inputs, states=None, output=None, clickdata_func=None)¶

Bases: WindowImplementation, FigureDisplay

FigureDisplay implemented as a window.

Parameters:

label (str)
figure_func (Callable[[...], Any])
inputs (list[str])
states (list[str] | None)
output (str | None)
clickdata_func (Callable[[...], Any] | None)