com.mitchtalmadge.asciidata.graph

Class ASCIIGraph

java.lang.Object

com.mitchtalmadge.asciidata.graph.ASCIIGraph

public class ASCIIGraph
extends Object

A two-axis graph created entirely from ASCII characters. Printable to a console, chat server, or anywhere else where text-style graphs are convenient.

Author:

MitchTalmadge, kroitor

Method Summary

Modifier and Type	Method and Description
static ASCIIGraph	fromSeries(double[] series) Creates an ASCIIGraph instance from the given series.
String	plot() Plots the graph and returns it as a String.
ASCIIGraph	withNumRows(int numRows) Determines the number of rows in the graph.
ASCIIGraph	withTickFormat(DecimalFormat tickFormat) Determines how the ticks will be formatted.
ASCIIGraph	withTickWidth(int tickWidth) Determines the minimum width of the ticks on the axis.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromSeries

public static ASCIIGraph fromSeries(double[] series)

Creates an ASCIIGraph instance from the given series.

Parameters:

series - The series of data, where index is the x-axis and value is the y-axis.

Returns:

A new ASCIIGraph instance.

withNumRows

public ASCIIGraph withNumRows(int numRows)

Determines the number of rows in the graph. By default, the number of rows will be equal to the range of the series + 1.

Parameters:

numRows - The number of rows desired. If 0, uses the default.

Returns:

This instance.

withTickWidth

public ASCIIGraph withTickWidth(int tickWidth)

Determines the minimum width of the ticks on the axis. Ticks will be left-padded with spaces if they are not already this length. Defaults to 8.

Parameters:

tickWidth - The width of the ticks on the axis.

Returns:

This instance.

withTickFormat

public ASCIIGraph withTickFormat(DecimalFormat tickFormat)

Determines how the ticks will be formatted. Defaults to "###0.00".

Parameters:

tickFormat - The format of the ticks.

Returns:

This instance.

plot

public String plot()

Plots the graph and returns it as a String.

Returns:

The string representation of the graph, using new lines.