developerTools

To set the dashboard into developer mode, you can use the developerTools property. This will allow you to see the components of the dashboard that you can override, and discover the text that you can alter.

For example on a Ract implementation you will set;

 
<Vizzly.Dashboard
  developerTools={{theme: true, }}
  // more props...
/>

{theme: true}

This will show you the path within the theme object that you provide via the theme property.

{componentOverride: true}

This will show you the name of the property of the Dashboard, that you can specify to override a component on the Dashboard. For more information, see the component override documentation.

{viewRawResults: true}

This will add an option in the dropdown menu for each view on the dashboard, to show the underlying results for the view.

{viewRawAttributes: true}

This will add an option in the dropdown menu for each view on the dashboard, to show the raw attributes for a view on the dashboard.

Runtime usage

setRuntimeDeveloperTools

All developer tools can be enabled at runtime using the VizzlyDev window variable.

Enabling developer tools

window.VizzlyDev.setRuntimeDeveloperTools({
  // componentOverride: true,
  // theme: true,
  // viewRawAttributes: true,
  // viewRawResults: true,
})

Viewing the current developer tool overrides

window.VizzlyDev.getRuntimeDeveloperTools()

Clearing the runtime developer tools

window.VizzlyDev.clearRuntimeDeveloperTools()

Dashboard Summary

To find details about the current dashboard(s) being shown on the page, run VizzlyDev.dashboardSummary() in the browser console.

You will see a list of dashboards, as multiple dashboards could be rendered on the page at the same time. For each dashboard, you will see;

projectId

The Vizzly project ID.

dashboardId

ID of the currently shown dashboard.

parentDashboardId

The parent dashboard ID of the currently shown dashboard. Learn more about parent & child dashboards here

userReference

The user reference set in the identity config.

setServerLogLevel

To more simply allow Vizzly Query Engine logs to be written, you can toggle this from the dashboard developer tools.

For example, in the browser console where your dashboard has rendered, you can run;

window.VizzlyDev.setServerLogLevel('debug');

which will set the Vizzly Query Engine into 'debug' log level for each request sent to it from the dashboard.

The has the same effect as setting the LOG_LEVEL environment variable to debug.

Clear

To clear the server log level, you can run;

window.VizzlyDev.resetServerLogLevel();

Note, that this only stops your requests from the dashboard asking to alter the log level, it won't change the last set log level of the Query Engine.