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(...)``.

.. currentmodule:: tshistory_dashboard.api

.. autosummary::
   :toctree: generated/
   :nosignatures:

   ~DashboardAPI.update_figure
   ~DashboardAPI.figures_catalog
   ~DashboardAPI.figure_exists
   ~DashboardAPI.get_figure
   ~DashboardAPI.figure_dependents
   ~DashboardAPI.delete_figure
   ~DashboardAPI.rename_figure
   ~DashboardAPI.dashboards_catalog
   ~DashboardAPI.update_dashboard
   ~DashboardAPI.dashboard_exists
   ~DashboardAPI.get_dashboard
   ~DashboardAPI.delete_dashboard
   ~DashboardAPI.rename_dashboard
   ~DashboardAPI.balance_list
   ~DashboardAPI.balance_formula
   ~DashboardAPI.balance_exists
   ~DashboardAPI.update_balance
   ~DashboardAPI.rename_balance
   ~DashboardAPI.delete_balance