Dashboards in notebooks

This page describes how to create dashboards based on notebook cell outputs. Dashboards allow you to publish graphs and visualizations, and then share them in a presentation format with your organization.

Create or add to a dashboard

You create a dashboard by adding an item to it. There are two types of dashboards you can create from a notebook.

• Notebook dashboard: Notebook dashboards reformat your notebook into a presentation. The dashboard content is tied to the output of a notebook cell. You can share and schedule notebook dashboards as you would with any notebook.
• AI/BI dashboard: Databricks recommends AI/BI dashboards for creating and sharing dashboards across an organization. For more information about AI/BI dashboards, see Dashboards.

To add a visualization or output results table to a dashboard, click the down arrow next to the tab name. Then, choose the dashboard type you want to build.

Create or add to a notebook dashboard

note

Content in notebook dashboards are tied to the output of notebook cells. If you clear the cell output, the dashboard content will also be cleared.

To create a notebook dashboard, use the following steps:

• Select Add to notebook dashboard >.
  • If you select Add to new notebook dashboard, the new dashboard is automatically displayed.
  • To add the plot to an existing dashboard, click the name of the dashboard. A checkmark appears to indicate that the plot is now on that dashboard. The dashboard is not automatically displayed. To go to the dashboard, click to the right of the dashboard name.

Create or add to an AI/BI dashboard

note

Only visualizations from SQL cells can be added to AI/BI dashboards.

To create an AI/BI dashboard, use the following steps:

1. Select Add to dashboard.
2. In the Add to dashboard dialog, select Create a new dashboard or Add to existing dashboard.

If you select Create new dashboard:

1. An automatically generated dashboard title is provided in the Name field. Type a new name to rename the dashboard.
2. Select the widgets you want to appear on the dashboard.
3. Click Create.

If you select Add to existing dashboard:

1. Use the drop-down menu in the Name field to select the dashboard for your visualization.
2. Select the widgets that you want to include.
3. Click Import.

You can configure and edit visualizations on your dashboard's pages. You can access the queries associated with your visualizations in your dashboard's Data tab. The remaining instruction in this article pertains to notebook dashboards. To learn how to manage and share your AI/BI dashboard, see Dashboards.

Control size and placement of items on a notebook dashboard

• To resize an item, click at the lower-right corner and move your cursor until the item is the size you want.
• To move an item, click in the item and hold while you move your cursor.
• There are two layout options in the right panel, Stack and Float. Stack keeps the items neatly lined up on the dashboard. To move items around more freely, select Float.
• To add a name to a plot, move your cursor over the plot. A control panel appears on the right.
  • Select the Settings icon . The Configure Dashboard Element dialog appears.
  • In the dialog, click Show Title, enter a title for the plot, and click Save.
• To remove the item from the dashboard, move your cursor over the plot to display the control panel in the upper-right corner, and click .

Add a title to a notebook dashboard

On the right panel, click to edit the dashboard title. Enter the new title for the dashboard. Click to save the title.

Navigate between a notebook dashboard and a notebook

In the top right of a notebook or notebook dashboard, click to view all dashboards associated with the notebook. Click on a dashboard's name to switch to a view of that dashboard. Click Notebook view to switch back to the notebook editor.

To go from a dashboard directly to the notebook cell that created a plot, hover over the plot, then click on the right side.

Present a notebook dashboard

To present a dashboard, click Fullscreen. To return to the interactive dashboard, click Exit in the upper-left corner or press the Esc key.

Delete a notebook dashboard

To delete a dashboard, click Delete this dashboard.

Create a scheduled job to refresh a notebook dashboard

To schedule a dashboard to refresh at a specified interval, click to create a scheduled job for the notebook that generates the plots on the dashboard. For details about scheduled jobs, see Create and manage scheduled notebook jobs.