:py:mod:`abacusai.graph_dashboard`
==================================

.. py:module:: abacusai.graph_dashboard


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   abacusai.graph_dashboard.GraphDashboard




.. py:class:: GraphDashboard(client, name=None, graphDashboardId=None, createdAt=None, projectId=None, pythonFunctionIds=None, plotReferenceIds=None, pythonFunctionNames=None, projectName=None, description=None)


   Bases: :py:obj:`abacusai.return_class.AbstractApiClass`

   A Graph Dashboard

   :param client: An authenticated API Client instance
   :type client: ApiClient
   :param name: The user-friendly name for the graph dashboard.
   :type name: str
   :param graphDashboardId: The unique identifier of the graph dashboard.
   :type graphDashboardId: str
   :param createdAt: Date and time at which the graph dashboard was created, in ISO-8601 format.
   :type createdAt: str
   :param projectId: The unique identifier of the project this graph dashboard belongs to.
   :type projectId: str
   :param pythonFunctionIds: List of Python function IDs included in the dashboard.
   :type pythonFunctionIds: list[str]
   :param plotReferenceIds: List of the graph reference IDs for the plots to the dashboard.
   :type plotReferenceIds: list[str]
   :param pythonFunctionNames: List of names of each of the plots to the dashboard.
   :type pythonFunctionNames: list[str]
   :param projectName: The name the graph dashboard belongs to.
   :type projectName: str
   :param description: The description of the graph dashboard.
   :type description: str

   .. py:method:: __repr__()

      Return repr(self).


   .. py:method:: to_dict()

      Get a dict representation of the parameters in this class

      :returns: The dict value representation of the class parameters
      :rtype: dict


   .. py:method:: refresh()

      Calls describe and refreshes the current object's fields

      :returns: The current object
      :rtype: GraphDashboard


   .. py:method:: describe()

      Describes a given graph dashboard.

      :param graph_dashboard_id: Unique identifier for the graph dashboard.
      :type graph_dashboard_id: str

      :returns: An object containing information about the graph dashboard.
      :rtype: GraphDashboard


   .. py:method:: delete()

      Deletes a graph dashboard

      :param graph_dashboard_id: Unique string identifier for the graph dashboard to be deleted.
      :type graph_dashboard_id: str


   .. py:method:: update(name = None, python_function_ids = None)

      Updates a graph dashboard

      :param name: Name of the dashboard.
      :type name: str
      :param python_function_ids: List of unique string identifiers for the Python functions to be used in the graph dashboard.
      :type python_function_ids: list

      :returns: An object describing the graph dashboard.
      :rtype: GraphDashboard



