net.sf.jasperreports.engine
Interface JRChart

All Superinterfaces:
JRAnchor, JRChild, JRElement, JRHyperlink
All Known Implementing Classes:
JRBaseChart, JRDesignChart, JRFillChart

public interface JRChart
extends JRElement, JRAnchor, JRHyperlink

Implementations of this interface can be used for rendering chart components. Data obtained from the report datasource can be also displayed in a chart, embedded in the report. There are a lot of chart types, each with its own dataset and characteristics. This interface only defines the common properties.

Version:
$Id: JRChart.java,v 1.9 2005/08/23 14:24:45 ionutned Exp $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Field Summary
static byte CHART_TYPE_AREA
           
static byte CHART_TYPE_BAR
           
static byte CHART_TYPE_BAR3D
           
static byte CHART_TYPE_BUBBLE
           
static byte CHART_TYPE_CANDLESTICK
           
static byte CHART_TYPE_HIGHLOW
           
static byte CHART_TYPE_LINE
           
static byte CHART_TYPE_PIE
           
static byte CHART_TYPE_PIE3D
           
static byte CHART_TYPE_SCATTER
           
static byte CHART_TYPE_STACKEDBAR
           
static byte CHART_TYPE_STACKEDBAR3D
           
static byte CHART_TYPE_TIMESERIES
           
static byte CHART_TYPE_XYAREA
           
static byte CHART_TYPE_XYBAR
           
static byte CHART_TYPE_XYLINE
           
static byte TITLE_POSITION_BOTTOM
           
static byte TITLE_POSITION_LEFT
           
static byte TITLE_POSITION_RIGHT
           
static byte TITLE_POSITION_TOP
           
 
Fields inherited from interface net.sf.jasperreports.engine.JRElement
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT
 
Fields inherited from interface net.sf.jasperreports.engine.JRAnchor
NO_BOOKMARK
 
Fields inherited from interface net.sf.jasperreports.engine.JRHyperlink
HYPERLINK_TARGET_BLANK, HYPERLINK_TARGET_SELF, HYPERLINK_TYPE_LOCAL_ANCHOR, HYPERLINK_TYPE_LOCAL_PAGE, HYPERLINK_TYPE_NONE, HYPERLINK_TYPE_REFERENCE, HYPERLINK_TYPE_REMOTE_ANCHOR, HYPERLINK_TYPE_REMOTE_PAGE
 
Method Summary
 JRBox getBox()
          Gets the box around the element.
 byte getChartType()
          Gets the chart type.
 java.lang.String getCustomizerClass()
          Gets a user specified chart customizer class name.
 JRChartDataset getDataset()
          Gets the chart dataset.
 JRGroup getEvaluationGroup()
          Gets the evaluation group for this chart (only applies when evaluation time is group).
 byte getEvaluationTime()
          Returns the evaluation time for this chart.
 JRChartPlot getPlot()
          Gets the chart plot.
 java.awt.Color getSubtitleColor()
           
 JRExpression getSubtitleExpression()
          Gets the expression whose evaluation will form the subtitle.
 JRFont getSubtitleFont()
           
 java.awt.Color getTitleColor()
           
 JRExpression getTitleExpression()
          Gets the expression whose evaluation will form the title.
 JRFont getTitleFont()
           
 byte getTitlePosition()
          Gets the title position relative to the chart.
 boolean isShowLegend()
           
 void setShowLegend(boolean isShowLegend)
           
 void setSubtitleColor(java.awt.Color subtitleColor)
           
 void setTitleColor(java.awt.Color titleColor)
           
 void setTitlePosition(byte titlePosition)
          Sets the title position relative to the chart.
 
Methods inherited from interface net.sf.jasperreports.engine.JRElement
collectExpressions, getBackcolor, getElementGroup, getForecolor, getHeight, getKey, getMode, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getStretchType, getWidth, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX
 
Methods inherited from interface net.sf.jasperreports.engine.JRChild
getCopy, writeXml
 
Methods inherited from interface net.sf.jasperreports.engine.JRAnchor
getAnchorNameExpression, getBookmarkLevel
 
Methods inherited from interface net.sf.jasperreports.engine.JRHyperlink
getHyperlinkAnchorExpression, getHyperlinkPageExpression, getHyperlinkReferenceExpression, getHyperlinkTarget, getHyperlinkType
 

Field Detail

TITLE_POSITION_TOP

public static final byte TITLE_POSITION_TOP
See Also:
Constant Field Values

TITLE_POSITION_BOTTOM

public static final byte TITLE_POSITION_BOTTOM
See Also:
Constant Field Values

TITLE_POSITION_LEFT

public static final byte TITLE_POSITION_LEFT
See Also:
Constant Field Values

TITLE_POSITION_RIGHT

public static final byte TITLE_POSITION_RIGHT
See Also:
Constant Field Values

CHART_TYPE_AREA

public static final byte CHART_TYPE_AREA
See Also:
Constant Field Values

CHART_TYPE_BAR3D

public static final byte CHART_TYPE_BAR3D
See Also:
Constant Field Values

CHART_TYPE_BAR

public static final byte CHART_TYPE_BAR
See Also:
Constant Field Values

CHART_TYPE_BUBBLE

public static final byte CHART_TYPE_BUBBLE
See Also:
Constant Field Values

CHART_TYPE_CANDLESTICK

public static final byte CHART_TYPE_CANDLESTICK
See Also:
Constant Field Values

CHART_TYPE_HIGHLOW

public static final byte CHART_TYPE_HIGHLOW
See Also:
Constant Field Values

CHART_TYPE_LINE

public static final byte CHART_TYPE_LINE
See Also:
Constant Field Values

CHART_TYPE_PIE3D

public static final byte CHART_TYPE_PIE3D
See Also:
Constant Field Values

CHART_TYPE_PIE

public static final byte CHART_TYPE_PIE
See Also:
Constant Field Values

CHART_TYPE_SCATTER

public static final byte CHART_TYPE_SCATTER
See Also:
Constant Field Values

CHART_TYPE_STACKEDBAR3D

public static final byte CHART_TYPE_STACKEDBAR3D
See Also:
Constant Field Values

CHART_TYPE_STACKEDBAR

public static final byte CHART_TYPE_STACKEDBAR
See Also:
Constant Field Values

CHART_TYPE_XYAREA

public static final byte CHART_TYPE_XYAREA
See Also:
Constant Field Values

CHART_TYPE_XYBAR

public static final byte CHART_TYPE_XYBAR
See Also:
Constant Field Values

CHART_TYPE_XYLINE

public static final byte CHART_TYPE_XYLINE
See Also:
Constant Field Values

CHART_TYPE_TIMESERIES

public static final byte CHART_TYPE_TIMESERIES
See Also:
Constant Field Values
Method Detail

isShowLegend

public boolean isShowLegend()

setShowLegend

public void setShowLegend(boolean isShowLegend)

getEvaluationTime

public byte getEvaluationTime()
Returns the evaluation time for this chart.


getEvaluationGroup

public JRGroup getEvaluationGroup()
Gets the evaluation group for this chart (only applies when evaluation time is group).


getBox

public JRBox getBox()
Gets the box around the element.


getTitleExpression

public JRExpression getTitleExpression()
Gets the expression whose evaluation will form the title.


getTitleFont

public JRFont getTitleFont()

getTitlePosition

public byte getTitlePosition()
Gets the title position relative to the chart.


setTitlePosition

public void setTitlePosition(byte titlePosition)
Sets the title position relative to the chart.


getTitleColor

public java.awt.Color getTitleColor()

setTitleColor

public void setTitleColor(java.awt.Color titleColor)

getSubtitleExpression

public JRExpression getSubtitleExpression()
Gets the expression whose evaluation will form the subtitle.


getSubtitleFont

public JRFont getSubtitleFont()

getSubtitleColor

public java.awt.Color getSubtitleColor()

setSubtitleColor

public void setSubtitleColor(java.awt.Color subtitleColor)

getDataset

public JRChartDataset getDataset()
Gets the chart dataset. Most chart types have different dataset structures, depending on the chart type.


getPlot

public JRChartPlot getPlot()
Gets the chart plot. Plots are used to define various chart visual properties, such as colors and transparency.


getChartType

public byte getChartType()
Gets the chart type. It must be one of the chart type constants in this class.


getCustomizerClass

public java.lang.String getCustomizerClass()
Gets a user specified chart customizer class name.

See Also:
JRChartCustomizer


© 2001-2005 JasperSoft Corporation www.jaspersoft.com