Properties

Properties

The Editor component shares the majority of it's properties with the Dashboard. view property is the primary way of passing your Component configuration into the Editor

Core properties

identity

An async callback function to collect the JSON Web Tokens (JWTs) used for Vizzly's data and dashboard access.

Learn more (in Dashboard Properties)

queryEngineEndpoint

Points the dashboard towards your Query Engine. This value is

Learn more (in Dashboard Properties)

dataSets

RequiredIn-browser

Define the data sets to make available on your dashboard for in-browser projects.

Learn more (in Dashboard Properties)

data

RequiredIn-browser

An async function used to collect the data for each data set using in-browser projects.

Learn more (in Dashboard Properties)

runQueries

RequiredCustom

Execute vizzly queries against your own query engine using a custom project.

Learn more (in Dashboard Properties)

queryEngineConfig

RequiredCustom

Define the capabilities of your own custom query engine for custom projects.

Learn more (in Dashboard Properties)

view

Define the view that will be shown in the Editor.

Learn more

Programmatic

view

Optional

Build your view in code.

Learn more

Customization

theme

Optional

Customize the styling of the dashboard.

Learn more (in Dashboard Properties)

featureToggles

Optional

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.

Learn more (in Dashboard Properties)

textOverrides

Optional

Override text throughout the dashboard. Enables internationalization.

Learn more (in Dashboard Properties)

Icons

Optional

Override icons on the dashboard

Learn more (in Dashboard Properties)

Component overrides

Optional

Override components of the dashboard as drop-downs, date-time pickers and loading animations.

Learn more (in Dashboard Properties)

labelFormat

Optional

Programmatically control the format of labels across all views on your dashboard.

Learn more (in Dashboard Properties)

dataPanel

Optional

Override sections of the data panel within the Vizzly editor.

Learn more (in Dashboard Properties)

formatPanel

Optional

Override sections of the format panel within the Vizzly editor.

Learn more (in Dashboard Properties)

excludeComponents

Optional

Remove charts, tables and maps from those available on the dashboard

Learn more (in Dashboard Properties)

includeComponents

Optional

Allowlist of charts, tables and maps to make available on the dashboard

Learn more (in Dashboard Properties)

developerTools

Optional

Enable developer tools to help development of;

  • Custom themes
  • Component overrides
  • Programmatic dashboard building.

Learn more (in Dashboard Properties)

maxCSVDownloadLimit

Optional

Set the maximum number of records that can be downloaded in a CSV export.

Learn more (in Dashboard Properties)

numberFormatOptions

Optional

Provide custom formatting options for numbers.

Learn more (in Dashboard Properties)

dateTimeFormatOptions

Optional

Provide custom formatting options for dates.

Learn more (in Dashboard Properties)

organizationName

Optional

Set your organization's name to be referenced on the dashboard.

Learn more (in Dashboard Properties)

Event handlers

onEditorUpdate

Optional

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.

Learn more (in Dashboard Properties)

onDashboardLoad

Optional

Be notified when the dashboard renders.

Learn more (in Dashboard Properties)

onViewClick

Optional

Detect click events to trigger a follow-on custom action.

Learn more (in Dashboard Properties)

onDashboardFilterChange

Optional

Be notified when there is a change to the dashboard level filters.

Learn more (in Dashboard Properties)

trackEvent

Optional

Track user events on the dashboard, such as when a user adds a new view to their dashboard.

Learn more (in Dashboard Properties)

Filters

dateFilterOptions

Optional

Provide custom filter options for dates

Learn more (in Dashboard Properties)

dashboardFilters

Optional

Provide programmatically defined, dashboard level filters.

Learn more (in Dashboard Properties)

cascadeFilterSelection

Optional

Require the value selected in one filter to impact the options available in other filters to avoid conflicting filters.

Learn more (in Dashboard Properties)