diff --git a/README.md b/README.md index 01442c4..c4b511c 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,44 @@ -
- logo -
-

ECharts Java

-

- "We bring better visualization into Java with ECharts" -

-

- - Github Actions Status - - - Contributions welcome - - - - License - - - Maven Central - -

-[中文 README](README.zh.md) -[Official Documentation](https://echarts.icepear.org/#/) -## 📙 Introduction +## 📙 简介 -ECharts Java is a lightweight but comprehensive library for Java developers to easily use JavaScript visualization library [Apache ECharts](https://echarts.apache.org/en/index.html). The simple chart mode facilitates users to write visualization fast and easily, empowered by the clean APIs provided by ECharts Java. The advanced mode helps create an `Option` object and its Json representation in chainable Java codes, which includes almost all the features defined in [Apache ECharts](https://echarts.apache.org/en/index.html). Now ECharts Java supports Apache ECharts version 5.x. +ECharts Java 是一款基于 [Apache ECharts](https://echarts.apache.org/en/index.html) 的,简易但全面的数据可视化库。(现支持 Apache ECharts 5.x 版本)。 -## 🌠 Features +论简易性,ECharts Java 重新设计了一系列和绘图有关的接口,使得绘图过程更加符合直觉和常理。同时,由于 Apache ECharts 的接口过于复杂和繁琐,我们在 ECharts Java 的图表 API 中简化了部分原本的接口设计。 -- Simple, clean and organized APIs, supporting method chaining +论全面,ECharts Java 保留了 Apache ECharts “一切皆 Option”的设计理念。因此,除了重新设计的图表 API 以外,我们还保留了自定义 Option 对象的方法。用户可以从零开始,按照 ECharts 的 Option 文档,自定义任何 ECharts 支持的 Option。除此以外,我们还使用链式方法调用等方式,使得 Java 开发者在构建 Option 的过程中更加方便。 -- Full coverage of [Apache ECharts](https://echarts.apache.org/en/index.html) functionalities +## 🌠 特性 -- Easily integrate with Web Frameworks +- 简单、整洁、高度组织化的 API 接口,支持链式调用 +- 完整保存 Apache ECharts 的功能 +- 快速集成至当前流行的 Web 框架 +- 灵活的导出格式,支持 HTML,PNG 和 JSON +- 完整、详细的文档和示例库 -- Flexible export format, including HTML and images +## 🔬 安装 -- Complete and detailed documentation and examples +Maven 项目: -## 🔬 Installation - -For a Maven project, includes the following in your pom.xml ```xml +// pom.xml - org.icepear.echarts - echarts-java - 1.0.7 + com.njcn + echarts5-java + 0.0.1 ``` -For a Gradle Groovy project, includes -``` -implementation 'org.icepear.echarts:echarts-java:1.0.7' -``` -For more, refer to [here](https://search.maven.org/artifact/org.icepear.echarts/echarts-java/1.0.7/jar). +如果你使用的是其他项目,请参阅[这里](https://search.maven.org/artifact/org.icepear.echarts/echarts-java/1.0.7/jar)。 -## 🔭 Usage +## 🔭 使用 -### Generate Local HTML and Download Image +### 生成 HTML 和下载图片 ```java public static void main(String[] args) { - // All methods in EChart Java supports method chaining +// All methods in EChart Java supports method chaining Bar bar = new Bar() .setLegend() .setTooltip("item") @@ -81,9 +53,10 @@ public static void main(String[] args) { engine.render("index.html", bar); } ``` + multi-bar-render -### Generate Option Object and its JSON Representation +### 生成 Option 对象和对应的 JSON 结构 ```java public static void main(String[] args) { @@ -101,7 +74,7 @@ public static void main(String[] args) { } ``` -The output JSON object will be like the following, +生成的 JSON 对象如下: ```json { @@ -123,13 +96,13 @@ The output JSON object will be like the following, } ``` -### Integrate with Spring Web Application +### 集成至 Spring Boot 应用 spring-boot-integration -For demo codes, please refer to the [docs](https://echarts.icepear.org/) and [example repo](https://github.com/incandescentxxc/ECharts-Java-Examples). +详细内容请参阅,[文档](https://echarts.icepear.org/#/zh-cn/) ,[代码仓库](https://github.com/incandescentxxc/ECharts-Java-Examples)。 -## 🎇 Gallery +## 🎇 示例

@@ -156,17 +129,19 @@ For demo codes, please refer to the [docs](https://echarts.icepear.org/) and [ex

-## 💡 Authors +## 💡 作者 + - [@IcePear-Jzx](https://github.com/IcePear-Jzx) - [@incandescentxxc](https://github.com/incandescentxxc) -Welcome more contribution in the community! +欢迎大家积极提 issue,fork,和其他贡献! -## 💌 Acknowledgement -- This project is inspired by the Homework 6 of the course [Principles of Software Construction Objects, Design, and Concurrency](https://cmu-17-214.github.io/f2021/), Fall 2021, at [Carnegie Mellon University](https://www.cmu.edu/). We sincerely thank [Christian](https://www.cs.cmu.edu/~ckaestne/) and [Vincent](https://vhellendoorn.github.io/) for the wonderful course. +## 💌 鸣谢 -- This project is also inspired by the [pyecharts](https://github.com/pyecharts/pyecharts) and [go-echarts](https://github.com/go-echarts/go-echarts), which are the ECharts siblings in Python and Go languages. +- 本项目灵感来源于[卡耐基梅隆大学](https://www.cmu.edu/)的课程,[Principles of Software Construction Objects, Design, and Concurrency](https://cmu-17-214.github.io/f2021/)。我们在此真诚地感谢 [Christian](https://www.cs.cmu.edu/~ckaestne/) 和 [Vincent](https://vhellendoorn.github.io/) 在 2021 秋天教授的这门课。 -## 🎈 License +- 本项目同样也受到 [pyecharts](https://github.com/pyecharts/pyecharts) 和 [go-echarts](https://github.com/go-echarts/go-echarts) 的启发。 -ECharts Java is available under the [Apache License 2.0](LICENSE). +## 🎈 开源协议 + +本项目遵循 [Apache License 2.0](LICENSE) 开源协议。 diff --git a/assets/imgs/animation-gauge.jpg b/assets/imgs/animation-gauge.jpg new file mode 100644 index 0000000..78b8156 Binary files /dev/null and b/assets/imgs/animation-gauge.jpg differ diff --git a/assets/imgs/basic-boxplot.jpg b/assets/imgs/basic-boxplot.jpg new file mode 100644 index 0000000..4355421 Binary files /dev/null and b/assets/imgs/basic-boxplot.jpg differ diff --git a/assets/imgs/basic-candlestick.jpg b/assets/imgs/basic-candlestick.jpg new file mode 100644 index 0000000..81e2add Binary files /dev/null and b/assets/imgs/basic-candlestick.jpg differ diff --git a/assets/imgs/basic-funnel.jpg b/assets/imgs/basic-funnel.jpg new file mode 100644 index 0000000..ef689b8 Binary files /dev/null and b/assets/imgs/basic-funnel.jpg differ diff --git a/assets/imgs/basic-heatmap.jpg b/assets/imgs/basic-heatmap.jpg new file mode 100644 index 0000000..7bb00c4 Binary files /dev/null and b/assets/imgs/basic-heatmap.jpg differ diff --git a/assets/imgs/basic-parallel.jpg b/assets/imgs/basic-parallel.jpg new file mode 100644 index 0000000..7f83813 Binary files /dev/null and b/assets/imgs/basic-parallel.jpg differ diff --git a/assets/imgs/basic-polar-line.jpg b/assets/imgs/basic-polar-line.jpg new file mode 100644 index 0000000..c359788 Binary files /dev/null and b/assets/imgs/basic-polar-line.jpg differ diff --git a/assets/imgs/basic-polar-scatter.jpg b/assets/imgs/basic-polar-scatter.jpg new file mode 100644 index 0000000..6b0921d Binary files /dev/null and b/assets/imgs/basic-polar-scatter.jpg differ diff --git a/assets/imgs/basic-radar.jpg b/assets/imgs/basic-radar.jpg new file mode 100644 index 0000000..51a34c0 Binary files /dev/null and b/assets/imgs/basic-radar.jpg differ diff --git a/assets/imgs/basic-rose.jpg b/assets/imgs/basic-rose.jpg new file mode 100644 index 0000000..a795021 Binary files /dev/null and b/assets/imgs/basic-rose.jpg differ diff --git a/assets/imgs/basic-sankey.jpg b/assets/imgs/basic-sankey.jpg new file mode 100644 index 0000000..95e381a Binary files /dev/null and b/assets/imgs/basic-sankey.jpg differ diff --git a/assets/imgs/basic-scatter.jpg b/assets/imgs/basic-scatter.jpg new file mode 100644 index 0000000..4aad371 Binary files /dev/null and b/assets/imgs/basic-scatter.jpg differ diff --git a/assets/imgs/basic-sunburst.jpg b/assets/imgs/basic-sunburst.jpg new file mode 100644 index 0000000..c947cb2 Binary files /dev/null and b/assets/imgs/basic-sunburst.jpg differ diff --git a/assets/imgs/basic-theme-river.jpg b/assets/imgs/basic-theme-river.jpg new file mode 100644 index 0000000..f1f93ed Binary files /dev/null and b/assets/imgs/basic-theme-river.jpg differ diff --git a/assets/imgs/circular-layout-graph.jpg b/assets/imgs/circular-layout-graph.jpg new file mode 100644 index 0000000..163da96 Binary files /dev/null and b/assets/imgs/circular-layout-graph.jpg differ diff --git a/assets/imgs/hide-overlapped-label-graph.jpg b/assets/imgs/hide-overlapped-label-graph.jpg new file mode 100644 index 0000000..4e02adb Binary files /dev/null and b/assets/imgs/hide-overlapped-label-graph.jpg differ diff --git a/assets/imgs/horizontal-stacked-bar.jpg b/assets/imgs/horizontal-stacked-bar.jpg new file mode 100644 index 0000000..4a9e997 Binary files /dev/null and b/assets/imgs/horizontal-stacked-bar.jpg differ diff --git a/assets/imgs/line-renderHtml.gif b/assets/imgs/line-renderHtml.gif new file mode 100644 index 0000000..0771800 Binary files /dev/null and b/assets/imgs/line-renderHtml.gif differ diff --git a/assets/imgs/logo.png b/assets/imgs/logo.png new file mode 100644 index 0000000..6a86d14 Binary files /dev/null and b/assets/imgs/logo.png differ diff --git a/assets/imgs/multibar-render.gif b/assets/imgs/multibar-render.gif new file mode 100644 index 0000000..b093de2 Binary files /dev/null and b/assets/imgs/multibar-render.gif differ diff --git a/assets/imgs/multiple-series-bar.jpg b/assets/imgs/multiple-series-bar.jpg new file mode 100644 index 0000000..80c698a Binary files /dev/null and b/assets/imgs/multiple-series-bar.jpg differ diff --git a/assets/imgs/nested-pie.jpg b/assets/imgs/nested-pie.jpg new file mode 100644 index 0000000..cb892b2 Binary files /dev/null and b/assets/imgs/nested-pie.jpg differ diff --git a/assets/imgs/render-json-option.png b/assets/imgs/render-json-option.png new file mode 100644 index 0000000..98d0323 Binary files /dev/null and b/assets/imgs/render-json-option.png differ diff --git a/assets/imgs/stacked-area.jpg b/assets/imgs/stacked-area.jpg new file mode 100644 index 0000000..57e177a Binary files /dev/null and b/assets/imgs/stacked-area.jpg differ diff --git a/assets/imgs/stacked-line.jpg b/assets/imgs/stacked-line.jpg new file mode 100644 index 0000000..92686a9 Binary files /dev/null and b/assets/imgs/stacked-line.jpg differ diff --git a/assets/imgs/tangential-polar-bar.jpg b/assets/imgs/tangential-polar-bar.jpg new file mode 100644 index 0000000..723e0da Binary files /dev/null and b/assets/imgs/tangential-polar-bar.jpg differ