Skip to main content

Business Text

announcement

The Dynamic Text panel joins the Business Suite for Grafana and with that gets an elevated name. Now, the same amazing open source plugin is called the Business Text panel.

Please welcome the new name for the same functionality!

The Dynamic Text panel now is called the Business Text panel.
The Dynamic Text panel now is called the Business Text panel.

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.
Business Text Panel for Grafana. Main features overview.

Requirements​

  • Business Text Panel 5.X requires Grafana 10 or Grafana 11.
  • Dynamic Text Panel 4.X requires Grafana 9 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.

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.

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.
Release NotesStay up to date with the latest features and updates.

Feedback​

We're looking forward to hearing from you. You can use different ways to get in touch with us.

  • Ask a question, request a new feature, or report an issue at GitHub issues.
  • Subscribe to our YouTube Channel and leave your comments.
  • Sponsor our open source plugins for Grafana through GitHub.

License​

Apache License Version 2.0, see LICENSE.