Skip to content
Snippets Groups Projects
README.md 2.53 KiB
Newer Older
Tim Molter's avatar
Tim Molter committed
## XChart
Tim Molter's avatar
Tim Molter committed
A Simple Charting Library for Java

Tim Molter's avatar
Tim Molter committed
## Description
Tim Molter's avatar
Tim Molter committed
XChart is a light-weight and convenient library for plotting data.
timmolter's avatar
timmolter committed

Tim Molter's avatar
Tim Molter committed
Its focus is on simplicity and ease-of-use, requiring only two lines of code to save or display a basic default chart.
Tim Molter's avatar
Tim Molter committed
Usage is very simple: Create a Chart instance, add a series of data to it, and either save it or display it.

Tim Molter's avatar
Tim Molter committed
## Example
Tim Molter's avatar
Tim Molter committed

Tim Molter's avatar
Tim Molter committed
    double[] xData = new double[] { 0.0, 1.0, 2.0 };
    double[] yData = new double[] { 2.0, 1.0, 0.0 };
Tim Molter's avatar
Tim Molter committed
    // Create Chart
    Chart chart = QuickChart.getChart("Sample Chart", "X", "Y", "y(x)", xData, yData);

    // Show it
    new SwingWrapper(chart).displayChart();

    // Save it
    BitmapEncoder.savePNG(chart, "./Sample_Chart.png");
    
Now go ahead and [study some more examples](http://xeiam.com/xchart_examplecode.jsp), [download the thing](http://xeiam.com/xchart_changelog.jsp) and [provide feedback](https://github.com/timmolter/XChart/issues).

Tim Molter's avatar
Tim Molter committed
## Features
Tim Molter's avatar
Tim Molter committed
* No additional dependencies
Tim Molter's avatar
Tim Molter committed
* ~85KB Jar
Tim Molter's avatar
Tim Molter committed
* Line charts
* Scatter charts
Tim Molter's avatar
Tim Molter committed
* Area Charts
* Bar Charts
Tim Molter's avatar
Tim Molter committed
* Error bars
Tim Molter's avatar
Tim Molter committed
* Logarithmic axes
* Date and category X-Axis
Tim Molter's avatar
Tim Molter committed
* Multiple series
* Extensive customization
Tim Molter's avatar
Tim Molter committed
* Themes
* Right-click, Save-As...
* User-defined axes range
* Custom legend placement
timmolter's avatar
timmolter committed

Tim Molter's avatar
Tim Molter committed
## Getting Started
### Non-Maven
Tim Molter's avatar
Tim Molter committed
Download Jar: http://xeiam.com/xchart_changelog.jsp
timmolter's avatar
timmolter committed

Tim Molter's avatar
Tim Molter committed
### Maven
Tim Molter's avatar
Tim Molter committed
The XChart release artifacts are hosted on Maven Central.
Tim Molter's avatar
Tim Molter committed

Tim Molter's avatar
Tim Molter committed
Add the XChart library as a dependency to your pom.xml file:
timmolter's avatar
timmolter committed

timmolter's avatar
timmolter committed
    <dependency>
Tim Molter's avatar
Tim Molter committed
        <groupId>com.xeiam.xchart</groupId>
        <artifactId>xchart</artifactId>
Tim Molter's avatar
Tim Molter committed
        <version>2.1.0</version>
timmolter's avatar
timmolter committed
    </dependency>
Tim Molter's avatar
Tim Molter committed
For snapshots, add the following to your pom.xml file:
Tim Molter's avatar
Tim Molter committed

    <repository>
Tim Molter's avatar
Tim Molter committed
      <id>sonatype-oss-snapshot</id>
Tim Molter's avatar
Tim Molter committed
      <snapshots/>
      <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    </repository>
Tim Molter's avatar
Tim Molter committed
    
    <dependency>
      <groupId>com.xeiam</groupId>
      <artifactId>xchart</artifactId>
Tim Molter's avatar
Tim Molter committed
      <version>2.2.0-SNAPSHOT</version>
Tim Molter's avatar
Tim Molter committed
    </dependency>
Tim Molter's avatar
Tim Molter committed

Tim Molter's avatar
Tim Molter committed
## Building
timmolter's avatar
timmolter committed
mvn clean package  
Tim Molter's avatar
Tim Molter committed
mvn javadoc:aggregate  

## Running Demo
    cd /path/to/xchart-demo/jar/
Tim Molter's avatar
Tim Molter committed
    java -cp xchart-demo-2.1.0.jar:xchart-2.1.0.jar com.xeiam.xchart.demo.XChartDemo
Tim Molter's avatar
Tim Molter committed

Tim Molter's avatar
Tim Molter committed
## Bugs
Please report any bugs or submit feature requests to [XChart's Github issue tracker](https://github.com/timmolter/XChart/issues).  
Tim Molter's avatar
Tim Molter committed

## Continuous Integration Status
[![Build Status](https://travis-ci.org/timmolter/XChart.png?branch=develop)](https://travis-ci.org/timmolter/XChart.png)  
Tim Molter's avatar
Tim Molter committed
[Build History](https://travis-ci.org/timmolter/XChart/builds)  
Tim Molter's avatar
Tim Molter committed

## Donations
17dQktcAmU4urXz7tGk2sbuiCqykm3WLs6