Properties
Core properties
identity
An async callback function to collect the JSON Web Tokens (JWTs) used for Vizzly's data and dashboard access.
queryEngineEndpoint
Points the dashboard towards your Query Engine. This value is
dataSets
Define the data sets to make available on your dashboard for in-browser projects.
data
An async function used to collect the data for each data set using in-browser projects.
runQueries
Execute vizzly queries against your own query engine using a custom project.
queryEngineConfig
Define the capabilities of your own custom query engine for custom projects.
Multiple dashboards
parentDashboardId
Provide the ID of the parent dashboard to display. Learn about parent and child dashboards here.
dashboardId
Provide the ID of child or parent dashboard to display. Learn about parent and child dashboards here.
Customization
theme
Customize the styling of the dashboard.
featureToggles
Enable and disable features of the dashboard for your users. For example, only allow users to build their own dashboard from a library of charts instead of building their own from scratch.
textOverrides
Override text throughout the dashboard. Enables internationalization.
Icons
Override icons on the dashboard
Component overrides
Override components of the dashboard as drop-downs, date-time pickers and loading animations.
labelFormat
Programmatically control the format of labels across all views on your dashboard.
dataPanel
Override sections of the data panel within the Vizzly editor.
formatPanel
Override sections of the format panel within the Vizzly editor.
excludeComponents
Remove charts, tables and maps from those available on the dashboard
includeComponents
Allowlist of charts, tables and maps to make available on the dashboard
developerTools
Enable developer tools to help development of;
- Custom themes
- Component overrides
- Programmatic dashboard building.
maxCSVDownloadLimit
Set the maximum number of records that can be downloaded in a CSV export.
numberFormatOptions
Provide custom formatting options for numbers.
dateTimeFormatOptions
Provide custom formatting options for dates.
organizationName
Set your organization's name to be referenced on the dashboard.
Event handlers
onEditorUpdate
When Vizzly autogenerates a view in the editor, you may wish to make changes to the view before it is rendered. For example, you might wish to add a filter to the view, or set certain style properties.
onDashboardLoad
Be notified when the dashboard renders.
onViewClick
Detect click events to trigger a follow-on custom action.
onDashboardFilterChange
Be notified when there is a change to the dashboard level filters.
trackEvent
Track user events on the dashboard, such as when a user adds a new view to their dashboard.
Filters
dateFilterOptions
Provide custom filter options for dates
dashboardFilters
Provide programmatically defined, dashboard level filters.
cascadeFilterSelection
Require the value selected in one filter to impact the options available in other filters to avoid conflicting filters.
Programmatic
parentDashboard
Build your parent dashboard in code.
Scheduled reporting
reportScheduleOptions
Provide options for your users to setup scheduled reports.