apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
54500 Commits
2179 Branches
608 Tags
1.9 GiB
 
 
 
 
 
 
Tag: Branch: Tree: 24d67b0e1e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '24d67b0e1e'
${ noResults }
grafana/docs/sources/panels-visualizations/visualizations/text/index.md

3.4 KiB
Raw Blame History

aliases keywords labels description title weight refs
[../../features/panels/text/ ../../panels/visualizations/text-panel/ ../../reference/alertlist/ ../../visualizations/text-panel/] [grafana text documentation panel] [{products [cloud enterprise oss]}] Configure options for Grafana's text visualization Text 100 [{disable_sanitize_html {pattern /docs/grafana/} {destination /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#disable_sanitize_html}] [{pattern /docs/grafana-cloud/} {destination /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#disable_sanitize_html}} {variables {pattern /docs/grafana/} {destination /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/variable-syntax/}] [{pattern /docs/grafana-cloud/} {destination /docs/grafana-cloud/visualizations/dashboards/variables/variable-syntax/}}]

Text

Text visualizations let you 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 on your dashboard, you can use a text visualization to add these links:

{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-text-visualization-v11.6.png" max-width="750px" alt="A text panel showing important links" >}}

{{< docs/play title="Text Panel" url="https://play.grafana.org/d/adl33bxy1ih34b/" >}}

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.

Configuration options

{{< docs/shared lookup="visualizations/config-options-intro.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Panel options

{{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Text options

Use the following options to refine your text visualization.

Option Description
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.

To allow embedding of iframes and other websites, you need set allow_embedding = true in your Grafana config.ini or environment variables (depending on your employment).
Language When you choose Code as your text mode, select an appropriate language to apply syntax highlighting to the embedded text.
Show line numbers Displays line numbers in the panel preview when you choose Code as your text mode.
Show mini map Displays a small outline of the embedded text in the panel preview when you choose Code as your text mode.