Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koooooo-7/echarts4j
π© An inevitable charts library for Java.
https://github.com/koooooo-7/echarts4j
data-visualization echarts java visualization
Last synced: 10 days ago
JSON representation
π© An inevitable charts library for Java.
- Host: GitHub
- URL: https://github.com/koooooo-7/echarts4j
- Owner: Koooooo-7
- License: apache-2.0
- Created: 2024-06-20T15:34:13.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-22T06:30:39.000Z (15 days ago)
- Last Synced: 2024-10-23T09:21:19.444Z (14 days ago)
- Topics: data-visualization, echarts, java, visualization
- Language: Java
- Homepage: https://koooooo-7.github.io/echarts4j/
- Size: 3.45 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# echarts4j
[](https://jitpack.io/#Koooooo-7/echarts4j/main-SNAPSHOT)
[](https://javadoc.jitpack.io/com/github/koooooo-7/echarts4j/echarts4j-project/main-SNAPSHOT/javadoc/index.html)
> Fairy tales are more than true: not because they tell us that dragons exist, but because they tell us that dragons can
> be beaten. ββ Neil Gaiman, Coraline
To be honest, I believe using `Java` to build charts is a disaster, as it often feels like struggling in the explicit
typed hell, accompanied by lengthy lines of code. However, it also piques my interest in finding ways to approach it
with a more loosely coupled mindset (not just dumping everything as pure `Object`s πΆ). With increased experience in [Echarts](https://echarts.apache.org/) and discovering
various tricks, I've become even more curious about the possibilities. Fortunately, I now have the time to delve into
this further. *( contents polished by `ChartGPT-4`)*
---
[README δΈζ](./README_ZH.md)
### π° Installation
> Support JDK8+ with `"JDK Sympathy"` (you do need upgrade it tho!)
It hosts on [jitpack](https://jitpack.io/#Koooooo-7/echarts4j/main-SNAPSHOT),
you can use the `main-SNAPSHOT` to fetch the latest version or the lock commit hash
version [](https://jitpack.io/#Koooooo-7/echarts4j)
.
Install via Gradle
```gradle
repositories {
mavenCentral()
// add the repository
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.Koooooo-7.echarts4j:echarts4j-project:v1.0.0'
}
```
Install via Maven
```pom
jitpack.io
https://jitpack.io
com.github.Koooooo-7.echarts4j
echarts4j-project
v1.0.0
```
### β¨ Features
* Smooth builder APIs.
* Highly configurable chart options.
* Lots of beauty charts available.
* Closely to the full Echarts functionalities.
* Strong Extensibility.
* Live update support for displaying (see [echarts4j-chart-server](./echarts4j-chart-server/README.md)).
* Snapshot for image render (see [echarts4j-snapshot-playwright](./echarts4j-snapshot-playwright/README.md)).
* And more.
### π¨ Showcase
---
### π RunBook
In a nutshell, it generates [Apache Echarts](https://echarts.apache.org/) options for the Echarts instance.
If you already familiar with [Echarts](https://echarts.apache.org/), you can quickly dive in.
- Take a quick look at the [Echarts Demos](https://echarts.apache.org/examples/en/index.html) to find what you need.
- Refer to the available [Echarts Options](https://echarts.apache.org/en/option.html#title) to understand how to
configure.
(If it is missing in `echarts4j`, feel free to raise an Issue/PR :rocket:)
In general, there are three key aspects to understand about building an Echarts Chart in `echarts4j`:
- The `Canvas`, which contains all the charts and resources (`js, css...`), functioning similarly to an HTML page by
default.
- The `Chart`, representing a Chart instance, with generic chart configurations, such as Title, Toolbox, and more.
- The `Series`, which resides within the Charts, where each type of Series indicates the underlying chart type.
```
|ββββββββββββ
| Canvas |
| |
| ββββββ |
| | Chart |
| | ββββ |
| | |Series type=Bar |
| | ββββ |
| | |Series type=Line|
| (overlap different kinds of charts in one Chart)
| | ββββ |
| | |Series ... |
| | ββββ |
| ββββββ |
| Charts...|
| ββββββ |
| ββββββ |
| ββββββ |
βββββββββββ
```
More details please see the [QuickStart](https://koooooo-7.github.io/echarts4j/#/QuickStart) and
the [JavaDoc](https://javadoc.jitpack.io/com/github/koooooo-7/echarts4j/echarts4j-project/main-SNAPSHOT/javadoc/index.html)
, and the test cases also.
---
### π Usage
> Basic Chart
Code
```
final String chartTitle = "My First echarts4j Bar";
final String legendFormatter = "'Top: {name}'";
final String seriesName = "Cole";
final String seriesName2 = "Peps";
try {
Canvas.builder()
.addCharts(BarChart.builder()
.options(ChartOption.builder()
.title(Title.builder()
.text(chartTitle).build())
.legend(Legend.builder()
.formatter(FuncStr.of(legendFormatter)).build())
.toolbox(Toolbox.builder()
.showTitle(true)
.feature(Toolbox.Feature.builder()
.saveAsImage(Toolbox.SaveAsImage.builder().build())
.restore(Toolbox.Restore.builder().build())
.dataView(Toolbox.DataView.builder().build())
.build())
.build())
.xAxis(XAxis.builder()
.data(x)
.build())
.yAxis(YAxis.builder().build())
.build()
.addSeries(BarChartSeries.builder()
.name(seriesName)
.data(data1)
.markLine(MarkLine.builder()
.data(Arrays.asList(MarkLine.MarkLineDataItem.builder()
.name("The Max")
.type("max")
.build(),
MarkLine.MarkLineDataItem.builder()
.name("The Min")
.type("min")
.build()))
.build())
.build())
.addSeries(BarChartSeries.builder()
.name(seriesName2)
.data(data2)
.build())
)
.build())
.build()
.renderTo(new File("bar.html"));
```
---
> Overlap Charts
Code
```
final String chartTitle = "My Overlap Charts";
final String seriesName = "seriesName";
final String seriesName2 = "seriesName2";
final LineChart c = LineChart.builder()
.options(ChartOption.builder()
.title(Title.builder()
.text(chartTitle).build())
.legend(Legend.builder().build())
.xAxis(XAxis.builder()
.data(x)
.build())
.yAxis(YAxis.builder().build())
.build()
.addSeries(ListChartSeries.builder()
.name(seriesName)
.data(data1)
.build())
.addSeries(BarChartSeries.builder()
.name(seriesName2)
.data(data2)
.build())
)
.build();
final Canvas cvs = Canvas.builder()
.addCharts(c)
.build();
final Render render = RenderProvider.get();
render.render(cvs, new FileWriter("overlap.html"));
}
```
---
> Dynamic Chart with Event and Action.
Code
```
final String chartTitle = "Dynamic Pie";
final String seriesName = "Access Source";
final List legendData = Arrays.asList(
"Direct Access",
"Email Marketing",
"Affiliate Ads",
"Video Ads",
"Search Engines"
);
final DataHelper dataHelper = DataHelper.create()
.addValueField(Integer.class)
.addNameField()
.build()
.addData(335, "Direct Access")
.addData(310, "Email Marketing")
.addData(234, "Affiliate Ads")
.addData(135, "Video Ads")
.addData(1548, "Search Engines");
final List center = Arrays.asList("50%", "60%");
final PieChart p = PieChart.builder()
.options(ChartOption.builder()
.animation(false)
.title(Title.builder()
.text(chartTitle)
.right("20")
.build())
.legend(Legend.builder()
.orient("vertical")
.left("left")
.data(legendData)
.build())
.build()
.addSeries(PieChartSeries.builder()
.name(seriesName)
.radius("55%")
.center(center)
.data(dataHelper.get())
.build())
)
.build()
.addJSFunction(FuncStr.of(actionWithEchartsInstance))
.addListener("'click'", FuncStr.of(clickAlterFunc))
.addListener("'legendselectchanged'", FuncStr.of(legendClickAlterFunc))
.addListener("'mousemove'", FuncStr.of("{ dataIndex: 3 }"), FuncStr.of(mouseMoveAlterFunc));
Canvas.builder()
.addCharts(p)
.build()
.renderTo(new File("dynamic-pie.html"));
```
---
### π Contribution
- New feature and bug fix are both great.
- Issue driven or PR driven is better.
- Options enrichment is highly welcome.
---
### π Special Thanks
Gratitude to all outstanding projects/libraries for their contributions in echarts4j.
### π License
Apache-2.0 license [Β©KoyZhuang](https://github.com/Koooooo-7/echarts4j/blob/main/LICENSE)