com.googlecode.charts4j
Class AbstractMarkableChart

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

public abstract class AbstractMarkableChart
extends AbstractAxisChart

Abstract type that represents all charts that support Markers.

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 addHorizontalRangeMarker(double startPoint, double endPoint, Color color)
          Add a horizontal range marker.
 void addVerticalRangeMarker(double startPoint, double endPoint, Color color)
          Add a vertical range marker.
 void setBackgroundFill(Fill fill)
          Specify background fill.
 void setDataEncoding(DataEncoding dataEncoding)
          Set the data encoding scheme.
 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.AbstractAxisChart
addRightAxisLabels, addTopAxisLabels, addXAxisLabels, addYAxisLabels, setGrid
 
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

addVerticalRangeMarker

public final void addVerticalRangeMarker(double startPoint,
                                         double endPoint,
                                         Color color)
Add a vertical range marker.

Parameters:
startPoint - the position on the x-axis at which the range starts where 0 is leftmost and 100 rightmost.
endPoint - the position on the x-axis at which the range starts where 0 is leftmost and 100 rightmost.
color - color of range marker.

addHorizontalRangeMarker

public final void addHorizontalRangeMarker(double startPoint,
                                           double endPoint,
                                           Color color)
Add a horizontal range marker.

Parameters:
startPoint - the position on the y-axis at which the range starts where 0 is the bottom and 100 is the top.
endPoint - the position on the y-axis at which the range ends where 0 is the bottom and 100 is the top.
color - color of range marker. Cannot be null.

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.