This is documentation for the next version of Grafana documentation. For the latest stable release, go to the latest version.

Documentation Grafana documentation Visualize data Panels and visualizations Visualizations Text

Text

Text visualizations let you include text, HTML, code blocks, or Mermaid diagrams in your dashboards. You can use them to add contextual information and descriptions or to embed complex HTML. With text visualizations, you can build things like lightweight data-driven tables, cards, lists, and status summaries.

The following images show different uses of the text visualization.

Here, text visualizations use Markdown and HTML modes:

In this example, one text visualization is in TypeScript mode and the other is using Handlebars templating:

Finally, this image shows one text visualization using per row render mode and another using pagination:

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.

Text visualization editor

The editor is where you enter and preview the content of a text visualization. It’s where you set text modes, like Markdown, HTML, or a specific coding language. Additionally, it provides formatting options and syntax highlighting, as well as variable and diagram support.

To learn more, click the following links:

• Editor views
• Formatting toolbar
• Modes

Views

The editor provides three views:

• Preview: See only the preview block.
• Split: See the authoring and preview blocks at the same time.
• Write: See only the authoring block.

Toolbar

The toolbar provides formatting options for common Markdown and HTML operations, like bold or italic text and lists. You can also insert:

• Tables
• Mermaid diagrams
• Dashboard variables

Dashboard variables autocomplete as you enter them, and they’re interpolated in the content.

The options displayed in the formatting toolbar depend on whether you select Markdown or HTML.

Modes

The visualization mode determines how embedded content appears. Choose from:

• Markdown: Formats the content as Markdown.
• HTML: 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: Renders content inside a read-only code editor. Variables in the content are expanded for display. The code options are: Go, HTML, JSON, Markdown, Plain text, SQL, TypeScript, XML, YAML.

The editor provides syntax highlighting in the authoring block.

Render query results as text with Handlebars templates

Use ${__value}, ${__field}, ${__series}, and ${__data} macros to reference query results in the visualization content, and Handlebars templating for more control. Choose what data to display, repeat content for each row with {{#each}}, and add if/then logic with {{#if}} helpers.

Configuration options

Panel options

Data options

Use the following options to control how data is rendered in the text visualization.

Render mode

Select a render mode to control how your template is applied:

• Once: Render the whole result.
• Per row: Each row in the data gets its own repeated block of content.

You can also select which data frame to display.

Page size

When a query returns many rows, pagination lets you move through the full result instead of showing only a limited number of rows. Grafana automatically adjusts the number of rows on each page to fit the panel or you can set a range from 1-1000 rows.

This option only displays when you set Render mode to Per row and when there are 100 rows or more.

Value mappings

Thresholds

Field overrides