featureToggles

OptionalSelf-hosted Query Engine In-browser Custom

Vizzly "feature toggles" allow you to control the user's experience of the dashboard. This enables you to tailor the Vizzly experience to your users. For example using feature toggles you could provide a completely static dashboard, or one without the component library and only allow users to create "standalone" components directly on the dashboard.

Usage

Feature toggles are provided through the featureToggles property. For example;

<Vizzly.Dashboard
  featureToggles={{
    showGlobalFilters: true,
    canEditComponentLibrary: false,
    canEditComponentsOnDashboard: true,
    // ...
  }}
/>

The toggles

Dashboard and library usage

Using feature toggles, we can control the features made available on the dashboard.

`canEditComponentLibrary`

Can the user edit views that exist in the library?

`canEditComponentsOnDashboard`

Can the user edit views on the dashboard itself?

`canUseComponentLibrary`

Can users open and add views from their library to the dashboard?

`canCreateStandaloneComponents`

Can the user create views directly on the dashboard?

`canRemoveComponentsFromDashboard`

Can users remove views from the dashboard?

`disableAutoSave`

Do you want to disable the auto-save feature, and build in your own "save" button.

`canAddNewRows`

Can the user add new rows to the dashboard?

`canAddNewCells`

Can the user add new cells to each row of the dashboard?

`showSavingIndicator`

When the dashboard is saving show a loading indicator. Defaulted to false.

`parameters`

Show or hide the ability to add parameters to a view on the dashboard.

`forceMobile`

The forceMobile feature toggle enables a mobile-friendly view of the Dashboard component. This toggle is useful when you want to enforce a mobile layout regardless of the device's screen size or resolution.

How to Use

To activate the forceMobile feature, import VizzlyState for your specific dashboard instance. You can also customize the breakpoint where the mobile view is applied.

Example

import Vizzly, { VizzlyState } from '@vizzly/dashboard';
 
VizzlyState.set('identifier-123', {
  featureToggles: {
    forceMobile: true,
  },
});

Global filters

`showGlobalFilters`

Do you wish to hide the global filters from the dashboard completely?

`disablePersistingGlobalFiltersLocally`

This allows the user to store the selection of a global filter in their browser's local storage. It is only available for read users.

simpleMultiSelectFilter

This will allow a simple multi-select dropdown filter to be used in the dashboard. By default it is set to false.

Dashboard Reset

By default the feature is enabled. The feature toggle showResetButton allows users with 'read_write' access to either show or hide the 'Reset Dashboard' button on their dashboard. When enabled, this feature lets users reset their individual dashboard to match your current Parent Dashboard settings.

Editing the views

`canConfigureLocalFilters`

Allow your users to configure local filters for each view on the dashboard.

`canEditCustomMetrics`

Allow your users to edit the custom metrics made available on the dashboard

`allowSimpleMathsCustomField`

Allow your users to use the maths custom field editor.

`allowPercentagesCustomField`

Allow your users to use the percentages custom field editor.

`allowRulesCustomField`

Allow your users to use the custom rule grouping field editor.

Data exports

`canDownloadComponentData`

Allow the download option to be shown for each component of the dashboard.

`canDownloadPDF`

Allow downloading the dashboard as a PDF.

`canDownloadViewData`

Allow downloading the data used directly for the chart, table or map.

`canDownloadViewAsPNG`

Allow downloading each view as a PNG.

`canDownloadDataSet`

Allow downloading of data sets powering each view.

Performance

`unloadOffScreenViews`

By default, Vizzly automatically loads views as you scroll down the dashboard. Once a view appears, it will remain and be refreshed by dashboard filters as needed.

It might be more advantageous for your dashboard to unload views as the user scrolls through the dashboard. This means when a dashboard filter is changed, only the views currently visible will be reloaded and the remaining will refresh as the user scrolls down the page.