Dashboard View (Legacy)

The Dashboard View widget enables you to embed one or more dashboards or a mashup of several charts, maps, and metrics into your application.

Embeddable Script

<!-- Tag -->
<qrvey-end-user settings="config"></qrvey-end-user>`

<!-- Config -->
<script>
var config = {
  apiKey: "<API_KEY>",
  domain: "<DOMAIN>",
  userId: "<USER_ID>",
  appId: "<APP_ID>"
};
</script>

<!-- Launcher -->
<script type="text/javascript" src="https://<WIDGETS_URL>/widgets-launcher/app.js"></script>

Configuration Object

Property	Value	Required	Description
apiKey	String	Yes, if qvToken is not provided.	Your organization’s unique API key required to access the Qrvey platform.
qvToken	String	Yes, if apiKey is not provided.	Encrypted token used for secure authentication.
appId	String	Yes	ID of the Qrvey application that contains the asset you want to embed.
domain	String	Yes	Base URL of your Qrvey instance.
userId	String	Yes, if userId is not included in a session cookie.	ID of the Qrvey User that owns the application being embedded. Optional: You can alternately specify the user ID in a Qrvey session cookie.
dashboardId	String	No	ID of a specific dashboard to open to. If omitted, the widget will open to "browse all dashboards".
groupList	Array<String>	No	Collection of IDs/names of the groups created in User Management.
pageId	String	No	ID of a page to visualize. If configured, all auth processes are still required.
clientid	String	No	Unique identifier for the tenant end user. Required for using the End User Personalization and Download Manager features.
themeId	String	No	Theme ID to use in the component. For more information, see Access a Theme Programmatically.
userFilters	Array<Object>	No	Collection of custom filters that the system will apply to the visualized data. For more information, see Working With Filters in Embedded Scenarios.
fitPanelButton	Boolean	No	When false, hides the "fit to panel" button on charts within the dashboard. Default value is true.
filterPanelDefaultView	String	No	Decides the default state of the side filter panel, if it’s been added to the view. It can be set to open or closed. The default value is closed.
authenticatedSession.email	String	No	Specifies the email address to associate with the widget. If an address is not specified, exports are sent to the email address associated with the user ID.
personalization	Object	No	Configures and/or overwrites the default personalization/customization settings. For more information, see The Personalization Object below.
customTokens	Object	No	Sets custom threshold values in Bullet and Dial charts. For more information, see Using Custom Tokens.
featurePermission	Object	No	Configures which features are available in the widget. For more details, see The Feature Permission Object.
subscriptionsSettings	Object	No	Configures subscription details in the widget. For details, see Subscriptions Settings Object.

Feature Permission

The following table describes the properties of the featurePermission object.

Property	Value	Required	Description
liteVersion	Boolean	No	If true, hides all elements that are managed by feature permissions. Defaults to false.
downloads	Object	No	Contains the download and export parameters.
downloads.hideGeneralDownload	Boolean	No	If true, hides the download feature from the dashboard tool bar. Defaults to false.
downloads.hideSchedule	Boolean	No	If true, hides the scheduling export option in the export modal. Defaults to false.
filters	Object	No	Contains the filters object parameters.
filters.global	Boolean	No	If true, hides creation points of global filters. Defaults to false.
filters.page	Boolean	No	If true, hides creation points of page filters. Defaults to false.
filters.tab	Boolean	No	If true, hides creation points of tab filters. Defaults to false.
filters.chart	Boolean	No	If true, hides creation points of chart filters. Defaults to false.
filters.filterPanel	Boolean	No	If true, hides the filter panel. Defaults to false.
panels	Object	No	Contains the panels object parameters.
panels.global	Object	No	Contains global panel settings.
panels.global.hide_all	Boolean	No	When true, hides the entire panel menu. Defaults to false.
panels.global.hide_edit_menu	Boolean	No	When true, hides the "edit chart" option. Defaults to false.
panels.global.hide_duplicate_menu	Boolean	No	When true, hides the "duplicate chart" option. Defaults to false.
panels.global.hide_downloads_menu	Boolean	No	When true, hides the "download" sub-menu option. Defaults to false.
panels.global.hide_delete_menu	Boolean	No	When true, hides the "delete chart" option. Defaults to false.
panels.global.hide_JPG	Boolean	No	When true, hides the "download JPG" option. Defaults to false.
panels.global.hide_PDF	Boolean	No	When true, hides the "PDF download" option. Defaults to false.
panels.global.hide_CSV	Boolean	No	When true, hides the "CSV download" option. Defaults to false.
panels.global.hide_CSV_summary	Boolean	No	When true, hides the "CSV summary" option. Defaults to false.
panels.metrics	Object	No	Contains metrics panel settings.
panels.metrics.hide_edit_menu	Boolean	No	When true, hides the "edit chart" option for metrics panels. Defaults to false.
panels.metrics.hide_duplicate_menu	Boolean	No	When true, hides the "duplicate chart" option for metrics panels. Defaults to false.
panels.metrics.hide_downloads_menu	Boolean	No	When true, hides the "download" sub-menu option for metrics panels. Defaults to false.
panels.metrics.hide_delete_menu	Boolean	No	When true, hides the "delete chart" option for metrics panels. Defaults to false.
panels.metrics.hide_JPG	Boolean	No	When true, hides the "download JPG" option for metrics panels. Defaults to false.
panels.metrics.hide_PDF	Boolean	No	When true, hides the "PDF download" option for metrics panels. Defaults to false.
panels.metrics.hide_CSV	Boolean	No	When true, hides the "CSV download" option for metrics panels. Defaults to false.
panels.metrics.hide_CSV_summary	Boolean	No	When true, hides the "CSV summary" option for metrics panels. Defaults to false.
panels.metrics.hide_EXCEL	Boolean	No	When true, hides the "EXCEL download" option for metrics panels. Defaults to false.
panels.summaries	Object	No	Contains summaries panel settings.
panels.summaries.hide_edit_menu	Boolean	No	When true, hides the "edit chart" option for summaries panels. Defaults to false.
panels.summaries.hide_duplicate_menu	Boolean	No	When true, hides the "duplicate chart" option for summaries panels. Defaults to false.
panels.summaries.hide_downloads_menu	Boolean	No	When true, hides the "download" sub-menu option for summaries panels. Defaults to false.
panels.summaries.hide_delete_menu	Boolean	No	When true, hides the "delete chart" option for summaries panels. Defaults to false.
panels.summaries.hide_JPG	Boolean	No	When true, hides the "download JPG" option for summaries panels. Defaults to false.
panels.summaries.hide_PDF	Boolean	No	When true, hides the "PDF download" option for summaries panels. Defaults to false.
panels.summaries.hide_CSV	Boolean	No	When true, hides the "CSV download" option for summaries panels. Defaults to false.
panels.summaries.hide_CSV_summary	Boolean	No	When true, hides the "CSV summary" option for summaries panels. Defaults to false.
panels.summaries.hide_EXCEL	Boolean	No	When true, hides the "EXCEL download" option for summaries panels. Defaults to false.
panels.charts	Object	No	Contains charts panel settings.
panels.charts.hide_edit_menu	Boolean	No	When true, hides the "edit chart" option for charts panels. Defaults to false.
panels.charts.hide_duplicate_menu	Boolean	No	When true, hides the "duplicate chart" option for charts panels. Defaults to false.
panels.charts.hide_downloads_menu	Boolean	No	When true, hides the "download" sub-menu option for charts panels. Defaults to false.
panels.charts.hide_delete_menu	Boolean	No	When true, hides the "delete chart" option for charts panels. Defaults to false.
panels.charts.hide_JPG	Boolean	No	When true, hides the "download JPG" option for charts panels. Defaults to false.
panels.charts.hide_PDF	Boolean	No	When true, hides the "PDF download" option for charts panels. Defaults to false.
panels.charts.hide_CSV	Boolean	No	When true, hides the "CSV download" option for charts panels. Defaults to false.
panels.charts.hide_CSV_summary	Boolean	No	When true, hides the "CSV summary" option for charts panels. Defaults to false.
panels.charts.hide_EXCEL	Boolean	No	When true, hides the "EXCEL download" option for charts panels. Defaults to false.

Tip: To hide all features, set the liteVersion property to true. For example:

const widgetConfig = {
   domain: "DOMAIN",
   appId: "APP_ID",
   userId: "USER_ID",
   featurePermission: {
     liteVersion: true,
   },
}

Tip: To hide most features, set the liteVersion property to true and list the exceptions you want to show to false. For example:

const widgetConfig = {
   domain: "DOMAIN",
   appId: "APP_ID",
   userId: "USER_ID",
   featurePermission: {
     liteVersion: true,
     userManagement:{
       hideUserManagementTab: false
     }
   },
}

Subscriptions Settings

In the Dashboard View widget, you can enable end users to subscribe to a scheduled delivery of exported dashboards or specific charts. For the Subscriptions feature to work, you must appropriately set the clientid property and pass it in when generating the qvToken. The property’s value should represent a unique identifier for each end user. For more information on using subscriptions, see Subscribing to Exports.

Property	Value	Required	Description
enable_subscriptions	Boolean	No	If false, disables the User Subscriptions alarm bell and subscriptions are not available to the end user within the widget. Defaults to true.
emails	Array	No	Email addresses to deliver the exports to. Example: [ "email@jmail.com", "email2@jmail.com"]
allow_editing_recipients	Boolean	No	Enables the end user to modify the list of recipients of the export.
email_message	Object	No	JSON object to configure the email message.
email_message.hide_add_subject	Boolean	No	Toggles visibility of the email's subject field.
email_message.hide_add_message	Boolean	No	Toggles visibility of the message field.

Personalization

Configures end-user personalization. In the Dashboard View widget, all authenticated users can personalize their view by default. You can use the personalization object to configure and override the personalization settings. End User Personalization feature relies on the user being authenticated and needs the clientid property set for the logged-in user.

To turn personalization off for all users, set the enabled property to false. For example:

const widgetConfig = {
   domain: "DOMAIN",
   appId: "APP_ID",
   userId: "USER_ID",
   personalization: {
     enabled: false,
   },
}

The following table describes the properties of the personalization object.

Property	Value	Required	Description
enabled	Boolean	No	If false, disables personalization for end users and all of the properties in the personalization object. Defaults to true.
add_filter	Boolean	No	If false, hides the “add filter” buttons and disables users from creating new filters from the filter modal, the filter panel, and filter interactivity page components. Defaults to true.
edit_chart	Boolean	No	if false, disables authenticated users from editing charts. Defaults to true.
download_data	Boolean	No	If false, disables the download page and panel data in CSV and PDF formats. Defaults to true.
edit_page	Boolean	No	If false, disables edit mode for the dashboard widget will be displayed and hides the “edit page” button in the floating three-dot menu. Defaults to true.
remove_chart	Boolean	No	If false, users cannot remove charts from the page, when in edit mode. Defaults to true.
rearrange_chart	Boolean	No	If false, users cannot rearrange the chart panels, when in edit mode. Defaults to true.
autoSaveFilters	Boolean	No	If false, this parameter disables the auto-saving of filters and enables the "Save" button, allowing users to manually save filters when applied. Additionally, setting autoSaveFilters to false removes the ability to restore filters through the filter panel. Defaults to true.
skipRestoreOriginalModal	Boolean	No	If true, this parameter disables the confirmation modal that appears during the "restore original" action. Defaults to false.

Events

The widget supports custom events to update keys of the configuration, you can dispatch an event using your own user interface to modify the behavior.

• atApplyUserFilters()

  • Purpose: Enables changes to the userFilters property.

  • Example:

    window.dispatchEvent(new CustomEvent('atApplyUserFilters', {detail: userFilters}));

• qvDSHRestoreDashboard()

  • Purpose: Restores a dashboard to a specified version: ORIGINAL or PERSONALIZED, which must be included in the event's detail field.

  • Scope: Dashboard view.

  • Details: Logs [qvDSHRestoreDashboard]: Unable to restore to the provided version if:

    • No version is specified.
    • An invalid version is provided.
    • clientid is missing in the authentication token.
    • No personalization exists for the dashboard.
    • Personalization is disabled in the configuration.
    • The same version is already active.

  • Example:

    window.dispatchEvent(new CustomEvent('qvDSHRestoreDashboard', { detail: { version: 'PERSONALIZED' } }));
    window.dispatchEvent(new CustomEvent('qvDSHRestoreDashboard', { detail: { version: 'ORIGINAL' } }));

• qvDSHSaveDashboard()

  • Purpose: Saves modifications to create a personalized version for the clientid specified in the widget configuration.

  • Scope: Dashboard view and edit mode.

  • Details: Logs [qvDSHSaveDashboard]: Unable to save changes. if:

    • No changes are detected.
    • Personalization is disabled in the configuration.
    • clientid is missing in the authentication token.

  • Example:

    window.dispatchEvent(new CustomEvent('qvDSHSaveDashboard'));

• qvDSHEditDashboard()

  • Purpose: Opens the dashboard in edit mode.

  • Scope: Dashboard view.

  • Details: Logs [qvDSHEditDashboard]: Unable to edit dashboard. if:

    • Personalization is disabled in the configuration.
    • The dashboard is not in desktop view.
    • Dashboard editing is disabled.
    • clientid is missing in the authentication token.

  • Example:

    window.dispatchEvent(new CustomEvent('qvDSHEditDashboard'));

• qvDSHCloseEditDashboard()

  • Purpose: Exits edit mode in the dashboard.

  • Scope: Edit mode.

  • Example:

    window.dispatchEvent(new CustomEvent('qvDSHCloseEditDashboard'));

• qvDSHCreateNewSubscription()

  • Purpose: Opens the modal for creating a new subscription.

  • Scope: Dashboard view.

  • Details: Logs [qvDSHCreateNewSubscription]: Unable to create subscription. if:

    • The user is not authenticated.
    • The user is in interact mode.
    • Subscriptions are disabled.

  • Example:

    window.dispatchEvent(new CustomEvent('qvDSHCreateNewSubscription'));

• qvDSHManageSubscriptions()

  • Purpose: Opens the manage subscriptions modal.

  • Scope: Dashboard view.

  • Details: Logs [qvDSHManageSubscriptions]: Unable to manage subscriptions. if:

    • The user is not authenticated.
    • The user is in interact mode.
    • Subscriptions are disabled.

  • Example:

    window.dispatchEvent(new CustomEvent('qvDSHManageSubscriptions'));

• qvDSHDownloadDashboard()

  • Purpose: Downloads the dashboard in the specified format (CSV, EXCEL, PDF, or DATASET).

  • Scope: Dashboard view and edit mode.

  • Details: Logs [qvDSHDownloadDashboard]: Unable to download the provided format. if:

    • No format is specified.
    • An unsupported format is provided.
    • Downloads are disabled in the configuration or due to permission settings.
    • The dashboard is loading or a process is currently locking the screen.

  • Examples:

    window.dispatchEvent(new CustomEvent('qvDSHDownloadDashboard', { detail: { format: 'PDF' } }));
    window.dispatchEvent(new CustomEvent('qvDSHDownloadDashboard', { detail: { format: 'CSV' } }));
    window.dispatchEvent(new CustomEvent('qvDSHDownloadDashboard', { detail: { format: 'EXCEL' } }));
    window.dispatchEvent(new CustomEvent('qvDSHDownloadDashboard', { detail: { format: 'DATASET' } }));