Adding Custom Charts to Dataset Reports
Dataset Reporting in Version 5.5 allows for custom configuration of Charts available to content builders. Metric Insights Admins can now extend the existing list of the default charts available, beyond Line/Bar/Area charts, Pie charts, Map charts, Bubble charts, Funnel charts and Range charts.
This article details how to add a Custom Chart to Metric Insights and make it available for use in Dataset Reporting for all content builders.
- For more information, refer to Creating Charts in Dataset Reporting
1. 1.Access via Admin > System > Charting Options
- Activate Template section
- [+New Chart Template]
2. Add a new Chart Template
On the "Add JavaScript Chart Template":
- Switch the Template to "enabled"
- Define the Name
- From the dropdown, select the required Charting Engine
- Specify the Width and Height
- Defaults are 900x600, modify if required
- Send as HTML: switch to "yes" to be able to control how your Chart is displayed in an email by your email program (NOTE: this requires writing an additional piece of HTML code)
- Save to proceed to Editor
3. Chart Template Editor > Info tab
Design your Chart by providing the code and adding custom properties in the corresponding sections.
On the Info tab, configure the following:
-
JavaScript Code
- JavaScript Code is the only required code for the Chart Template
-
Custom Chart Properties
- Depending on your needs, add your own Charting Variables
- Click [+New Charting Variable] to customize your Chart with labels, colors or custom actions
-
Custom Chart Engine [optional]
- Send as HTML in emails: set to "yes" to see additional options
- Enter the HTML additional code to configure how your Chart will be displayed by your email program
-
CSS code [optional]
- For further control of the Chart formatting, input the CSS code in the corresponding tab
4. Chart Template Editor > Report Settings tab
To make your Chart accessible for Dataset Reporting, go to the Report Settings tab.
- Enable for Dataset Reports: must be switched to "yes" if you plan to use this Chart Template when building Dataset Reports
-
Use Legacy Data Format: defaults to "yes", switch to "no" if necessary
- Legacy Data Format requires less space and allows faster data transfer (NOTE: this format has to be additionally converted for use by applying a special function)
- When Legacy Data Format is turned off, you will be using the new Data Format that does not need to be converted and is ready for use (NOTE: data in this format requires more storage space and is transferred more slowly)
- Click [Select Icon] to open a pop-up with options
- Description: Add a description of how this chart should be used. This is helpful for content builders who are not familiar with the chart type and might need some guidance.
- Save your inputs
5. Your Chart Template is ready for use
- After a Custom Chart has been added, it will appear as a new option in the Charts section
- Use the Chart Editor to configure your Chart
- For details, click Creating Charts in Dataset Reporting