DocumentationChaosSearch Blog
StatusHome Page

Create an Annotation

Annotations add meaningful messages to charts to help with the user interpretation of the data

Suggest Edits

An annotation layer is a named set of different annotations for charts. One layer can be used as a container for different annotations. This topic describes how to create annotation layers and annotations.

Add an Annotation Layer

To create an annotation layer:

  1. Go to SQL Analytics > Settings > Annotation Layers to open the Annotation layers window.

  2. Click + Annotation Layer. The Add annotation layer window appears.

  1. Type a name for the layer.
  2. Optionally, type a description for the layer.
  3. Click Add.

Add an Annotation

You can define annotations in an existing annotation layer.

To add an annotation:

  1. On the Annotation layers page, select the annotation layer in which you want to add an annotation. The detailed page for the layer appears.

  2. Create a new annotation by clicking + Annotation. The Add annotation window appears.

  1. Type a unique name for the annotation.

  2. Use the calendar selector to specify a date range with a start and end date (year, day, time) combination for the annotation.

📘

Events and Intervals

In Superset, there is a concept of an event annotation and an interval annotation. Events and intervals are essentially the same definition, but the start and and day value for an event is the same day (for example, June 1 to June 1. For an interval the days are different, June 1 to June 2.

  1. Type a description for the annotation if desired.

  2. Type JSON metadata for the annotation if desired.

  3. Click Add. The annotation is added to the layer.

Updated 6 months ago