Scala Chart Library
Clone or download
Latest commit b24f737 Apr 22, 2018

README.md

Scala Chart Library

Build Status Maven Central Scaladoc Reference Status

scala-chart is a Scala library for creating and working with charts. It wraps JFreeChart, much like scala-swing does with the original javax.swing package. This project is released under the same license as JFreeChart to make them fully license-compatible. Checkout the API by clicking on the scaladoc badge above.

Usage

Add the following to your sbt build:

libraryDependencies += "com.github.wookietreiber" %% "scala-chart" % "latest.integration"

In case exporting to PDF is required, also add iText to your dependencies:

libraryDependencies += "com.itextpdf" % "itextpdf" % "5.5.6"

In case exporting to SVG is required, also add JFreeSVG to your dependencies:

libraryDependencies += "org.jfree" % "jfreesvg" % "3.0"

Imports

All high-level convenience can be imported with the all you can eat import:

import scalax.chart.api._

For more and more a la carte imports, have a look at the module package for various selfless traits. There is also a module containing everything the api import does which can be used in applications directly:

object MyChartApp extends App with scalax.chart.module.Charting {
  val data = for (i <- 1 to 5) yield (i,i)
  val chart = XYLineChart(data)
  chart.saveAsPNG("/tmp/chart.png")
}

Creating Charts

Creating charts is as simple as using one of the many chart factories, which differ from the JFreeChart ones in the aspect, that they make heavy use of default arguments, so you have to type as less as possible:

val data = for (i <- 1 to 5) yield (i,i)
val chart = XYLineChart(data)

The first argument is always the dataset which is the only required argument. For better readability of your own code, you should name the other arguments:

val chart = XYLineChart(data, title = "My Chart of Some Points")

There are also some enrichments for the charts themselves to display them in a window or save them to disk:

chart.show()
chart.saveAsPNG("/tmp/chart.png")
chart.saveAsJPEG("/tmp/chart.jpg")
chart.saveAsPDF("/tmp/chart.pdf")
chart.saveAsSVG("/tmp/chart.svg")

Animations / Live Chart Updates

You can also do some animations, i.e. perform live updates on your datasets:

val series = new XYSeries("f(x) = sin(x)")
val chart = XYLineChart(series)
chart.show()
for (x <- -4.0 to 4 by 0.1) {
  swing.Swing onEDT {
    series.add(x,math.sin(x))
  }
  Thread.sleep(50)
}