Annotations are short text notices that can be added to charts in order to better interpret KPIs and inform end users when something noticeable has impacted the data. You can use Annotations to indicate when you launched a new marketing campaign, when a newsletter was sent out, or when seasonal events (like special sales) may have occurred.
By adding Annotations directly to a Chart, you're drawing a direct correlation between the work you're doing and the results you're seeing in the data.
IN THIS ARTICLE
- Which visualizations support Annotations?
- How to add an Annotation
- How to edit an Annotation
- How to delete an Annotation
- Additional Information
Which visualizations support Annotations?
Annotations are linked to a Data Source, Metric, and specific point in time, so only visualizations that report with granularity support this functionality. Visualizations that support Annotations are Bar Charts, Line Charts, Combo Charts, and Heat Maps.
Annotations will be visible on all other supported Charts that have the same Data Source, Metric, and Date Range selected. Learn more about visualization types available in Databox here.
How to add an Annotation
- Open the Databoard where you want to add an Annotation in the Designer. This Databoard must have a supported visualization on it in order to add an Annotation
- Hover over the place on the X-axis of the Line Chart, Bar Chart or Heat Map where you want to add your Annotation. Click the icon on the X-axis to add Annotation.
- Select the Date and Time for your Annotation.
- Type the description of your Annotation directly into the text box. You can add a URL in the description. It will become a clickable link when the annotation is saved
- By default, View on the specific metric only is left unchecked, and the Annotation will be globally applied to this date/ time for all charts in the account. Select this checkbox if you only want the Annotation visible for the one specific metric.
Click View on the specific metric only checkbox if you want this Annotation to show on this specific metric only. - Click the green Save icon to save the Annotation. This Annotation is now linked to this Data Source, Metric, and point in time.
Once saved, the hyperlink will become clickable. The Annotation will be visible in the Databox app and the Streaming URL by hovering over the icon on the X-axis on the Line or Bar Chart. It will also be visible anywhere the live Databoard is embedded using the HTML code.
How to edit an Annotation
- Open the Databoard where you want to edit an Annotation in the Designer
- Hover over the X-axis on the Line Chart, Bar Chart, or Heat Map where the Annotation is located. Click on the Annotation Icon.
- Click on the Edit text at the top right of the existing Annotation.
- Edit your Annotation directly in the text box
- Click the green Save icon to save the updated Annotation. This Annotation is now linked to the Data Source, Metric, and point in time.
How to delete an Annotation
- Open the Databoard where you want to delete an Annotation in the Designer
- Hover over the X-axis on the Line Chart, Bar Chart, or Heat Map where the Annotation is located. Click on the Annotation Icon.
- Click on the red trash icon at the top right of the existing Annotation.
Additional Information
IN THIS SECTION
Who can view Annotations?
In the Databox app, any user that has the permissions to view a Databoard can view any Annotations on the Databoard as well. Users that have the permission to edit a Databoard can also edit any Annotations on the Databoard.
Outside the Databox app, Annotations are visible on the Streaming URL and anywhere the live Databoard is embedded using the HTML code. Anyone that has access to the Streaming URL or embedded Databoard(s) will be able to view any Annotations added to the Databoard(s).
Will I see Annotations if I change the Granularity setting on the Chart?
When you add an Annotation to a chart that displays data with daily granularity, the Annotation is saved on that day at 00:00. Therefore, if you change the granularity setting to hourly, the Annotation will be visible at the beginning of the day. If you change the granularity setting to monthly, the Annotation will no longer be visible.