diff --git a/docs/sources/panels-visualizations/visualizations/annotations/index.md b/docs/sources/panels-visualizations/visualizations/annotations/index.md index 673636227ae..d69ea3d95de 100644 --- a/docs/sources/panels-visualizations/visualizations/annotations/index.md +++ b/docs/sources/panels-visualizations/visualizations/annotations/index.md @@ -22,69 +22,71 @@ weight: 100 The annotations list shows a list of available annotations you can use to view annotated data. Various options are available to filter the list based on tags and on the current dashboard. -## Panel options +{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-annotations-list-viz-v12.0.png" max-width="750px" alt="The annotations list visualization" >}} -{{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version="" >}} - -## Annotation query - -The following options control the source query for the list of annotations. - -### Query Filter +## Configuration options -Use the query filter to create a list of annotations from all dashboards in your organization or the current dashboard in which this panel is located. It has the following options: +{{< docs/shared lookup="visualizations/config-options-intro.md" source="grafana" version="" >}} -- All dashboards - List annotations from all dashboards in the current organization. -- This dashboard - Limit the list to the annotations on the current dashboard. +### Panel options -### Time Range - -Use the time range option to specify whether the list should be limited to the current time range. It has the following options: - -- None - no time range limit for the annotations query. -- This dashboard - Limit the list to the time range of the dashboard where the annotations list is available. +{{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version="" >}} -### Tags +### Annotation query options -Use the tags option to filter the annotations by tags. You can add multiple tags in order to refine the list. +The following options control the source query for the list of annotations: -{{% admonition type="note" %}} -Optionally, leave the tag list empty and filter on the fly by selecting tags that are listed as part of the results on the panel itself. -{{% /admonition %}} + -### Limit +| Option | Description | +| ---------- | --------------------------------------------------------------------------------------------------------- | +| [Query filter](#query-filter) | Specify which annotations are included in the list. | +| [Time Range](#time-range) | Specify whether the list should be limited to the current time range. | +| Tags | Filter the annotations by tags. You can add multiple tags to refine the list. Optionally, leave the tag list empty and filter in view mode by selecting tags that are listed as part of the results on the panel itself. | +| Limit | Limit the number of results returned. | -Use the limit option to limit the number of results returned. + -## Display +#### Query filter -These options control additional meta-data included in the annotations list display. +Use the **Query filter** option to create a list of annotations from all dashboards in your organization or the current dashboard in which this panel is located. +Choose from: -### Show user +- **All dashboards** - List annotations from all dashboards in the current organization. +- **This dashboard** - Limit the list to the annotations on the current dashboard. -Use this option to show or hide which user created the annotation. +#### Time Range -### Show time +Specify whether the list should be limited to the current time range. +Choose from: -Use this option to show or hide the time the annotation creation time. +- **None** - No time range limit for the annotations query. +- **This dashboard** - Limit the list to the time range of the dashboard where the annotations list is available. -### Show Tags +### Display options -Use this option to show or hide the tags associated with an annotation. _NB_: You can use the tags to live-filter the annotations list on the visualization itself. +These options control additional metadata included in the annotations list display: -## Link behavior + -### Link target +| Option | Description | +| ---------- | --------------------------------------------------------------------------------------------------------- | +| Show user | Show or hide which user created the annotation. | +| Show time | Show or hide the time the annotation creation time. | +| Show tags | Show or hide the tags associated with an annotation. Note that you can use the tags to filter the annotations list. | -Use this option to chose how to view the annotated data. It has the following options. + -- Panel - This option will take you directly to a full-screen view of the panel with the corresponding annotation -- Dashboard - This option will focus the annotation in the context of a complete dashboard +### Link behavior options -### Time before +Use the following options to control the behavior of annotation links in the list: -Use this option to set the time range before the annotation. Use duration string values like "1h" = 1 hour, "10m" = 10 minutes, etc. + -### Time after +| Option | Description | +| ---------- | --------------------------------------------------------------------------------------------------------- | +| Link target | Set how to view the annotated data. Choose from:
  • **Panel** - The link takes you directly to a full-screen view of the panel with the corresponding annotation.
  • **Dashboard** - Focuses the annotation in the context of a complete dashboard.
| +| Time before | Set the time range before the annotation. Use duration string values like `1h` for one hour and `10m` for 10 minutes. | +| Time after | Set the time range after the annotation. | -Use this option to set the time range after the annotation. +