Package net.sf.jasperreports.charts

Interface JRChartPlot

All Superinterfaces:

Cloneable, JRCloneable

All Known Subinterfaces:

JRAreaPlot, JRBar3DPlot, JRBarPlot, JRBubblePlot, JRCandlestickPlot, JRCategoryPlot, JRHighLowPlot, JRLinePlot, JRMeterPlot, JRMultiAxisPlot, JRPie3DPlot, JRPiePlot, JRScatterPlot, JRThermometerPlot, JRTimeSeriesPlot

All Known Implementing Classes:

JRBaseAreaPlot, JRBaseBar3DPlot, JRBaseBarPlot, JRBaseBubblePlot, JRBaseCandlestickPlot, JRBaseChartPlot, JRBaseHighLowPlot, JRBaseLinePlot, JRBaseMeterPlot, JRBaseMultiAxisPlot, JRBasePie3DPlot, JRBasePiePlot, JRBaseScatterPlot, JRBaseThermometerPlot, JRBaseTimeSeriesPlot, JRDesignAreaPlot, JRDesignBar3DPlot, JRDesignBarPlot, JRDesignBubblePlot, JRDesignCandlestickPlot, JRDesignHighLowPlot, JRDesignLinePlot, JRDesignMeterPlot, JRDesignMultiAxisPlot, JRDesignPie3DPlot, JRDesignPiePlot, JRDesignScatterPlot, JRDesignThermometerPlot, JRDesignTimeSeriesPlot, JRFillAreaPlot, JRFillBar3DPlot, JRFillBarPlot, JRFillBubblePlot, JRFillCandlestickPlot, JRFillChartPlot, JRFillHighLowPlot, JRFillLinePlot, JRFillMeterPlot, JRFillMultiAxisPlot, JRFillPie3DPlot, JRFillPiePlot, JRFillScatterPlot, JRFillThermometerPlot, JRFillTimeSeriesPlot

public interface JRChartPlot
extends JRCloneable

Chart plots define chart appearance and display details such as colors, legend or labels. Each plot may have different characteristics, depending on the chart type it belongs to. This is the superinterface for all plots and contains common properties.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JRChartPlot.JRSeriesColor

Method Summary

Modifier and Type	Method	Description
void	addSeriesColor(JRChartPlot.JRSeriesColor seriesColor)	Adds the specified series color to the plot.
void	clearSeriesColors()	Removes all defined series colors.
Object	clone(JRChart parentChart)
void	collectExpressions(ChartsExpressionCollector collector)
Color	getBackcolor()	Gets the chart background color.
Float	getBackgroundAlpha()	Gets the transparency factor for this plot background.
JRChart	getChart()	Gets the chart associated with this chart plot, if available.
Float	getForegroundAlpha()	Gets the transparency factor for this plot foreground.
Double	getLabelRotation()	Deprecated. Replaced by JRCategoryAxisFormat.getCategoryAxisTickLabelRotation().
PlotOrientationEnum	getOrientation()	Gets the plot orientation (horizontal or vertical).
Color	getOwnBackcolor()
SortedSet<JRChartPlot.JRSeriesColor>	getSeriesColors()	Returns a list of all the defined series colors.
void	setBackcolor(Color backcolor)	Sets the chart background color.
void	setBackgroundAlpha(Float backgroundAlpha)	Sets the transparency factor for this plot background.
void	setForegroundAlpha(Float foregroundAlpha)	Sets the transparency factor for this plot foreground.
void	setLabelRotation(Double labelRotation)	Deprecated. Replaced by JRCategoryAxisFormat.setCategoryAxisTickLabelRotation(Double).
void	setOrientation(PlotOrientationEnum orientation)	Sets the plot orientation (horizontal or vertical).
void	setSeriesColors(Collection<JRChartPlot.JRSeriesColor> colors)	Set the list of series colors.

Methods inherited from interface net.sf.jasperreports.engine.JRCloneable

clone

Method Detail

getChart

JRChart getChart()

Gets the chart associated with this chart plot, if available. Implementations can return null on this method, especially if the chart plot is reused by multiple charts, which is not recommended since it prevents style properties inheritence from parent chart.

getBackcolor

Color getBackcolor()

Gets the chart background color.

getOwnBackcolor

Color getOwnBackcolor()

setBackcolor

void setBackcolor(Color backcolor)

Sets the chart background color.

getOrientation

PlotOrientationEnum getOrientation()

Gets the plot orientation (horizontal or vertical).

setOrientation

void setOrientation(PlotOrientationEnum orientation)

Sets the plot orientation (horizontal or vertical).

getBackgroundAlpha

Float getBackgroundAlpha()

Gets the transparency factor for this plot background. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

Returns:

a float value between 0 and 1.

setBackgroundAlpha

void setBackgroundAlpha(Float backgroundAlpha)

Sets the transparency factor for this plot background. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

getForegroundAlpha

Float getForegroundAlpha()

Gets the transparency factor for this plot foreground. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

Returns:

a float value between 0 and 1.

setForegroundAlpha

void setForegroundAlpha(Float foregroundAlpha)

Sets the transparency factor for this plot foreground. The range is from 0 to 1, where 0 means transparent and 1 opaque. The default is 1.

getLabelRotation

Double getLabelRotation()

Deprecated.

Replaced by JRCategoryAxisFormat.getCategoryAxisTickLabelRotation().

Gets the angle in degrees to rotate the data axis labels. The range is -360 to 360. A positive value angles the label so it reads downwards wile a negative value angles the label so it reads upwards. Only charts that use a category based axis (such as line or bar charts) support label rotation.

setLabelRotation

void setLabelRotation(Double labelRotation)

Deprecated.

Replaced by JRCategoryAxisFormat.setCategoryAxisTickLabelRotation(Double).

Sets the angle in degrees to rotate the data axis labels. The range is -360 to 360. A positive value angles the label so it reads downwards wile a negative value angles the label so it reads upwards. Only charts that use a category based axis (such as line or bar charts) support label rotation.

getSeriesColors

SortedSet<JRChartPlot.JRSeriesColor> getSeriesColors()

Returns a list of all the defined series colors. Every entry in the list is of type JRChartPlot.JRSeriesColor. If there are no defined series colors this method will return an empty list, not null.

clearSeriesColors

void clearSeriesColors()

Removes all defined series colors.

addSeriesColor

void addSeriesColor(JRChartPlot.JRSeriesColor seriesColor)

Adds the specified series color to the plot.

setSeriesColors

void setSeriesColors(Collection<JRChartPlot.JRSeriesColor> colors)

Set the list of series colors.

Parameters:

colors - the list of series colors (JRChartPlot.JRSeriesColor instances}

collectExpressions

void collectExpressions(ChartsExpressionCollector collector)

clone

Object clone(JRChart parentChart)