shyft.dashboard.time_series.view_container.view_container_base

Classes

BaseViewContainer(*, viewer)

This object is the base class of view container

class shyft.dashboard.time_series.view_container.view_container_base.BaseViewContainer(*, viewer: shyft.dashboard.time_series.ts_viewer.TsViewer)

Bases: Bindable, Hashable

This object is the base class of view container

__init__(*, viewer: shyft.dashboard.time_series.ts_viewer.TsViewer)

Parameters:

viewer – ts viewer instance the base view container should be bound to

set_unit_registry(unit_registry: UnitRegistry) → None

Set the unt registry of this view container

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

abstract add_view(*, view: BaseView) → None

This function adds a new view to the view_container

abstract update_view_data(*, view_data: Dict[BaseView, Quantity[TsVector]]) → None

This function updates the views with new data

abstract clear() → None

This function removes all views from the view_container and resets the meta information

abstract clear_views(*, specific_views: List[BaseView] | None = None) → None

This function removes all or specific views from the view_container

property visible: bool

Visible property is an optional property for all view container,