Dashboard

Dashboard

Dashboard(
    *,
    slug: str,
    app_slug: str,
    workspace_slug: str,
    content: Union[List[Page], Page, DashboardContent],
    title: Optional[str] = None,
    **kwargs: Any
)

Central component for managing layouts, widgets, cards.

The Dashboard class is the central component for creating and managing dashboards. It serves as the container for various layout elements, widgets, and cards.

Constructor for Dashboard.

Parameters:

Name	Type	Description	Default
slug	str	Unique identifier for dashboard.	required
app_slug	str	App slug where the dashboard will be published.	required
workspace_slug	str	Workspace slug where the dashboard will be published.	required
content	Union[List[Page], Page, DashboardContent]	Dashboard content.	required
**kwargs	Any	Deprecated arguments	{}

PublishMode

Dashboard Publish Mode.

Attributes:

Name	Type	Description
DEFAULT		Default publish mode. The dashboard does not create new runs and automatically activates the published version.
DEV		Development publish mode. The dashboard creates new runs and automatically activates the published version/run.
DRAFT		Draft publish mode. The dashboard creates new runs but does not activate the published version/run.
LIVE		Live publish mode. The dashboard creates new runs and automatically activates only the published run.

Version: Set using the Dashboard version argument.

Run: Automatically set based on the published date.