Deleting a Dashboard

Initializing the Vizzly API

Ensure you have loaded the Vizzly package by following the prerequisite steps in our initializing guide. You will then be able to instantiate the Vizzly API using the following code

const api = new Vizzly.API(<< Identity function >>);

Note that << Identity function >> is your identity function itself, not the returned value from it. Feel free to reuse the same identity function that you use to render the Vizzly dashboard. For more information about the identity function, see the identity docs

To delete an existing dashboard, use the deleteDashboard method with the dashboard's Id.

Using the Method

// Updating the dashboard and processing the result
await api.deleteDashboard(<< DASHBOARD ID >>);

Parameters for deleteDashboard

  • dashboardId: The unique identifier for the dashboard you intend to update.

Here's the TypeScript type definition:

deleteDashboard(dashboardId: string)