From 7e2f139556d8583d5db5a781c7520a551f0ebbe7 Mon Sep 17 00:00:00 2001 From: Mikhail Volkov <47795110+mikhail-vl@users.noreply.github.com> Date: Thu, 21 Mar 2024 23:21:00 -0400 Subject: [PATCH] Add Acknowledgment and update description (#268) * Add Acknowledgment and update description * Updates --- CHANGELOG.md | 11 ++++ README.md | 51 +++++++++++-------- package.json | 4 +- .../DatasetEditor/DatasetEditor.styles.ts | 2 +- src/plugin.json | 8 +-- 5 files changed, 47 insertions(+), 29 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 184245b..6c8ecb1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # Change Log +## 6.0.0 (2024-03-22) + +### Breaking changes + +- Requires Grafana 10 and Grafana 11 + +### Features / Enhancements + +- Updated name to Business Charts Panel (#268) +- Added Apache Acknowledgment and update description (#268) + ## 5.3.0 (2024-03-06) ### Features / Enhancements diff --git a/README.md b/README.md index 1da7cf2..4359785 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Apache ECharts Panel for Grafana +# Business Charts Panel for Grafana ![ECharts](https://github.com/VolkovLabs/volkovlabs-echarts-panel/raw/main/src/img/dashboard.png) @@ -11,22 +11,25 @@ ## Introduction -The Apache ECharts Panel plugin is a data visualization extension for Grafana that allows you to integrate charts and graphs from the popular Apache ECharts library into your Grafana dashboard. +The Business Charts Panel plugin is a visualization extension for Grafana powered by the Apache ECharts library. -[Apache ECharts](https://echarts.apache.org/en/index.html) is a powerful and versatile data visualization library providing a wide range of chart types including statistical capabilities. It is written in pure JavaScript and based on [zrender](http://ecomfe.github.io/zrender/), a lightweight graphic library for chart rendering. +The Business Charts Panel allows you to integrate charts and graphs created by the [Apache ECharts library](https://echarts.apache.org/en/index.html) into your Grafana dashboard. + +Apache ECharts is a powerful and versatile data visualization library providing a wide range of chart types including statistical capabilities. It is written in pure JavaScript and based on [zrender](http://ecomfe.github.io/zrender/), a lightweight graphic library for chart rendering. [![Apache ECharts panel for Grafana | Explore possibilities](https://raw.githubusercontent.com/volkovlabs/volkovlabs-echarts-panel/main/img/overview.png)](https://youtu.be/S3PiL1p1v5U) -The Apache ECharts plugin offers an easy way of adding intuitive, interactive, and highly customizable charts into your Grafana dashboard. +The Business Charts plugin offers an easy way of adding intuitive, interactive, and highly customizable charts to your Grafana dashboard. ## Requirements -- Apache ECharts Panel 5.X requires **Grafana 9.2** or **Grafana 10**. -- Apache ECharts Panel 3.X and 4.X require **Grafana 8.5** or **Grafana 9**. +- Business Charts Panel 6.X requires **Grafana 10** or **Grafana 11**. +- Business Charts Panel 5.X requires **Grafana 9** or **Grafana 10**. +- Business Charts Panel 3.X and 4.X require **Grafana 8.5** or **Grafana 9**. ## Getting Started -You can install the Apache ECharts Panel from the [Grafana Plugins [catalog](https://grafana.com/grafana/plugins/volkovlabs-echarts-panel/) or use the Grafana command line tool. +You can install the Business Charts Panel from the [Grafana Plugins catalog](https://grafana.com/grafana/plugins/volkovlabs-echarts-panel/) or using the Grafana command line tool. For the latter, please use the following command. @@ -40,41 +43,45 @@ grafana-cli plugins install volkovlabs-echarts-panel - Working with Grafana data frames (JavaScript). - Updating chart configurations in the JSON format. - Customizing theme configurations. -- Supports variables and [locationService](https://grafana.com/docs/grafana/latest/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-variables/#set-a-variable-from-your-plugin) to make charts interactive. -- Based on [Apache ECharts 5.4.3](https://github.com/apache/echarts/releases/tag/5.4.3). -- Supports light and dark themes adjusted to the Grafana theme. +- Supports Code Editor suggestions for parameters and variables. - Supports SVG and Canvas renderers. +- Supports variables and [locationService](https://grafana.com/docs/grafana/latest/developers/plugins/create-a-grafana-plugin/extend-a-plugin/add-support-for-variables/#set-a-variable-from-your-plugin) to make charts interactive. - Includes USA and World GeoJSON maps. Additional maps can be loaded dynamically. -- Includes [Liquid Fill Chart](https://github.com/ecomfe/echarts-liquidfill) to represent data in percentage. +- Supports Baidu, Gaode, and Google Maps using API with required provision of the access key. - Includes [ECharts-GL](https://github.com/ecomfe/echarts-gl) proving 3D plots, globe visualization, and WebGL acceleration. - Includes [ecStat](https://github.com/ecomfe/echarts-stat), a statistical and data mining tool. -- Supports Code Editor suggestions for parameters and variables. -- Supports Baidu, Gaode, and Google Maps using API. Requires the provision of the access key. +- Includes [Liquid Fill Chart](https://github.com/ecomfe/echarts-liquidfill) to represent data in percentage. - Supports real-time data updates using streaming data sources and Grafana Live. +- Supports light and dark themes adjusted to the Grafana theme. +- Based on [Apache ECharts 5.5.0](https://github.com/apache/echarts/releases/tag/5.5.0). - Provides 100+ ready-to-use examples at [echarts.volkovlabs.io](https://echarts.volkovlabs.io). [![Examples](https://github.com/VolkovLabs/volkovlabs-echarts-panel/raw/main/src/img/examples.png)](https://echarts.volkovlabs.io) ## Documentation -| Section | Description | -| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [ECharts Function](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/options/) | Explains how to configure the main Apache ECharts library function. | -| [Examples](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/examples/) | Explains how to get started with ECharts Examples. | -| [Features](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/features/) | Demonstrates panel features. | -| [Maps](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/maps/) | Demonstrates how to work with different maps. | -| [Tutorials](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/tutorials/) | Tutorials for Apache ECharts Panel. | -| [Release Notes](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/release/) | Stay up to date with the latest features and updates. | +| Section | Description | +| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [Charts Function](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/options) | Explains how to configure the main Apache ECharts library function. | +| [Examples](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/examples) | Explains how to get started with the Apache ECharts Examples in Grafana. | +| [Features](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/features) | Demonstrates the Business Charts panel features. | +| [Maps](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/maps) | Demonstrates how to work with different maps. | +| [Tutorials](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/tutorials) | Tutorials for the Business Charts Panel. | +| [Release Notes](https://volkovlabs.io/plugins/volkovlabs-echarts-panel/release) | Stay 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](https://github.com/volkovlabs/volkovlabs-echarts-panel/issues/new/choose). +- Ask a question, request a new feature, or report an issue at [GitHub issues](https://github.com/volkovlabs/volkovlabs-echarts-panel/issues). - Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and leave your comments. - Sponsor our open-source plugins for Grafana at [GitHub Sponsor](https://github.com/sponsors/VolkovLabs). - Support our project by starring the repository. +## Acknowledgment + +The Apache Software Foundation Apache ECharts, ECharts, Apache, the Apache feather, and the Apache ECharts project logo are either registered trademarks or trademarks of the Apache Software Foundation. + ## License Apache License Version 2.0, see [LICENSE](https://github.com/volkovlabs/volkovlabs-echarts-panel/blob/main/LICENSE). diff --git a/package.json b/package.json index c520744..401ce41 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,7 @@ "tslib": "^2.6.2", "uuid": "^9.0.1" }, - "description": "Apache ECharts panel for Grafana", + "description": "Business Charts panel for Grafana", "devDependencies": { "@babel/core": "^7.24.0", "@grafana/e2e": "^10.3.3", @@ -85,5 +85,5 @@ "test:ci": "jest --maxWorkers 4 --coverage", "upgrade": "npm upgrade --save" }, - "version": "5.3.0" + "version": "6.0.0" } diff --git a/src/components/DatasetEditor/DatasetEditor.styles.ts b/src/components/DatasetEditor/DatasetEditor.styles.ts index eb534da..9d3da73 100644 --- a/src/components/DatasetEditor/DatasetEditor.styles.ts +++ b/src/components/DatasetEditor/DatasetEditor.styles.ts @@ -12,7 +12,7 @@ export const getStyles = (theme: GrafanaTheme2) => { header: css` label: Header; padding: ${theme.spacing(0.5, 0.5)}; - border-radius: ${theme.shape.borderRadius(1)}; + border-radius: ${theme.shape.radius.default}; background: ${theme.colors.background.secondary}; min-height: ${theme.spacing(4)}; display: grid; diff --git a/src/plugin.json b/src/plugin.json index 7ced997..8632b18 100644 --- a/src/plugin.json +++ b/src/plugin.json @@ -1,7 +1,7 @@ { "$schema": "https://raw.githubusercontent.com/grafana/grafana/master/docs/sources/developers/plugins/plugin.schema.json", "dependencies": { - "grafanaDependency": ">=9.2.0", + "grafanaDependency": ">=10.0.0", "plugins": [] }, "id": "volkovlabs-echarts-panel", @@ -10,8 +10,8 @@ "name": "Volkov Labs", "url": "https://volkovlabs.io" }, - "description": "Powerful charting and visualization library Apache ECharts", - "keywords": ["echarts"], + "description": "Powerful visualizations powered by Apache ECharts.", + "keywords": ["business", "echarts"], "links": [ { "name": "Documentation", @@ -43,6 +43,6 @@ "updated": "%TODAY%", "version": "%VERSION%" }, - "name": "Apache ECharts", + "name": "Business Charts", "type": "panel" }