shyft.dashboard.widgets.water_route_widget

Classes

WaterRouteWidget(water_route_graph[, ...])

Simple water route graph app with a single port to receive a list of hydro power system objects to visualize the graph based on the internal topology of the hydro power systems.

class shyft.dashboard.widgets.water_route_widget.WaterRouteWidget(water_route_graph, logger=None, padding=None, sizing_mode=None, widget_width=300, widget_height=70, height=1024, aspect_factor=1.4, auto_reload=True)

Bases: Widget

Simple water route graph app with a single port to receive a list of hydro power system objects to visualize the graph based on the internal topology of the hydro power systems.

Base class for all Widgets

Parameters:

• logger (Logger | None) – Optional logger, e.g composable_logger_box

• water_route_graph (WaterRouteGraph)

• padding (int | None)

• sizing_mode (str | None)

• widget_width (int)

• widget_height (int)

• height (int)

• aspect_factor (float)

• auto_reload (bool)

__init__(water_route_graph, logger=None, padding=None, sizing_mode=None, widget_width=300, widget_height=70, height=1024, aspect_factor=1.4, auto_reload=True)

Base class for all Widgets

Parameters:

• logger (Logger | None) – Optional logger, e.g composable_logger_box

• water_route_graph (WaterRouteGraph)

• padding (int | None)

• sizing_mode (str | None)

• widget_width (int)

• widget_height (int)

• height (int)

• aspect_factor (float)

• auto_reload (bool)

Return type:

None

property layout: LayoutDOM

property layout_components: Dict[str, List[Any]]

Property to return all layout.dom components of an visualisation app such that they can be arranged by the parent layout obj as desired.

Returns:

layout_components as

Return type:

{‘widgets’: [], ‘figures’: []}