Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana documentation Panels and visualizations Visualizations Text

Text

Text visualizations enable you to directly include text or HTML in your dashboards. This can be used to add contextual information and descriptions or embed complex HTML.

For example, if you want to display important links to your dashboard, you can use a text visualization to add these links:

Give it a try using Grafana Play

With Grafana Play, you can explore and see how it works, learning from practical examples to accelerate your development. This feature can be seen on Text Panel.

Try it

Use a text visualization when you need to:

• Add important links or useful annotations.
• Provide instructions or guidance on how to interpret different panels, configure settings, or take specific actions based on the displayed data.
• Announce any scheduled maintenance or downtime that might impact your dashboards.

Panel options

In the Panel options section of the panel editor pane, set basic options like panel title and description, as well as panel links. To learn more, refer to Configure panel options.

Text options

Use the following options to refine your text visualization.

Mode

Mode determines how embedded content appears.

Markdown

This option formats the content as markdown.

HTML

This setting renders the content as sanitized HTML. If you require more direct control over the output, you can set the disable_sanitize_html flag which enables you to directly enter HTML.

Code

This setting renders content inside a read-only code editor. Select an appropriate language to apply syntax highlighting to the embedded text.

Variables

Variables in the content will be expanded for display.