Skip to content

Commit

Permalink
Add Acknowledgment and update description (#268)
Browse files Browse the repository at this point in the history
* Add Acknowledgment and update description

* Updates
  • Loading branch information
mikhail-vl authored Mar 22, 2024
1 parent f6e5cde commit 7e2f139
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 29 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
51 changes: 29 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -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.

Expand All @@ -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).
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -85,5 +85,5 @@
"test:ci": "jest --maxWorkers 4 --coverage",
"upgrade": "npm upgrade --save"
},
"version": "5.3.0"
"version": "6.0.0"
}
2 changes: 1 addition & 1 deletion src/components/DatasetEditor/DatasetEditor.styles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
8 changes: 4 additions & 4 deletions src/plugin.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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",
Expand Down Expand Up @@ -43,6 +43,6 @@
"updated": "%TODAY%",
"version": "%VERSION%"
},
"name": "Apache ECharts",
"name": "Business Charts",
"type": "panel"
}

0 comments on commit 7e2f139

Please sign in to comment.