org.pentaho.plugin.jfreereport.reportcharts

Class XYBarChartExpression

java.lang.Object

org.pentaho.reporting.engine.classic.core.function.AbstractExpression

org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression

org.pentaho.plugin.jfreereport.reportcharts.XYChartExpression

org.pentaho.plugin.jfreereport.reportcharts.XYBarChartExpression

All Implemented Interfaces:

Serializable, Cloneable, ChartExpression, org.pentaho.reporting.engine.classic.core.function.Expression, org.pentaho.reporting.engine.classic.core.LegacyUpdateHandler

public class XYBarChartExpression
extends XYChartExpression

Author:

gmoran

See Also:

Serialized Form

Field Summary

Fields inherited from class org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression

LINE_STYLE_DASH_STR, LINE_STYLE_DASHDOT_STR, LINE_STYLE_DASHDOTDOT_STR, LINE_STYLE_DOT_STR, LINE_STYLE_SOLID_STR

Constructor Summary

Constructors

Constructor and Description
XYBarChartExpression()

Method Summary

Modifier and Type	Method and Description
static org.jfree.chart.JFreeChart	createXYBarChart(String title, String xAxisLabel, boolean dateAxis, String yAxisLabel, org.jfree.data.xy.XYDataset dataset, org.jfree.chart.plot.PlotOrientation orientation, boolean legend, boolean tooltips, boolean urls) Creates and returns a default instance of an XY bar chart.
Double	getMargin()
int	getShadowXOffset()
int	getShadowYOffset()
boolean	isDrawBarOutline() Deprecated. This maps directly to chartSectionOutline
boolean	isRenderPercentages()
boolean	isShadowVisible()
void	setDrawBarOutline(boolean value) Deprecated. This maps directly to chartSectionOutline
void	setMargin(Double margin)
void	setRenderPercentages(boolean renderPercentages)
void	setShadowVisible(boolean shadowVisible)
void	setShadowXOffset(int shadowXOffset)
void	setShadowYOffset(int shadowYOffset)

Methods inherited from class org.pentaho.plugin.jfreereport.reportcharts.XYChartExpression

addSubTitle, getBorderPaint, getChart, getDomainMaximum, getDomainMinimum, getDomainPeriodCount, getDomainTickFont, getDomainTickFormat, getDomainTickFormatString, getDomainTimePeriod, getDomainTitle, getDomainTitleFont, getInstance, getPlotBackgroundColor, getPlotBackgroundPaint, getRangeMaximum, getRangeMinimum, getRangePeriodCount, getRangeTickFont, getRangeTickFormat, getRangeTickFormatString, getRangeTimePeriod, getRangeTitle, getRangeTitleFont, getSubtitles, getTitlePosition, getTitlePositionText, isBorderVisible, isDisplayLabels, isDomainAxisAutoRange, isDomainIncludesZero, isDomainStickyZero, isDomainVerticalTickLabels, isHorizontal, isHumanReadableLogarithmicFormat, isLogarithmicAxis, isRangeAxisAutoRange, isRangeIncludesZero, isRangeStickyZero, isStacked, reconfigureForCompatibility, setBorderPaint, setBorderVisible, setDomainAxisAutoRange, setDomainIncludesZero, setDomainMaximum, setDomainMinimum, setDomainPeriodCount, setDomainStickyZero, setDomainTickFont, setDomainTickFormat, setDomainTickFormatString, setDomainTimePeriod, setDomainTitle, setDomainTitleFont, setDomainVerticalTickLabels, setHorizontal, setHumanReadableLogarithmicFormat, setLogarithmicAxis, setPlotBackgroundColor, setPlotBackgroundPaint, setRangeAxisAutoRange, setRangeIncludesZero, setRangeMaximum, setRangeMinimum, setRangePeriodCount, setRangeStickyZero, setRangeTickFont, setRangeTickFormat, setRangeTickFormatString, setRangeTimePeriod, setRangeTitle, setRangeTitleFont, setStacked, setTitlePosition, setTitlePositionText

Methods inherited from class org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression

getBackgroundColor, getBackgroundImage, getBorderColor, getChartDirectory, getChartFile, getChartFromCache, getChartHeight, getChartUrlMask, getChartWidth, getDataSource, getDependencyLevel, getItemLabelFont, getItemsLabelVisible, getLabelFont, getLegendBackgroundColor, getLegendFont, getLegendLocation, getLegendTextColor, getNoDataMessage, getPlotBackgroundAlpha, getPlotForegroundAlpha, getPossibleExpressionStringValue, getPostProcessingLanguage, getPostProcessingScript, getSeriesColor, getSeriesColor, getSeriesColorCount, getSeriesColors, getTitle, getTitleField, getTitleFont, getTitleText, getTooltipFormula, getUrlFormula, getValue, isAntiAlias, isChartSectionOutline, isDrawLegendBorder, isReturnFileNameOnly, isReturnImageReference, isShowBorder, isShowLegend, isThreeD, isUseDrawable, putChartInCache, setAntiAlias, setBackgroundColor, setBackgroundImage, setBorderColor, setChartDirectory, setChartFile, setChartHeight, setChartSectionOutline, setChartUrlMask, setChartWidth, setDataSource, setDependencyLevel, setDrawLegendBorder, setItemLabelFont, setItemsLabelVisible, setLabelFont, setLegendBackgroundColor, setLegendFont, setLegendLocation, setLegendTextColor, setNoDataMessage, setPlotBackgroundAlpha, setPlotForegroundAlpha, setPostProcessingLanguage, setPostProcessingScript, setReturnFileNameOnly, setReturnImageReference, setSeriesColor, setSeriesColor, setShowBorder, setShowLegend, setThreeD, setTitle, setTitleField, setTitleFont, setTitleText, setTooltipFormula, setUrlFormula, setUseDrawable, translateLineStyle

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setName, setPreserve, setRuntime

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression

clone, getDataRow, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setName, setRuntime

Constructor Detail

XYBarChartExpression

public XYBarChartExpression()

Method Detail

isShadowVisible

public boolean isShadowVisible()

setShadowVisible

public void setShadowVisible(boolean shadowVisible)

getShadowXOffset

public int getShadowXOffset()

setShadowXOffset

public void setShadowXOffset(int shadowXOffset)

getShadowYOffset

public int getShadowYOffset()

setShadowYOffset

public void setShadowYOffset(int shadowYOffset)

getMargin

public Double getMargin()

setMargin

public void setMargin(Double margin)

isRenderPercentages

public boolean isRenderPercentages()

setRenderPercentages

public void setRenderPercentages(boolean renderPercentages)

createXYBarChart

public static org.jfree.chart.JFreeChart createXYBarChart(String title,
                                                          String xAxisLabel,
                                                          boolean dateAxis,
                                                          String yAxisLabel,
                                                          org.jfree.data.xy.XYDataset dataset,
                                                          org.jfree.chart.plot.PlotOrientation orientation,
                                                          boolean legend,
                                                          boolean tooltips,
                                                          boolean urls)

Creates and returns a default instance of an XY bar chart.

The chart object returned by this method uses an XYPlot instance as the plot, with a DateAxis for the domain axis, a NumberAxis as the range axis, and a XYBarRenderer as the renderer.

Parameters:

title - the chart title (null permitted).

xAxisLabel - a label for the X-axis (null permitted).

dateAxis - make the domain axis display dates?

yAxisLabel - a label for the Y-axis (null permitted).

dataset - the dataset for the chart (null permitted).

orientation - the orientation (horizontal or vertical) (null NOT permitted).

legend - a flag specifying whether or not a legend is required.

tooltips - configure chart to generate tool tips?

urls - configure chart to generate URLs?

Returns:

An XY bar chart.

isDrawBarOutline

public boolean isDrawBarOutline()

Deprecated. This maps directly to chartSectionOutline

Returns:

setDrawBarOutline

public void setDrawBarOutline(boolean value)

Deprecated. This maps directly to chartSectionOutline