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

Parameters:

• logger – Optional logger

• parent_limit – number of max parents to use

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

Parameters:

• logger – Optional logger

• parent_limit – number of max parents to use

abstractmethod on_bind(*, parent)

Abstract method which is call on bind to a parent

Parameters:

parent (Any)

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

Bases: ViewTimeAxisTool

A tool to manually select the time step

Parameters:

• title – title of the widget

• logger – optional logger

• width (int)

• height (int | None)

• padding (int | None)

• sizing_mode (str | None)

__init__(title, width=150, height=None, padding=None, sizing_mode=None, logger=None)

Parameters:

• title – title of the widget

• logger – optional logger

• width (int)

• height (int | None)

• padding (int | None)

• sizing_mode (str | None)

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

on_bind(*, parent)

Abstract method which is call on bind to a parent

Parameters:

parent (Any)

Return type:

None

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’

Parameters:

logger – Optional logger

__init__(logger=None)

Parameters:

logger – Optional logger

on_bind(*, parent)

Abstract method which is call on bind to a parent

Parameters:

parent (Any)

property layout: row

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

jump_to_next_period()

jump_to_previous_period()