Skip to main content

Business Text

The Business Text panel is a Grafana visualization plugin that you can use to convert plain text and table data into visually appealing, easy-to-read information cards. For that, the offered arsenal includes:

  • Access to variables (dashboard and global),
  • Markdown,
  • Handlebars,
  • Helpers (predefined and your own),
  • CSS styles
  • JavaScript.

By working with the Business Text plugin you construct a text visualization template:

  • using the above-mentioned features and
  • indicating the spots where the fetched data frame elements should be placed.

Requirements​

  • Business Text panel 5.X requires Grafana 10 or Grafana 11.
  • Dynamic Text panel 4.X requires Grafana 9.2 or Grafana 10.
  • Dynamic Text panel 2.X and 3.X require Grafana 8.5 or Grafana 9.
  • Dynamic Text panel 1.X requires Grafana 7.

Getting Started​

You can install the Business Text panel from the Grafana Plugins catalog or using the Grafana command line tool.

Install Business Suite plugins in Cloud, OSS, Enterprise. Getting started with the Business Suite.

For the latter, please use the following command:

grafana cli plugins install marcusolsson-dynamictext-panel

Highlights​

  • Uses Monaco Code Editor with automatic JavaScript code formatting. Use it to add your JavaScript code and to import external JavaScript libraries
  • Supports Markdown and Handlebars.
  • Renders markdown-it into HTML elements.
    • Supports the highlighting of code syntax using A11Y styles.
  • Provides code sanitization:
    • HTML inside templates is sanitized using XSS.
    • Can be disabled in the Grafana configuration through the disable_sanitize_html parameter.
  • Supports display of nested objects using the {{json object}} Handlebars helper.
  • Supports display of time global variables (__to and __from) as seconds, ISO timestamps, or formatted using the dayjs library.
  • Supports adding the Handlebars helpers and event handlers.
  • Supports adding CSS styles with dashboard variables.
  • Supports internationalization using custom helpers.
The Business Text panel for Grafana.
The Business Text panel for Grafana.

Tutorial​

The video reviews the major latest release including the data flow, predefined helpers and numerous examples of the external JavaScript libraries.

The Business Text panel for Grafana. Main features overview in 5.0.0

We have many other tutorials that you can find helpful. You can review all related to this plugin tutorials here.

Documentation​

SectionDescription
RenderingExplains how to create a visualization template for your data
RecipesLists useful snippets that you can use in your templates
FeaturesExplains the plugin's features
TutorialsEasy to follow tutorials
Release NotesStay up to date with the latest features and updates

License​

Apache License Version 2.0, see LICENSE.

Always happy to hear from you​

  Enroll in Business Suite Enterprise