Go to file
Will Charczuk fc2973067c fixing y-axis label position 2016-10-27 10:40:27 -07:00
_examples Merge pull request #13 from wcharczuk/text-rotation 2016-10-21 12:53:01 -07:00
_images can rotate text + add y axis names 2016-08-06 21:59:46 -07:00
drawing can rotate text + add y axis names 2016-08-06 21:59:46 -07:00
.gitignore adding ignores. 2016-10-23 12:10:06 -07:00
.travis.yml travis. 2016-07-28 14:32:23 -07:00
LICENSE license and readme. 2016-07-07 20:37:57 -07:00
Makefile testing histogram series. 2016-07-28 16:36:30 -07:00
README.md readme updates. 2016-08-07 11:05:57 -07:00
annotation_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
annotation_series_test.go need to flesh out this test more. 2016-07-28 14:30:00 -07:00
axis.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
bar_chart.go tests. 2016-08-05 21:25:56 -07:00
bar_chart_test.go hit coverage min, but not quite done yet. 2016-08-06 00:26:17 -07:00
bollinger_band_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
bollinger_band_series_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
box.go text rotation works, ish. 2016-10-21 12:44:37 -07:00
box_test.go text rotation works, ish. 2016-10-21 12:44:37 -07:00
chart.go text rotation works, ish. 2016-10-21 12:44:37 -07:00
chart_test.go hit coverage min, but not quite done yet. 2016-08-06 00:26:17 -07:00
concat_series.go introduces the `Range` interface (instead of a concrete type). 2016-07-21 14:11:27 -07:00
concat_series_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
continuous_range.go introduces the `Range` interface (instead of a concrete type). 2016-07-21 14:11:27 -07:00
continuous_range_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
continuous_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
continuous_series_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
date.go market hours tweaks. 2016-08-01 00:50:32 -07:00
date_test.go hit coverage min, but not quite done yet. 2016-08-06 00:26:17 -07:00
defaults.go tests 2016-08-05 20:08:24 -07:00
draw.go text rotation works, ish. 2016-10-21 12:44:37 -07:00
ema_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
ema_series_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
file_util.go missing files. 2016-10-21 12:44:44 -07:00
grid_line.go changing gridline behavior. 2016-08-11 20:42:25 -07:00
grid_line_test.go fixing build. 2016-08-11 22:24:40 -07:00
histogram_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
histogram_series_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
image_writer.go comment. 2016-10-21 17:01:02 -07:00
last_value_annotation_series.go last annotation helper 2016-08-06 15:53:14 -07:00
legend.go Merge pull request #13 from wcharczuk/text-rotation 2016-10-21 12:53:01 -07:00
legend_test.go hit coverage min, but not quite done yet. 2016-08-06 00:26:17 -07:00
linear_regression_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
linear_regression_series_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
macd_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
macd_series_test.go fixing macd inversion. 2016-07-18 17:41:59 -07:00
market_hours_range.go finalizing work on text rotation. 2016-10-20 15:21:52 -07:00
market_hours_range_test.go finalizing work on text rotation. 2016-10-20 15:21:52 -07:00
math_util.go text rotation works, ish. 2016-10-21 12:44:37 -07:00
math_util_test.go finalizing work on text rotation. 2016-10-20 15:21:52 -07:00
min_max_series.go last annotation helper 2016-08-06 15:53:14 -07:00
pie_chart.go tweaks. 2016-07-29 18:40:43 -07:00
pie_chart_test.go need to flesh out this test more. 2016-07-28 14:30:00 -07:00
range.go introduces the `Range` interface (instead of a concrete type). 2016-07-21 14:11:27 -07:00
raster_renderer.go Merge pull request #13 from wcharczuk/text-rotation 2016-10-21 12:53:01 -07:00
renderable.go api tweaks. 2016-07-14 18:29:06 -07:00
renderer.go text rotation works, ish. 2016-10-21 12:44:37 -07:00
renderer_provider.go snapshot. 2016-07-10 01:11:47 -07:00
ring_buffer.go tests. 2016-07-27 12:34:15 -07:00
ring_buffer_test.go moving averages! dashes! 2016-07-14 09:27:23 -07:00
roboto.go initial commit. 2016-07-06 18:54:00 -07:00
sequence.go bar charts! 2016-08-05 16:55:55 -07:00
sequence_test.go market hours tweaks. 2016-08-01 00:50:32 -07:00
series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
sma_series.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
sma_series_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
stacked_bar_chart.go fixing fit issues on the xaxis labels for stacked bar. 2016-07-30 09:35:44 -07:00
style.go snapshot. 2016-09-05 13:26:12 -07:00
style_test.go text options! 2016-07-29 16:36:29 -07:00
text.go tweaks to make ticks not be terrible 2016-07-31 16:54:09 -07:00
text_test.go big api overhauls. 2016-07-29 18:24:25 -07:00
tick.go bar charts! 2016-08-05 16:55:55 -07:00
tick_test.go need to rewrite this test. 2016-07-30 12:59:59 -07:00
time_series.go finalizing work on text rotation. 2016-10-20 15:21:52 -07:00
time_series_test.go updates 2016-07-09 20:14:11 -07:00
time_util.go finalizing work on text rotation. 2016-10-20 15:21:52 -07:00
value.go big api overhauls. 2016-07-29 18:24:25 -07:00
value_formatter.go coverage goal is 70% by the end of the night. 2016-08-05 20:44:40 -07:00
value_formatter_provider.go mostly works. 2016-07-10 10:43:04 -07:00
value_formatter_test.go finalizing work on text rotation. 2016-10-20 15:21:52 -07:00
value_provider.go bad interface format 2016-07-18 15:44:22 -07:00
value_test.go test updates. 2016-07-28 18:56:45 -07:00
vector_renderer.go text rotation works, ish. 2016-10-21 12:44:37 -07:00
vector_renderer_test.go text options! 2016-07-29 16:36:29 -07:00
xaxis.go works, ish. 2016-10-21 12:50:40 -07:00
xaxis_test.go fixing tests. 2016-07-30 20:20:59 -07:00
yaxis.go fixing y-axis label position 2016-10-27 10:40:27 -07:00
yaxis_test.go fixing tests. 2016-07-30 20:20:59 -07:00

README.md

go-chart

Build StatusGo Report Card

Package chart is a very simple golang native charting library that supports timeseries and continuous line charts.

The v1.0 release has been tagged so things should be more or less stable, if something changes please log an issue.

Master should now be on the v2.x codebase, which brings a couple new features and better handling of basics like axes labeling etc. Per usual, see _examples for more information.

Installation

To install chart run the following:

> go get -u github.com/wcharczuk/go-chart

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 web servers, so start them with go run main.go then access http://localhost:8080 to see the output.

Usage

Everything starts with the chart.Chart object. The bare minimum to draw a chart would be the following:


import (
    ...
    "bytes"
    ...
    "github.com/wcharczuk/go-chart" //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. One complication here is any object's root chart.Style object (i.e named Style) and the Show property specifically, if any other property is set and the Show property is unset, it is assumed to be it's default value of False.

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

This library is super early but contributions are welcome.