Kineviz Dashboards

Dashboard opens the panel to create, present, and manage one or more live Kineviz dashboards that summarize the graph on the project canvas.

01 04 13 DashboardPanel
Kineviz Dashboard is in beta release. Features and behavior may change as the feature evolves.

Create a New Dashboard

You can create a new dashboard at any time, either from a blank dashboard or a demo template. Once created, you’ll need to add and configure the monitoring widgets you want, either manually or using the embedded AI agent.

To create a new dashboard:

  1. Click the dashboard Library icon.

    13 01 01 LibraryIcon

  2. In the dashboard library, click New.

    13 01 02 LibraryNewPanel

  3. Enter a title for the dashboard.

  4. Optionally, click Icon and choose an icon to be displayed on the dashboard’s library tile.

  5. Under Start From choose either Blank to open a blank dashboard, or Demo template to create a new dashboard that includes often-used widgets.

  6. Click Create (or Cancel).

    The dashboard opens in manual Edit mode.

    13 01 03 NewDashboardEdit

    • A Blank dashboard includes a single Selected widget that displays the number of nodes currently selected on the graph.

    • A Demo dashboard includes several often-used widgets.

Configure a Dashboard

To configure the widgets on any dashboard, you can use either manual Edit mode or AI mode with its embedded AI agent.

Configure a Dashboard in Edit Mode

To configure a dashboard manually:

  1. In an open dashboard, click the pencil icon to open Edit mode.

    13 01 04 EditPencil
    A New dashboard opens automatically in manual Edit mode.

  2. In the Edit pane at the bottom of the dashboard panel, set the canvas data that every widget will read.

    13 01 05 EditMode

    The options are: * Follow the live canvas, to present whatever is on the canvas. * Pin to a saved view, to read that view’s saved snapshot.

  3. Click to pick a widget from existing named widgets, or click the + icon at the top of the dashboard panel to add a new widget.

    The widget is highlighted on the dashboard, and its configuration details appear in the Edit pane.

    Once one widget is highlighted, a settings icon is displayed on its tile, and on all the other widgets in the dashboard. You can click another widget’s settings icon to switch to editing it.

  4. Enter details such as data source, queries and parameters, and widget size.

    To delete a widget, open the dashboard in edit mode and click the X at the top right of the widget.

  5. Click the checkmark icon at the top of the dashboard panel to save the widget configuration and exit edit mode.

Configure a Dashboard in AI mode

To configure a dashboard with the AI agent:

  1. In an open dashboard, click the AI icon at the top of the panel, or the AI tab in the edit pane at the bottom.

    13 01 06 DashboardAIEdit

  2. In the Describe a change textbox, enter a description of what you want, or click one of the starter options.

    The dashboard is changed in place — you can review, locate, and undo changes.

  3. Click the checkmark at the top of the dashboard panel to save the changes and exit AI edit mode.

Display a Dashboard

A dashboard can be opened for display within the Dashboard panel, and presented as a full-screen report or live presentation which can be exported for external use.

  • Click the _Library _ icon to open the dashboard library, then click a dashboard’s tile to open it.

    13 01 07 DashboardLibrary

Open a Full-screen Presentation

To open a full-screen dashboard presentation:

  1. In an open dashboard click the three dots at the top right of the panel, and select Present.

    13 01 08 DashboardPresentMenu

    The full-screen presentation is opened directly in the project.

    13 01 09 DashboardPresentation
    To export a dashboard as a .json file, click the three dots at the top right of the panel, and select Export, or go to the Library, and click the Export icon in the dashboard tile.

  2. Click Exit to return to the Dashboard panel.

Open a Full-screen Report

To open a full-screen dashboard report:

  1. In an open dashboard, click the Report icon the top right of the panel.

    13 01 10 DashboardReportIcon

    A formatted, date-stamped report is opened directly in the project.

    + image::/v3/13_01_11_DashboardReport.png[,320,180,role=text-left]

  2. Optionally, click Download HTML to download the report as an .html file you can include in external reports.

  3. Click Exit to return to the Dashboard panel.

Manage Dashboards

The dashboard Library displays all project dashboards as tiles.

13 01 12 DashboardLibrary

Use dashboard tiles to:

  • Review dashboard details: date created, number of widgets, and the filename for its exported .json file

  • Mark a dashboard as a Favorite by clicking the star icon on the tile.

  • Dock the dashboard to a specific edge of the browser window.

  • Export a dashboard.

  • Delete a dashboard.

In the Library you can also:

  • Create a New dashboard Import a dashboard saved as a .json file.

  • Search for a dashboard by its title.