This repository has been archived by the owner on Aug 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 330
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,12 @@ | ||
| go-chart | ||
| ======== | ||
| [](https://github.com/wcharczuk/go-chart/actions/workflows/ci.yml) [](https://goreportcard.com/report/github.com/wcharczuk/go-chart) | ||
|
|
||
| Package `chart` is a very simple golang native charting library that supports timeseries and continuous line charts. | ||
| This project is archived! | ||
|
|
||
| Master should now be on the v3.x codebase, which overhauls the api significantly. Per usual, see `examples` for more information. | ||
| I originally released this as a way to publish stock charts in slack bots. It was kind of fun at the time! I never anticipated that it would become heavily used, and as often happens with open source, I have a ton of time commitments elsewhere, and can't reasonbly devote enough time to this project to match the usage. | ||
|
|
||
| # Installation | ||
| There have been a number of forks over time, I'd encourage you all to seek those out, or new charting libraries. | ||
|
|
||
| To install `chart` run the following: | ||
| Best, | ||
|
|
||
| ```bash | ||
| > go get github.com/wcharczuk/go-chart/v2@latest | ||
| ``` | ||
|
|
||
| Most of the components are interchangeable so feel free to crib whatever you want. | ||
|
|
||
| # Output Examples | ||
|
|
||
| Spark Lines: | ||
|
|
||
|  | ||
|
|
||
| Single axis: | ||
|
|
||
|  | ||
|
|
||
| Two axis: | ||
|
|
||
|  | ||
|
|
||
| # Other Chart Types | ||
|
|
||
| Pie Chart: | ||
|
|
||
|  | ||
|
|
||
| The code for this chart can be found in `examples/pie_chart/main.go`. | ||
|
|
||
| Stacked Bar: | ||
|
|
||
|  | ||
|
|
||
| The code for this chart can be found in `examples/stacked_bar/main.go`. | ||
|
|
||
| # Code Examples | ||
|
|
||
| Actual chart configurations and examples can be found in the `./examples/` directory. They are simple CLI programs that write to `output.png` (they are also updated with `go generate`. | ||
|
|
||
| # Usage | ||
|
|
||
| Everything starts with the `chart.Chart` object. The bare minimum to draw a chart would be the following: | ||
|
|
||
| ```golang | ||
|
|
||
| import ( | ||
| ... | ||
| "bytes" | ||
| ... | ||
| "github.com/wcharczuk/go-chart/v2" //exposes "chart" | ||
| ) | ||
|
|
||
| graph := chart.Chart{ | ||
| Series: []chart.Series{ | ||
| chart.ContinuousSeries{ | ||
| XValues: []float64{1.0, 2.0, 3.0, 4.0}, | ||
| YValues: []float64{1.0, 2.0, 3.0, 4.0}, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| buffer := bytes.NewBuffer([]byte{}) | ||
| err := graph.Render(chart.PNG, buffer) | ||
| ``` | ||
|
|
||
| Explanation of the above: A `chart` can have many `Series`, a `Series` is a collection of things that need to be drawn according to the X range and the Y range(s). | ||
|
|
||
| Here, we have a single series with x range values as float64s, rendered to a PNG. Note; we can pass any type of `io.Writer` into `Render(...)`, meaning that we can render the chart to a file or a resonse or anything else that implements `io.Writer`. | ||
|
|
||
| # API Overview | ||
|
|
||
| Everything on the `chart.Chart` object has defaults that can be overriden. Whenever a developer sets a property on the chart object, it is to be assumed that value will be used instead of the default. | ||
|
|
||
| The best way to see the api in action is to look at the examples in the `./_examples/` directory. | ||
|
|
||
| # Design Philosophy | ||
|
|
||
| I wanted to make a charting library that used only native golang, that could be stood up on a server (i.e. it had built in fonts). | ||
|
|
||
| The goal with the API itself is to have the "zero value be useful", and to require the user to not code more than they absolutely needed. | ||
|
|
||
| # Contributions | ||
|
|
||
| Contributions are welcome though this library is in a holding pattern for the forseable future. | ||
| - Will |