Plugins 〉Business Text

Panel

community

Business Text

Overview
Installation
Change log
Related content

Business Text for Grafana

Text

Introduction

The Business Text panel plugin allows you to construct a text visualization template from the values of a dataset returned by a data source query.

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 use 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.
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.

Documentation

Section	Description
Rendering	Explains how to create a visualization template for your data
Recipes	Useful snippets that you can use in your templates
Features	Demonstrates panel features.templates
Tutorials	Easy to follow tutorials
Release Notes	Stay up to date with the latest features and updates

Business Suite for Grafana

The Business Suite is a collection of open source plugins created and actively maintained by Volkov Labs.

The collection aims to solve the most frequent business tasks by providing an intuitive interface with detailed written documentation, examples, and video tutorials.

Enterprise Support

With the Business Suite Enterprise, you're not just getting a product, you're getting a complete support system. You'll have a designated support team ready to tackle any issues.

You can contact us via Zendesk, receive priority in feature requests and bug fixes, meet with us for in-person consultation, and get access to the Business Intelligence. It's a package that's designed to make your life easier.

Always happy to hear from you

Ask a question, request a new feature, or report an issue at GitHub issues.
Subscribe to our YouTube Channel and leave your comments.
Become a Business Suite sponsor.

License

Apache License Version 2.0, see LICENSE.

Installing Business Text on Grafana Cloud:

For more information, visit the docs on plugin installation.

Changelog

5.6.0 (2024-12-15)

Features / Enhancements

Updated packages for Code Editor (#380)

5.5.0 (2024-12-09)

Features / Enhancements

Updated Autosize Code Editor toolbar (#362)
Added helper statusColor from specific field (#375)
Updated E2E tests (#377)
Updated to Grafana 11.4 and dependencies (#378)
Added replace variables in URLs (#376)

5.4.0 (2024-09-12)

Features / Enhancements

Updated panel render if first data source does not have data (#353)
Added wrap button in the code editor (#359)
Updated Partials loading (#358)
Updated hyperlinks style (#358)

5.3.0 (2024-08-22)

Features / Enhancements

Updated Provisioning Dashboard (#346)
Added partials to load external HTML (#345)
Added Expandable Editors (#348)

5.2.0 (2024-07-25)

Features / Enhancements

Updated helpers migration (#338)
Updated to Grafana 11.1 and dependencies (#339)

5.1.0 (2024-07-01)

Features / Enhancements

Updated before render code async and pass markdown instance (#322)
Added running e2e tests in docker (#323)
Updated Video tutorial (#330)

5.0.0 (2024-06-06)

Breaking changes

Requires Grafana 10 and Grafana 11.
Removed external scripts deprecated in Grafana 11. Use import instead.
Removed non-context code parameters. Please update parameters to use context.

Code parameters migration guide

data -> context.data
dataFrame -> context.dataFrame
eventBus -> context.grafana.eventBus
getLocale -> context.grafana.getLocale
handlebars -> context.handlebars
locationService -> context.grafana.locationService
panelData -> context.panelData
replaceVariables -> context.grafana.replaceVariables
timeRange -> context.grafana.timeRange
timezone -> context.grafana.timezone

Features / Enhancements

Added plugin e2e tests and remove cypress (#301)
Updated name to Business Text Panel (#304)
Prepared for Grafana 11 (#304)
Added ES6 Modules Support (#312)
Added Units and Decimal in panel options (#311)
Updated to Grafana 11.0 and dependencies (#315)

4.5.0 (2024-03-13)

Features / Enhancements

Add Info message if sanitize enabled (#290)
Update CSS styles responsive and supporting themes (#281)
Update to Grafana 10.4.0 (#291)

4.4.0 (2024-03-06)

Breaking changes

Requires Grafana 9.2 and Grafana 10

Features / Enhancements

Update context parameter (#270)
Added theme object, notifySuccess & notifyError (#270)
Update dependencies and Actions (#271)
Replace custom code parameters with Code Parameters Builder (#285)
Update CSS class for the Panel instead of a Row (#272)
Update Editor auto height from fixed value (#278)
Disable unitScale and fieldMinMax standard panel options (#286)

Bug fixes

Fix statusColor for Row (#280)

4.3.0 (2023-12-25)

Features / Enhancements

Update ESLint configuration and refactor (#239)
Update Collapse from @volkovlabs/components (#239)
Update Introduction video in README (#240)
Add data render mode and passing selected data frame (#246)
Update to Grafana 10.2.2 and Volkov labs packages (#247)
Add variableValue helper (#252)
Add re-render on dashboard refresh (#252)

Bug fixes

Fix draggable icon in Grafana 10.3 (#249)

4.2.0 (2023-11-20)

Features / Enhancements

Add ESLint deprecation check (#203)
Add custom code option which is called after content is ready (#231)
Add option to enabled/disable wrapping to support empty lines in HTML (#235)
Add handlebars (startsWith, endsWith, match) (#211)
Update ESLint configuration and sort imports (#236)
Update to Plugin Tools 2.1.1 (#236)
Use Grafana Access Policy to sign plugin (#236)
Update to Grafana 10.2.1 (#237)

4.1.0 (2023-07-16)

Features / Enhancements

Update ESLint configuration (#192)
Increase Tests Coverage (#194)
Add status field (#196)
Add External JavaScript, CSS Resources (#197)
Update to Grafana 10.0.2 dependencies (#201)

4.0.0 (2023-06-26)

Breaking changes

Requires Grafana 9 and Grafana 10

Features / Enhancements

Increase Test Coverage and update to testing-library/react (#177)
Add Event Bus object to JavaScript function (#179)
Migrate to Plugin Tools 1.5.2 (#183)
Update to Grafana 10.0.0 (#166, #178, #183)
Update to Node 18 and npm (#183)
Remove Grafana 8.5 support (#183)
Add E2E Cypress testing (#184)
Support Variables in CSS styles editor (#185)

3.1.0 (2023-03-12)

Features / Enhancements

Add Time Zone and Range parameters for Javascript Code (#155)
Update to Grafana 9.4.3 (#156)
Add Magic (JavaScript) Trio tutorial in README (#157)
Update replace variables with scoped function (#160)
Add Replace variables and Location service parameters for Javascript Code (#160)

3.0.0 (2023-02-19)

Breaking changes

The default Content and JavaScript editors are not displayed by default unless values were modified. To display required editors, including the new Styles, they should be selected in the list.

Features / Enhancements

Update README features with new JavaScript Code Editor (#141)
Update to Grafana 9.3.6 (#147)
Update CI and Release workflows (#147)
Update README to include JavaScript tutorial (#148)
Add custom styles (#149)
Add option to display optional editors (#149)
Remove Panel Padding (#150)
Add Code Syntax Highlight (#151)
Add Breaking Changes for displaying optional editors (#152)

2.2.0 (2023-01-09)

Features / Enhancements

Add JSON helper to show objects and arrays (#121)
Update to Grafana 9.3.1 (#122)
Update Documentation links (#130, #131)
Add Split Helper (#132)
Refactor Text Component and Styles (#133)
Add JavaScript Code to add Handlebars helpers and Event handlers (#134)
Update default Content to {{json @root}} and Code Editor height to 200px (#134)
Update CSS to fit images to screen (#135)
Add getLocale() parameter to JavaScript Code (#137)

2.1.0 (2022-11-27)

Breaking changes

Refactoring may introduce breaking changes. Please test before upgrading in Production.

Features / Enhancements

Fix broken link in README (#111)
Update CI to upload signed artifacts (#113)
Add feature of parsing time formatting syntax (#86)
Fix data rendering when using transformations (#98)
Update Panel Options to Monaco Code Editor (#114)
Increase Test Coverage (#114)
Refactor and update images (#116)
Refactor Alert Message and Text Options (#117)
Add Support for Disable Sanitize HTML configuration (#118)

2.0.0 (2022-11-02)

Breaking changes

This release bumps the minimum required Grafana to >=8.5.

Features / Enhancements

Maintained by Volkov Labs (#100)
Updated based on Volkov Labs Panel Template (#100)
Update to Grafana 9.1.6 (#104)
Add "Dynamic Text Plugin for Grafana" video in README (#106)
Update CI to Node 16 and Synchronize with Release workflow (#107)
Update to Grafana 9.2.2 (#108)
Update screenshot and provisioning (#109)

1.9.0 (2022-01-09)

Features / Enhancements

Add an option to render template for each row or as a single template. Useful for when you want to create tables from the query result. (#53) Thanks @andykingking.