Dashboards#

Note

This is an essential feature of the Timeseries Refinery. It is only accessible within the pro version. If interested, please visit: https://timeseries.pythonian.fr/#ouroffer.

Dashboards let users assemble interactive visualizations (figures, dashboards, balances) from time series data. These API points are reachable through the dashboard attribute of the api object, e.g. tsa.dashboard.get_dashboard(...).

update_figure

Create or update a figure configuration.

figures_catalog

Return all figure names grouped by variant.

figure_exists

Return True if a figure with the given name exists.

get_figure

Return the Figure identified by name, or None if absent.

figure_dependents

Return the names of dashboards that reference name.

delete_figure

Delete the figure identified by name.

rename_figure

Rename a figure.

dashboards_catalog

Return a DashboardSummary list for all dashboards.

update_dashboard

Create or update a dashboard configuration.

dashboard_exists

Return True if a dashboard with the given name exists.

get_dashboard

Return the Dashboard identified by name, or None if absent.

delete_dashboard

Delete the dashboard identified by name; no-op if absent.

rename_dashboard

Rename a dashboard.

balance_list

Return the names of all registered balance definitions, sorted.

balance_formula

Return the lisp source of the balance definition identified by name, or None if absent.

balance_exists

Return True if a balance definition with the given name exists.

update_balance

Create or update a balance definition.

rename_balance

Rename a balance definition.

delete_balance

Delete the balance definition identified by name; no-op if absent.