Skip to content

Dashboard#

Dashboard serves as the main container for organizing and presenting data through interactive visualizations. It's the base class that everything else builds upon.

Requirements#

The Dashboard class requires:

  • workspace_slug: Identifies the workspace
  • app_slug: Identifies the app within the workspace
  • slug: Identifies the dashboard within the app
  • content: The layout and widgets to display

Content#

You place layout components and widgets inside the Dashboard's content parameter:

  • Layout (Grid, Row, Column, etc.)
  • Single widgets (Table, Timeseries, Maps, etc.)

For more details on layout and widgets, refer to the Layout and Widgets sections.

Dashboard Versioning#

When you publish a dashboard, new dashboard versions are created automatically. Versions are based on date/hour, providing a chronological history of your dashboard changes.

By default, dashboard versions are activated immediately upon creation. When a new version is activated, any previously activated version gets deactivated automatically. You can also cycle through each version you want by activating and deactivating specific versions as needed through the CLI or the Management Portal.

For more details, check Dashboard Management Page

Activation#

By default, dashboard versions are activated immediately upon creation. Set activate=False to create in draft mode, which can then be activated via CLI command or in the Management Portal.

from engineai.sdk.dashboard.dashboard import Dashboard

Dashboard(
    ...
    activate=False,  # Create version in draft mode, True by default
)