shyft.dashboard.time_series.view_container.view_container_base¶
Classes
|
This object is the base class of view container |
- class shyft.dashboard.time_series.view_container.view_container_base.BaseViewContainer(*, viewer)[source]¶
-
This object is the base class of view container
- Parameters:
viewer (shyft.dashboard.time_series.ts_viewer.TsViewer) – ts viewer instance the base view container should be bound to
- __init__(*, viewer)[source]¶
- Parameters:
viewer (shyft.dashboard.time_series.ts_viewer.TsViewer) – ts viewer instance the base view container should be bound to
- set_unit_registry(unit_registry)[source]¶
Set the unt registry of this view container
- Parameters:
unit_registry (UnitRegistry)
- Return type:
None
- abstract property layout: Any¶
This property returns the preferred layout of the view_container
- abstract property layout_components: Dict[str, List[Any]]¶
This property returns all layout components of the view_container
- abstractmethod add_view(*, view)[source]¶
This function adds a new view to the view_container
- Parameters:
view (BaseView)
- Return type:
None
- abstractmethod update_view_data(*, view_data)[source]¶
This function updates the views with new data
- abstractmethod clear()[source]¶
This function removes all views from the view_container and resets the meta information
- Return type:
None
- abstractmethod clear_views(*, specific_views=None)[source]¶
This function removes all or specific views from the view_container
- Parameters:
specific_views (List[BaseView] | None)
- Return type:
None
- property visible: bool¶
Visible property is an optional property for all view container,