com.googlecode.charts4j
Class AbstractAxisChart

java.lang.Object
  extended by com.googlecode.charts4j.AbstractGraphChart
      extended by com.googlecode.charts4j.AbstractAxisChart
All Implemented Interfaces:
GChart, GraphChart, GridChart, TitledChart
Direct Known Subclasses:
AbstractMarkableChart, BarChart

public abstract class AbstractAxisChart
extends AbstractGraphChart
implements GridChart

Abstract type that is common to all charts with axes.

Author:
Julien Chastang (julien.c.chastang at gmail dot com)

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.googlecode.charts4j.TitledChart
TitledChart.ChartTitle
 
Method Summary
 void addRightAxisLabels(AxisLabels axisLabels)
          Add Right axis information.
 void addTopAxisLabels(AxisLabels axisLabels)
          Add Top axis information.
 void addXAxisLabels(AxisLabels axisLabels)
          Add X axis labels.
 void addYAxisLabels(AxisLabels axisLabels)
          Add Y axis information.
 void setBackgroundFill(Fill fill)
          Specify background fill.
 void setDataEncoding(DataEncoding dataEncoding)
          Set the data encoding scheme.
 void setGrid(double xAxisStepSize, double yAxisStepSize, int lengthOfLineSegment, int lengthOfBlankSegment)
          Define a grid for this chart.
 void setSize(int width, int height)
          Set the chart size.
 void setTransparency(int opacity)
          Specify the chart transparency.
 String toURLForHTML()
          Create a URL with the ampersand character entity reference (&) in place of an ampersand.
 String toURLString()
          Create a URL string given the information supplied to this chart.
 
Methods inherited from class com.googlecode.charts4j.AbstractGraphChart
setAreaFill, setLegendPosition, setTitle, setTitle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addXAxisLabels

public final void addXAxisLabels(AxisLabels axisLabels)
Add X axis labels.

Parameters:
axisLabels - x axis labels. Cannot be null. axisLabels parameter is defensively copied.
See Also:
AxisLabelsFactory

addYAxisLabels

public final void addYAxisLabels(AxisLabels axisLabels)
Add Y axis information.

Parameters:
axisLabels - y axis information. Cannot be null. axisLabel parameter is defensively copied.
See Also:
AxisLabelsFactory

addTopAxisLabels

public final void addTopAxisLabels(AxisLabels axisLabels)
Add Top axis information.

Parameters:
axisLabels - top axis information. Cannot be null. axisLabel parameter is defensively copied.
See Also:
AxisLabelsFactory

addRightAxisLabels

public final void addRightAxisLabels(AxisLabels axisLabels)
Add Right axis information.

Parameters:
axisLabels - right axis information. Cannot be null. axisLabels parameter is defensively copied.
See Also:
AxisLabelsFactory

setGrid

public final void setGrid(double xAxisStepSize,
                          double yAxisStepSize,
                          int lengthOfLineSegment,
                          int lengthOfBlankSegment)
Define a grid for this chart.

Specified by:
setGrid in interface GridChart
Parameters:
xAxisStepSize - x step size. must be > 0.
yAxisStepSize - y step size. must be > 0.
lengthOfLineSegment - length of line segment. must be >= 0.
lengthOfBlankSegment - length of blank segment. must be >= 0.

setSize

public void setSize(int width,
                    int height)
Set the chart size. If no size is specified, the chart will default to 200x125.

Specified by:
setSize in interface GChart
Parameters:
width - chart width. Must be > 0 and <= 1000.
height - chart height. Must be > 0 and <= 1000.
See Also:
Chart Size

toURLString

public final String toURLString()
Create a URL string given the information supplied to this chart. You can copy and paste this string into your web browser, and see if you get the results you anticipated. Better yet, incorporate this method call or GChart.toURLForHTML() into your Internet application to dynamically generate charts. URLs beyond 2000 characters are not recommended. You can sometimes get away with the simple encoding scheme if URL length is a problem. See GChart.setDataEncoding(DataEncoding dataEncoding)

Specified by:
toURLString in interface GChart
Returns:
URL String
See Also:
DataEncoding, WWW FAQs: What is the maximum length of a URL?

toURLForHTML

public final String toURLForHTML()
Create a URL with the ampersand character entity reference (&amp;) in place of an ampersand. Useful for embedding your link in a web page.

Specified by:
toURLForHTML in interface GChart
Returns:
URL string

setBackgroundFill

public void setBackgroundFill(Fill fill)
Specify background fill.

Specified by:
setBackgroundFill in interface GChart
Parameters:
fill - Background fill. Cannot be null.
See Also:
Fill

setTransparency

public void setTransparency(int opacity)
Specify the chart transparency. Use cautiously as this feature may obscure background fills. Also there appears to be a bug in the Google Chart API where setting a transparency makes the label color disappear.

Specified by:
setTransparency in interface GChart
Parameters:
opacity - Supply a number between 0 and 100. 0 is completely transparent, and 100 is completely opaque.

setDataEncoding

public final void setDataEncoding(DataEncoding dataEncoding)
Set the data encoding scheme. The only advantage to the simple encoding scheme is it will ultimately result in shorter URLs, but at the cost of lower resolution. charts4j defaults to the extended encoding, but if you have lots of data and if you are willing to sacrifice resolution, the simple encoding may be right for you.

Specified by:
setDataEncoding in interface GChart
Parameters:
dataEncoding - Supply the data encoding, either simple or extended. Cannot be null.