shyft.dashboard.time_series.tools.view_time_axis_tools

Classes

DeltaTSelectorTool(title[, width, height, ...])	A tool to manually select the time step
ViewPeriodSelector([logger])	Tool to set the time interval to step forward or backward in the graph by pushing a button 'Previous' and 'Next'
ViewTimeAxisTool([logger, parent_limit])	Base tool class for view time axis

Exceptions

ViewTimeAxisToolError

exception shyft.dashboard.time_series.tools.view_time_axis_tools.ViewTimeAxisToolError

Bases: RuntimeError

class shyft.dashboard.time_series.tools.view_time_axis_tools.ViewTimeAxisTool(logger=None, *, parent_limit=None)

Bases: BaseTool

Base tool class for view time axis

__init__(logger=None, *, parent_limit=None)

Parameters:

• logger – Optional logger

• parent_limit – number of max parents to use

abstract on_bind(*, parent: Any)

Abstract method which is call on bind to a parent

class shyft.dashboard.time_series.tools.view_time_axis_tools.DeltaTSelectorTool(title, width: int = 150, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger=None)

Bases: ViewTimeAxisTool

A tool to manually select the time step

__init__(title, width: int = 150, height: int | None = None, padding: int | None = None, sizing_mode: str | None = None, logger=None)

Parameters:

• title – title of the widget

• logger – optional logger

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

on_bind(*, parent: Any) → None

Abstract method which is call on bind to a parent

class shyft.dashboard.time_series.tools.view_time_axis_tools.ViewPeriodSelector(logger=None)

Bases: ViewTimeAxisTool

Tool to set the time interval to step forward or backward in the graph by pushing a button ‘Previous’ and ‘Next’

__init__(logger=None)

Parameters:

logger – Optional logger

on_bind(*, parent: Any)

Abstract method which is call on bind to a parent

property layout: row

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

jump_to_next_period()

jump_to_previous_period()