Dashboards

Deephaven dashboards allow you to build and customize a layout, or open a layout that has been shared with you. Unlike the Code Studio, which can execute console-based queries, Deephaven's dashboards can only open content generated by Persistent Queries (PQs). PQs are queries that are run on schedules and can be shared among team members.

Like PQs, dashboards can be shared with other users. See sharing for more information on how to share dashboards and manage users' permissions.

In the Navigation Bar, dashboards that are already open appear to the left of the New button, as shown below (e.g., Index Pair, Equity Pair).

img

The majority of the dashboard is made of multiple panels that contain tables or plots. In the screenshot above, the right two quadrants show panels with plots. The left half shows a panel with a table.

Each panel contains only one table or plot. The name of the table or plot contained in each panel is shown in the tab at the top of the panel. You can nest panels into panel stacks, or move and resize them individually. See Customizing Your Layout for a full guide to reorganizing your dashboard.

Selecting New Dashboard from the New screen opens an empty dashboard window. You can name this new dashboard by right-clicking on the new name (which defaults to "Untitled").

img

To add new content to this dashboard, click on the Panels button.

Exporting Dashboards

Dashboards can be exported to an archive file, which can then be imported into another Deephaven instance. To export a dashboard, select the dashboards you wish to export from the New screen, then click the Export Selected Dashboards button.

img

You can also choose whether to include the queries that are associated with the selected Dashboards:

img

Importing Dashboards

Click the Import Dashboards button on the New screen and select a dashboard archive to import dashboards.

img

From the Import prompt that appears, you can:

  • Select/deselect which dashboards to import from the archive.
  • Select/deselect which queries to import from the archive.
  • Modify settings for any query that is being imported.
  • Select whether to create new item IDs or preserve the item IDs of imported items. Item IDs are unique identifiers for queries and dashboards; specifically, the item ID of a query is the query serial number, and the item ID of a dashboard is the ID for the dashboard stored in workspace data. The following options are available:
    • New: Create new item IDs for all imported queries and dashboards.
    • Keep: Preserve item IDs for all imported queries and dashboards, and throw an error if they already exist.
    • Replace: Preserve item IDs for all imported queries and dashboards, replace any existing items, and throw an error if they do not already exist.
  • Disable queries that are being imported.
  • Preserve the original owner of the items in the archive file, or change the owner to the current user.

img

Click Import to add the dashboards and queries to Deephaven.