XYChartExpression

java.lang.Object
- org.pentaho.reporting.engine.classic.core.function.AbstractExpression
- - org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression
  - - org.pentaho.plugin.jfreereport.reportcharts.XYChartExpression

All Implemented Interfaces:

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

Direct Known Subclasses:

BubbleChartExpression, ScatterPlotChartExpression, XYBarChartExpression, XYLineChartExpression
```
public abstract class XYChartExpression
extends AbstractChartExpression
implements org.pentaho.reporting.engine.classic.core.LegacyUpdateHandler
```
This class allows you to embed xy charts into JFreeReport XML definitions.

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSubTitle(String subTitle)` Deprecated. Subtitles are not used.
`Paint`	`getBorderPaint()` Deprecated. Is not used anywhere ...
`org.jfree.chart.JFreeChart`	`getChart(org.jfree.data.xy.XYDataset xyDataset)` Deprecated. Not public, no getter
`double`	`getDomainMaximum()` Return the domain axis' maximum value
`double`	`getDomainMinimum()` Return the domain axis' minimum value
`double`	`getDomainPeriodCount()`
`Font`	`getDomainTickFont()` Return the java.awt.Font to be used to display the range axis tick labels
`NumberFormat`	`getDomainTickFormat()`
`String`	`getDomainTickFormatString()`
`Class`	`getDomainTimePeriod()`
`String`	`getDomainTitle()`
`Font`	`getDomainTitleFont()`
`org.pentaho.reporting.engine.classic.core.function.Expression`	`getInstance()` Return a completly separated copy of this function.
`Color`	`getPlotBackgroundColor()`
`Paint`	`getPlotBackgroundPaint()` Deprecated. this property is declared but not used anywhere
`double`	`getRangeMaximum()` Return the range axis' maximum value
`double`	`getRangeMinimum()` Return the range axis' minimum value
`double`	`getRangePeriodCount()`
`Font`	`getRangeTickFont()` Return the java.awt.Font to be used to display the range axis tick labels
`NumberFormat`	`getRangeTickFormat()`
`String`	`getRangeTickFormatString()`
`Class`	`getRangeTimePeriod()`
`String`	`getRangeTitle()`
`Font`	`getRangeTitleFont()`
`List`	`getSubtitles()` Deprecated. Subtitles are not used.
`org.jfree.ui.RectangleEdge`	`getTitlePosition()` Deprecated. Dont use that.
`String`	`getTitlePositionText()`
`boolean`	`isBorderVisible()` Deprecated.
`boolean`	`isDisplayLabels()` Deprecated. Not used anywhere. You might want to use "itemLabelVisible"
`boolean`	`isDomainAxisAutoRange()`
`boolean`	`isDomainIncludesZero()`
`boolean`	`isDomainStickyZero()`
`boolean`	`isDomainVerticalTickLabels()`
`boolean`	`isHorizontal()`
`boolean`	`isHumanReadableLogarithmicFormat()`
`boolean`	`isLogarithmicAxis()`
`boolean`	`isRangeAxisAutoRange()`
`boolean`	`isRangeIncludesZero()`
`boolean`	`isRangeStickyZero()`
`boolean`	`isStacked()`
`void`	`reconfigureForCompatibility(int versionTag)`
`void`	`setBorderPaint(Paint borderPaint)` Deprecated. is not used anywhere
`void`	`setBorderVisible(boolean borderVisible)` Deprecated.
`void`	`setDomainAxisAutoRange(boolean domainAxisAutoRange)`
`void`	`setDomainIncludesZero(boolean domainIncludesZero)`
`void`	`setDomainMaximum(double domainMaximum)`
`void`	`setDomainMinimum(double domainMinimum)`
`void`	`setDomainPeriodCount(double domainPeriodCount)`
`void`	`setDomainStickyZero(boolean domainStickyZero)`
`void`	`setDomainTickFont(Font domainTickFont)`
`void`	`setDomainTickFormat(NumberFormat domainTickFormat)`
`void`	`setDomainTickFormatString(String domainTickFormatString)`
`void`	`setDomainTimePeriod(Class domainTimePeriod)`
`void`	`setDomainTitle(String domainTitle)`
`void`	`setDomainTitleFont(Font domainTitleFont)`
`void`	`setDomainVerticalTickLabels(boolean domainVerticalTickLabels)`
`void`	`setHorizontal(boolean value)`
`void`	`setHumanReadableLogarithmicFormat(boolean humanReadableLogarithmicFormat)`
`void`	`setLogarithmicAxis(boolean logarithmicAxis)`
`void`	`setPlotBackgroundColor(Color plotBackgroundPaint)`
`void`	`setPlotBackgroundPaint(Paint plotBackgroundPaint)` Deprecated. this property is declared but not used anywhere
`void`	`setRangeAxisAutoRange(boolean rangeAxisAutoRange)`
`void`	`setRangeIncludesZero(boolean rangeIncludesZero)`
`void`	`setRangeMaximum(double rangeMaximum)`
`void`	`setRangeMinimum(double rangeMinimum)`
`void`	`setRangePeriodCount(double rangePeriodCount)`
`void`	`setRangeStickyZero(boolean rangeStickyZero)`
`void`	`setRangeTickFont(Font rangeTickFont)`
`void`	`setRangeTickFormat(NumberFormat rangeTickFormat)`
`void`	`setRangeTickFormatString(String rangeTickFormatString)`
`void`	`setRangeTimePeriod(Class rangeTimePeriod)`
`void`	`setRangeTitle(String rangeTitle)`
`void`	`setRangeTitleFont(Font rangeTitleFont)`
`void`	`setStacked(boolean stacked)`
`void`	`setTitlePosition(org.jfree.ui.RectangleEdge titlePosition)` Deprecated. Dont use that.
`void`	`setTitlePositionText(String titlePositionText)`

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

- Method Detail
  - isDomainAxisAutoRange
```
public boolean isDomainAxisAutoRange()
```
  - setDomainAxisAutoRange
```
public void setDomainAxisAutoRange(boolean domainAxisAutoRange)
```
  - isRangeAxisAutoRange
```
public boolean isRangeAxisAutoRange()
```
  - setRangeAxisAutoRange
```
public void setRangeAxisAutoRange(boolean rangeAxisAutoRange)
```
  - getDomainTimePeriod
```
public Class getDomainTimePeriod()
```
  - setDomainTimePeriod
```
public void setDomainTimePeriod(Class domainTimePeriod)
```
  - getRangeTimePeriod
```
public Class getRangeTimePeriod()
```
  - setRangeTimePeriod
```
public void setRangeTimePeriod(Class rangeTimePeriod)
```
  - isHumanReadableLogarithmicFormat
```
public boolean isHumanReadableLogarithmicFormat()
```
  - setHumanReadableLogarithmicFormat
```
public void setHumanReadableLogarithmicFormat(boolean humanReadableLogarithmicFormat)
```
  - isLogarithmicAxis
```
public boolean isLogarithmicAxis()
```
  - setLogarithmicAxis
```
public void setLogarithmicAxis(boolean logarithmicAxis)
```
  - getInstance
```
public org.pentaho.reporting.engine.classic.core.function.Expression getInstance()
```
    Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function.
    
    Specified by:
    
    getInstance in interface org.pentaho.reporting.engine.classic.core.function.Expression
    
    Overrides:
    
    getInstance in class AbstractChartExpression
    
    Returns:
    
    a copy of this function.
  - isStacked
```
public boolean isStacked()
```
    Returns:
    
    Returns the stacked.
  - setStacked
```
public void setStacked(boolean stacked)
```
    Parameters:
    
    stacked - The stacked to set.
  - isDomainVerticalTickLabels
```
public boolean isDomainVerticalTickLabels()
```
    Returns:
    
    Returns the verticalTickLabels.
  - setDomainVerticalTickLabels
```
public void setDomainVerticalTickLabels(boolean domainVerticalTickLabels)
```
    Parameters:
    
    domainVerticalTickLabels - The domainVerticalLabels to set.
  - isDomainIncludesZero
```
public boolean isDomainIncludesZero()
```
    Returns:
    
    Returns the domainIncludeZero.
  - setDomainIncludesZero
```
public void setDomainIncludesZero(boolean domainIncludesZero)
```
    Parameters:
    
    domainIncludesZero - The domainIncludesZero to set.
  - isDomainStickyZero
```
public boolean isDomainStickyZero()
```
    Returns:
    
    Returns the domainStickyZero.
  - setDomainStickyZero
```
public void setDomainStickyZero(boolean domainStickyZero)
```
    Parameters:
    
    domainStickyZero - The domainStickyZero to set.
  - isRangeIncludesZero
```
public boolean isRangeIncludesZero()
```
    Returns:
    
    Returns the rangeIncludeZero.
  - setRangeIncludesZero
```
public void setRangeIncludesZero(boolean rangeIncludesZero)
```
    Parameters:
    
    rangeIncludesZero - The domainIncludesZero to set.
  - isRangeStickyZero
```
public boolean isRangeStickyZero()
```
    Returns:
    
    Returns the rangeStickyZero.
  - setRangeStickyZero
```
public void setRangeStickyZero(boolean rangeStickyZero)
```
    Parameters:
    
    rangeStickyZero - The rangeStickyZero to set.
  - setPlotBackgroundColor
```
public void setPlotBackgroundColor(Color plotBackgroundPaint)
```
    Overrides:
    
    setPlotBackgroundColor in class AbstractChartExpression
  - getPlotBackgroundColor
```
public Color getPlotBackgroundColor()
```
    Overrides:
    
    getPlotBackgroundColor in class AbstractChartExpression
  - setPlotBackgroundPaint
```
public void setPlotBackgroundPaint(Paint plotBackgroundPaint)
```
    Deprecated. this property is declared but not used anywhere
    
    Parameters:
    
    plotBackgroundPaint -
  - getPlotBackgroundPaint
```
public Paint getPlotBackgroundPaint()
```
    Deprecated. this property is declared but not used anywhere
  - isHorizontal
```
public boolean isHorizontal()
```
  - setHorizontal
```
public void setHorizontal(boolean value)
```
  - isBorderVisible
```
public boolean isBorderVisible()
```
    Deprecated.
    
    Returns:
    
    Returns the borderVisible.
  - setBorderVisible
```
public void setBorderVisible(boolean borderVisible)
```
    Deprecated.
    
    Parameters:
    
    borderVisible - The borderVisible to set.
  - getBorderPaint
```
public Paint getBorderPaint()
```
    Deprecated. Is not used anywhere ...
    
    Returns:
    
    Returns the borderPaint.
  - setBorderPaint
```
public void setBorderPaint(Paint borderPaint)
```
    Deprecated. is not used anywhere
    
    Parameters:
    
    borderPaint - The borderPaint to set.
  - getTitlePositionText
```
public String getTitlePositionText()
```
  - setTitlePositionText
```
public void setTitlePositionText(String titlePositionText)
```
  - getTitlePosition
```
public org.jfree.ui.RectangleEdge getTitlePosition()
```
    Deprecated. Dont use that.
    
    Returns:
    
    Returns the titlePosition.
  - setTitlePosition
```
public void setTitlePosition(org.jfree.ui.RectangleEdge titlePosition)
```
    Deprecated. Dont use that.
    
    Parameters:
    
    titlePosition - The titlePosition to set.
  - getDomainTitle
```
public String getDomainTitle()
```
    Returns:
    
    Returns the domainTitle.
  - setDomainTitle
```
public void setDomainTitle(String domainTitle)
```
    Parameters:
    
    domainTitle - The domainTitle to set.
  - getRangeTitle
```
public String getRangeTitle()
```
    Returns:
    
    Returns the rangeTitle.
  - setRangeTitle
```
public void setRangeTitle(String rangeTitle)
```
    Parameters:
    
    rangeTitle - The rangeTitle to set.
  - getDomainTitleFont
```
public Font getDomainTitleFont()
```
    Returns:
    
    Returns the domainTitleFont.
  - setDomainTitleFont
```
public void setDomainTitleFont(Font domainTitleFont)
```
    Parameters:
    
    domainTitleFont - The domainTitleFont to set.
  - getDomainTickFont
```
public Font getDomainTickFont()
```
    Return the java.awt.Font to be used to display the range axis tick labels
    
    Returns:
    
    Font The Font for the range axis tick labels
  - setDomainTickFont
```
public void setDomainTickFont(Font domainTickFont)
```
    Parameters:
    
    domainTickFont - The domainTickFont to set.
  - getDomainTickFormat
```
public NumberFormat getDomainTickFormat()
```
    Returns:
    
    Returns the rangeTickFormat.
  - setDomainTickFormat
```
public void setDomainTickFormat(NumberFormat domainTickFormat)
```
    Parameters:
    
    domainTickFormat - The range tick number format to set.
  - getRangeTitleFont
```
public Font getRangeTitleFont()
```
    Returns:
    
    Returns the rangeTitleFont.
  - setRangeTitleFont
```
public void setRangeTitleFont(Font rangeTitleFont)
```
    Parameters:
    
    rangeTitleFont - The rangeTitleFont to set.
  - getRangeTickFormat
```
public NumberFormat getRangeTickFormat()
```
    Returns:
    
    Returns the rangeTickFormat.
  - setRangeTickFormat
```
public void setRangeTickFormat(NumberFormat rangeTickFormat)
```
    Parameters:
    
    rangeTickFormat - The range tick number format to set.
  - getDomainTickFormatString
```
public String getDomainTickFormatString()
```
  - setDomainTickFormatString
```
public void setDomainTickFormatString(String domainTickFormatString)
```
  - getRangeTickFormatString
```
public String getRangeTickFormatString()
```
  - setRangeTickFormatString
```
public void setRangeTickFormatString(String rangeTickFormatString)
```
  - getRangeTickFont
```
public Font getRangeTickFont()
```
    Return the java.awt.Font to be used to display the range axis tick labels
    
    Returns:
    
    Font The Font for the range axis tick labels
  - setRangeTickFont
```
public void setRangeTickFont(Font rangeTickFont)
```
    Parameters:
    
    rangeTickFont - The rangeTitleFont to set.
  - getRangeMinimum
```
public double getRangeMinimum()
```
    Return the range axis' minimum value
    
    Returns:
    
    double Range axis' minimum value
  - setRangeMinimum
```
public void setRangeMinimum(double rangeMinimum)
```
    Parameters:
    
    rangeMinimum - Set the minimum value of the range axis.
  - getRangeMaximum
```
public double getRangeMaximum()
```
    Return the range axis' maximum value
    
    Returns:
    
    double Range axis' maximum value
  - setRangeMaximum
```
public void setRangeMaximum(double rangeMaximum)
```
    Parameters:
    
    rangeMaximum - Set the maximum value of the range axis.
  - getDomainMinimum
```
public double getDomainMinimum()
```
    Return the domain axis' minimum value
    
    Returns:
    
    double domain axis' minimum value
  - setDomainMinimum
```
public void setDomainMinimum(double domainMinimum)
```
    Parameters:
    
    domainMinimum - Set the minimum value of the domain axis.
  - getDomainMaximum
```
public double getDomainMaximum()
```
    Return the domain axis' maximum value
    
    Returns:
    
    double domain axis' maximum value
  - setDomainMaximum
```
public void setDomainMaximum(double domainMaximum)
```
    Parameters:
    
    domainMaximum - Set the maximum value of the domain axis.
  - getSubtitles
```
public List getSubtitles()
```
    Deprecated. Subtitles are not used.
    
    Returns:
    
    Returns the subTitles.
  - addSubTitle
```
public void addSubTitle(String subTitle)
```
    Deprecated. Subtitles are not used.
  - getChart
```
public org.jfree.chart.JFreeChart getChart(org.jfree.data.xy.XYDataset xyDataset)
```
    Deprecated. Not public, no getter
    
    Parameters:
    
    xyDataset -
    
    Returns:
  - isDisplayLabels
```
public boolean isDisplayLabels()
```
    Deprecated. Not used anywhere. You might want to use "itemLabelVisible"
    
    Returns:
  - getDomainPeriodCount
```
public double getDomainPeriodCount()
```
  - setDomainPeriodCount
```
public void setDomainPeriodCount(double domainPeriodCount)
```
  - getRangePeriodCount
```
public double getRangePeriodCount()
```
  - setRangePeriodCount
```
public void setRangePeriodCount(double rangePeriodCount)
```
  - reconfigureForCompatibility
```
public void reconfigureForCompatibility(int versionTag)
```
    Specified by:
    
    reconfigureForCompatibility in interface org.pentaho.reporting.engine.classic.core.LegacyUpdateHandler

Class XYChartExpression

Field Summary

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

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

isDomainAxisAutoRange

setDomainAxisAutoRange

isRangeAxisAutoRange

setRangeAxisAutoRange

getDomainTimePeriod

setDomainTimePeriod

getRangeTimePeriod

setRangeTimePeriod

isHumanReadableLogarithmicFormat

setHumanReadableLogarithmicFormat

isLogarithmicAxis

setLogarithmicAxis

getInstance

isStacked

setStacked

isDomainVerticalTickLabels

setDomainVerticalTickLabels

isDomainIncludesZero

setDomainIncludesZero

isDomainStickyZero

setDomainStickyZero

isRangeIncludesZero

setRangeIncludesZero

isRangeStickyZero

setRangeStickyZero

setPlotBackgroundColor

getPlotBackgroundColor

setPlotBackgroundPaint

getPlotBackgroundPaint

isHorizontal

setHorizontal

isBorderVisible

setBorderVisible

getBorderPaint

setBorderPaint

getTitlePositionText

setTitlePositionText

getTitlePosition

setTitlePosition

getDomainTitle

setDomainTitle

getRangeTitle

setRangeTitle

getDomainTitleFont

setDomainTitleFont

getDomainTickFont

setDomainTickFont

getDomainTickFormat

setDomainTickFormat

getRangeTitleFont

setRangeTitleFont

getRangeTickFormat

setRangeTickFormat

getDomainTickFormatString

setDomainTickFormatString

getRangeTickFormatString

setRangeTickFormatString

getRangeTickFont

setRangeTickFont

getRangeMinimum

setRangeMinimum

getRangeMaximum

setRangeMaximum

getDomainMinimum

setDomainMinimum

getDomainMaximum

setDomainMaximum

getSubtitles

addSubTitle

getChart

isDisplayLabels