Analytic Suite

The Analytic Suite widget enables users to display the distinct data analysis views available within the Analyze functionality of Qrvey Composer. This includes Summaries, Tables, Metric Views, etc.

Embeddable Script

<!-- Tag -->
<an-dashboard config="anSuiteConfig"></an-dashboard>

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

<!-- Launcher -->
<script type="module" src="https://<WIDGETS_URL>/qrvey-an-widgets/an-dashboard/andashboard/andashboard.esm.js"></script>
<script nomodule src="https://<WIDGETS_URL>/qrvey-an-widgets/an-dashboard/andashboard/andashboard.js"></script>

Configuration Object

Property	Value	Required
apiKey	String, Your organization’s unique API key required to access the Qrvey platform.	Required, if qvToken is not provided.
qvToken	String, Encrypted token used for secure authentication.	Required, if apiKey is not provided.
appId	String, ID of the Qrvey application that contains the asset you want to embed.	Required
domain	String, The base URL of your instance of the Qrvey platform.	Required
userId	String, ID of the Qrvey User that owns the application being embedded.	Required
qrveyId	String, ID of the dataset being used.	Required
clientId	String, A unique identifier of the tenant end user working with the Analytic Suite. Enables use of the End User Personalization and Download Manager features.	Optional
timezone	Object, Overrides the time zone setting in Qrvey Admin Center. For more information, see Configuring Time Zone Settings.	Optional
customTokens	Object, Enables you to add custom tooltips onto metric panels. For details, please see Custom Tokens. Example { "my_header": "A Cool Tooltip Header!"}	Optional
authenticatedSession.email	String, Specifies the email address to send scheduled exports. If an address is not specified, exports are sent to the email address associated with the user ID.	Optional
settings	Object, General configuration in order to set certain behaviors. For details, please see The Settings Object below.	Optional
userFilters	Object, A filters object generated by the user. For more details, please see User Filters.	Optional
themeId	String, Theme ID to use in the component. For more details, please see Accessing a Theme Programmatically.	Optional

Settings

Property	Value	Required
view	String, Determines the initial view to display. Accepts: SUMMARY_VIEW/MULTI_PANEL TABULAR_VIEW CUSTOM_VIEW METRIC_VIEW Default: MULTI_PANEL (which is an alias for SUMMARY_VIEW)	Optional
mode	String, Determines displaying the complete layout or the views only. It depends on set view. Accepts: COMPLETE SIMPLE Default: COMPLETE	Optional
displayMode	String, Changes the style and extends the layout onto the entire container. FULL NORMAL Default: NORMAL	Optional
styles	Object, Styles options object. These properties will extend from the current theme.	Optional
styles.chartsTitle	String, Sets the charts' title.	Optional
styles.chartsFontFamily	String, Sets the chart's font family.	Optional
styles.axisDataLabels	String, Sets axis labels color in charts.	Optional
styles.dataLabels	String, Sets a hex color for data labels in charts.	Optional
styles.valuesMain	String, Sets a hex color for axis ticks values in charts.	Optional
styles.chartsLegends	String, Sets a hex color for charts legends labels.	Optional
styles.chartsTooltips	String, Sets a hex color for charts tooltips.	Optional
styles.tableHeaderFont	String, Sets a hex color for table header texts.	Optional
styles.chartsMain	String, Sets a hex color for chart data points like bars, symbols and lines.	Optional
styles.themePalette	Array, Sets up to 20 hex colors that will be used for chart data points.	Optional