shyft.dashboard.time_series.sources.ts_adapter¶

Classes

`BasicTsAdapter`(data, unit_registry, unit)	This class is the most basic implementation of a TsAdapter which takes a TimeSeries and returns its evaluation when called
`TsAdapter`()	This object defines the data for a data source.

class shyft.dashboard.time_series.sources.ts_adapter.TsAdapter[source]¶

Bases: ABC

This object defines the data for a data source. With the __call__ data for a given time axis and unit can be provided to be viewed by the ts viewer. The call method must return a Unit annotated TsVector with the time series to show.

abstractmethod __call__(*, time_axis, unit)[source]¶

Call self as a function.

Parameters:

time_axis (TimeAxis)
unit (str | Unit)

Return type:

Quantity[TsVector]

class shyft.dashboard.time_series.sources.ts_adapter.BasicTsAdapter(data, unit_registry, unit)[source]¶

Bases: TsAdapter

This class is the most basic implementation of a TsAdapter which takes a TimeSeries and returns its evaluation when called

Parameters:

data (TimeSeries | TsVector | Quantity)
unit (str)

__init__(data, unit_registry, unit)[source]¶

Parameters:

data (TimeSeries | TsVector | Quantity)
unit (str)

__call__(*, time_axis, unit)[source]¶

Call self as a function.

Parameters:

time_axis (TimeAxis)
unit (str | Unit)

Return type:

Quantity[TsVector]