JRChart (JasperReports 5.5.1 API)

All Superinterfaces:

Cloneable, JRAnchor, JRBoxContainer, JRChild, JRCloneable, JRCommonElement, JRElement, JREvaluation, JRHyperlink, JRIdentifiable, JRPropertiesHolder, JRStyleContainer, JRVisitable

All Known Implementing Classes:

JRBaseChart, JRDesignChart, JRFillChart
```
public interface JRChart
extends JRElement, JREvaluation, JRAnchor, JRHyperlink, JRBoxContainer
```
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 5878 2013-01-07 20:23:13Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Field Summary

Fields
Modifier and Type	Field and Description
`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_GANTT`
`static byte`	`CHART_TYPE_HIGHLOW`
`static byte`	`CHART_TYPE_LINE`
`static byte`	`CHART_TYPE_METER`
`static byte`	`CHART_TYPE_MULTI_AXIS`
`static byte`	`CHART_TYPE_PIE`
`static byte`	`CHART_TYPE_PIE3D`
`static byte`	`CHART_TYPE_SCATTER`
`static byte`	`CHART_TYPE_STACKEDAREA`
`static byte`	`CHART_TYPE_STACKEDBAR`
`static byte`	`CHART_TYPE_STACKEDBAR3D`
`static byte`	`CHART_TYPE_THERMOMETER`
`static byte`	`CHART_TYPE_TIMESERIES`
`static byte`	`CHART_TYPE_XYAREA`
`static byte`	`CHART_TYPE_XYBAR`
`static byte`	`CHART_TYPE_XYLINE`
`static String`	`PROPERTY_CHART_RENDER_TYPE` Specifies the type of chart rendering.
`static String`	`PROPERTY_CHART_THEME` Property used to specify the chart theme name.
`static String`	`RENDER_TYPE_DRAW` rendering type
`static String`	`RENDER_TYPE_IMAGE`
`static String`	`RENDER_TYPE_SVG`

Fields inherited from interface net.sf.jasperreports.engine.JRAnchor
NO_BOOKMARK

Method Summary

Methods
Modifier and Type	Method and Description
`byte`	`getChartType()` Gets the chart type.
`String`	`getCustomizerClass()` Gets a user specified chart customizer class name.
`JRChartDataset`	`getDataset()` Gets the chart dataset.
`Color`	`getLegendBackgroundColor()`
`Color`	`getLegendColor()`
`JRFont`	`getLegendFont()`
`EdgeEnum`	`getLegendPositionValue()`
`Color`	`getOwnLegendBackgroundColor()`
`Color`	`getOwnLegendColor()`
`Color`	`getOwnSubtitleColor()`
`Color`	`getOwnTitleColor()`
`JRChartPlot`	`getPlot()` Gets the chart plot.
`String`	`getRenderType()`
`Boolean`	`getShowLegend()`
`Color`	`getSubtitleColor()`
`JRExpression`	`getSubtitleExpression()` Gets the expression whose evaluation will form the subtitle.
`JRFont`	`getSubtitleFont()`
`String`	`getTheme()`
`Color`	`getTitleColor()`
`JRExpression`	`getTitleExpression()` Gets the expression whose evaluation will form the title.
`JRFont`	`getTitleFont()`
`EdgeEnum`	`getTitlePositionValue()` Gets the title position relative to the chart.
`void`	`setLegendBackgroundColor(Color legendBackgroundColor)`
`void`	`setLegendColor(Color legendColor)`
`void`	`setLegendPosition(EdgeEnum legendPosition)`
`void`	`setRenderType(String renderType)`
`void`	`setShowLegend(Boolean isShowLegend)`
`void`	`setSubtitleColor(Color subtitleColor)`
`void`	`setTheme(String theme)`
`void`	`setTitleColor(Color titleColor)`
`void`	`setTitlePosition(EdgeEnum titlePosition)` Sets the title position relative to the chart.

Methods inherited from interface net.sf.jasperreports.engine.JRElement
clone, collectExpressions, getElementGroup, getKey, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setX

Methods inherited from interface net.sf.jasperreports.engine.JRChild
clone

Methods inherited from interface net.sf.jasperreports.engine.JRVisitable
visit

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

Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getModeValue, getOwnBackcolor, getOwnForecolor, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode

Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleNameReference

Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasProperties

Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUID

Methods inherited from interface net.sf.jasperreports.engine.JREvaluation
getEvaluationGroup, getEvaluationTimeValue

Methods inherited from interface net.sf.jasperreports.engine.JRAnchor
getAnchorNameExpression, getBookmarkLevel

Methods inherited from interface net.sf.jasperreports.engine.JRHyperlink
getHyperlinkAnchorExpression, getHyperlinkPageExpression, getHyperlinkParameters, getHyperlinkReferenceExpression, getHyperlinkTarget, getHyperlinkTooltipExpression, getHyperlinkType, getHyperlinkTypeValue, getHyperlinkWhenExpression, getLinkTarget, getLinkType

Methods inherited from interface net.sf.jasperreports.engine.JRBoxContainer
getDefaultLineColor, getLineBox

- Field Detail
  - PROPERTY_CHART_RENDER_TYPE
```
static final String PROPERTY_CHART_RENDER_TYPE
```
    Specifies the type of chart rendering. Possible values are draw, image and svg. If the rendering type is draw a vector image is constructed, using the JFreeChart dedicated APIs. For type image, a PNG encoded image will be generated, while for type svg, an SVG snippet will be generated.
    Defaults to draw.
    
    See Also:
    Constant Field Values
  - PROPERTY_CHART_THEME
```
static final String PROPERTY_CHART_THEME
```
    Property used to specify the chart theme name.
    
    See Also:
    Constant Field Values
  - CHART_TYPE_AREA
```
static final byte CHART_TYPE_AREA
```
    See Also:
    Constant Field Values
  - CHART_TYPE_BAR3D
```
static final byte CHART_TYPE_BAR3D
```
    See Also:
    Constant Field Values
  - CHART_TYPE_BAR
```
static final byte CHART_TYPE_BAR
```
    See Also:
    Constant Field Values
  - CHART_TYPE_BUBBLE
```
static final byte CHART_TYPE_BUBBLE
```
    See Also:
    Constant Field Values
  - CHART_TYPE_CANDLESTICK
```
static final byte CHART_TYPE_CANDLESTICK
```
    See Also:
    Constant Field Values
  - CHART_TYPE_HIGHLOW
```
static final byte CHART_TYPE_HIGHLOW
```
    See Also:
    Constant Field Values
  - CHART_TYPE_LINE
```
static final byte CHART_TYPE_LINE
```
    See Also:
    Constant Field Values
  - CHART_TYPE_PIE3D
```
static final byte CHART_TYPE_PIE3D
```
    See Also:
    Constant Field Values
  - CHART_TYPE_PIE
```
static final byte CHART_TYPE_PIE
```
    See Also:
    Constant Field Values
  - CHART_TYPE_SCATTER
```
static final byte CHART_TYPE_SCATTER
```
    See Also:
    Constant Field Values
  - CHART_TYPE_STACKEDBAR3D
```
static final byte CHART_TYPE_STACKEDBAR3D
```
    See Also:
    Constant Field Values
  - CHART_TYPE_STACKEDBAR
```
static final byte CHART_TYPE_STACKEDBAR
```
    See Also:
    Constant Field Values
  - CHART_TYPE_XYAREA
```
static final byte CHART_TYPE_XYAREA
```
    See Also:
    Constant Field Values
  - CHART_TYPE_XYBAR
```
static final byte CHART_TYPE_XYBAR
```
    See Also:
    Constant Field Values
  - CHART_TYPE_XYLINE
```
static final byte CHART_TYPE_XYLINE
```
    See Also:
    Constant Field Values
  - CHART_TYPE_TIMESERIES
```
static final byte CHART_TYPE_TIMESERIES
```
    See Also:
    Constant Field Values
  - CHART_TYPE_METER
```
static final byte CHART_TYPE_METER
```
    See Also:
    Constant Field Values
  - CHART_TYPE_THERMOMETER
```
static final byte CHART_TYPE_THERMOMETER
```
    See Also:
    Constant Field Values
  - CHART_TYPE_MULTI_AXIS
```
static final byte CHART_TYPE_MULTI_AXIS
```
    See Also:
    Constant Field Values
  - CHART_TYPE_STACKEDAREA
```
static final byte CHART_TYPE_STACKEDAREA
```
    See Also:
    Constant Field Values
  - CHART_TYPE_GANTT
```
static final byte CHART_TYPE_GANTT
```
    See Also:
    Constant Field Values
  - RENDER_TYPE_DRAW
```
static final String RENDER_TYPE_DRAW
```
    rendering type
    
    See Also:
    Constant Field Values
  - RENDER_TYPE_IMAGE
```
static final String RENDER_TYPE_IMAGE
```
    See Also:
    Constant Field Values
  - RENDER_TYPE_SVG
```
static final String RENDER_TYPE_SVG
```
    See Also:
    Constant Field Values
- Method Detail
  - getShowLegend
```
Boolean getShowLegend()
```
  - setShowLegend
```
void setShowLegend(Boolean isShowLegend)
```
  - getTitleExpression
```
JRExpression getTitleExpression()
```
    Gets the expression whose evaluation will form the title.
  - getTitleFont
```
JRFont getTitleFont()
```
  - getTitlePositionValue
```
EdgeEnum getTitlePositionValue()
```
    Gets the title position relative to the chart.
  - setTitlePosition
```
void setTitlePosition(EdgeEnum titlePosition)
```
    Sets the title position relative to the chart.
  - getTitleColor
```
Color getTitleColor()
```
  - getOwnTitleColor
```
Color getOwnTitleColor()
```
  - setTitleColor
```
void setTitleColor(Color titleColor)
```
  - getSubtitleExpression
```
JRExpression getSubtitleExpression()
```
    Gets the expression whose evaluation will form the subtitle.
  - getSubtitleFont
```
JRFont getSubtitleFont()
```
  - getSubtitleColor
```
Color getSubtitleColor()
```
  - getOwnSubtitleColor
```
Color getOwnSubtitleColor()
```
  - setSubtitleColor
```
void setSubtitleColor(Color subtitleColor)
```
  - getLegendColor
```
Color getLegendColor()
```
  - getOwnLegendColor
```
Color getOwnLegendColor()
```
  - setLegendColor
```
void setLegendColor(Color legendColor)
```
  - getOwnLegendBackgroundColor
```
Color getOwnLegendBackgroundColor()
```
  - getLegendBackgroundColor
```
Color getLegendBackgroundColor()
```
  - setLegendBackgroundColor
```
void setLegendBackgroundColor(Color legendBackgroundColor)
```
  - getLegendFont
```
JRFont getLegendFont()
```
  - getLegendPositionValue
```
EdgeEnum getLegendPositionValue()
```
  - setLegendPosition
```
void setLegendPosition(EdgeEnum legendPosition)
```
  - getDataset
```
JRChartDataset getDataset()
```
    Gets the chart dataset. Most chart types have different dataset structures, depending on the chart type.
  - getPlot
```
JRChartPlot getPlot()
```
    Gets the chart plot. Plots are used to define various chart visual properties, such as colors and transparency.
  - getChartType
```
byte getChartType()
```
    Gets the chart type. It must be one of the chart type constants in this class.
  - getCustomizerClass
```
String getCustomizerClass()
```
    Gets a user specified chart customizer class name.
    
    See Also:
    JRChartCustomizer
  - getRenderType
```
String getRenderType()
```
  - setRenderType
```
void setRenderType(String renderType)
```
  - getTheme
```
String getTheme()
```
  - setTheme
```
void setTheme(String theme)
```

Interface JRChart

Field Summary

Fields inherited from interface net.sf.jasperreports.engine.JRAnchor

Method Summary

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

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

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

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

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

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

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

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

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

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

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

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

Field Detail

PROPERTY_CHART_RENDER_TYPE

PROPERTY_CHART_THEME

CHART_TYPE_AREA

CHART_TYPE_BAR3D

CHART_TYPE_BAR

CHART_TYPE_BUBBLE

CHART_TYPE_CANDLESTICK

CHART_TYPE_HIGHLOW

CHART_TYPE_LINE

CHART_TYPE_PIE3D

CHART_TYPE_PIE

CHART_TYPE_SCATTER

CHART_TYPE_STACKEDBAR3D

CHART_TYPE_STACKEDBAR

CHART_TYPE_XYAREA

CHART_TYPE_XYBAR

CHART_TYPE_XYLINE

CHART_TYPE_TIMESERIES

CHART_TYPE_METER

CHART_TYPE_THERMOMETER

CHART_TYPE_MULTI_AXIS

CHART_TYPE_STACKEDAREA

CHART_TYPE_GANTT

RENDER_TYPE_DRAW

RENDER_TYPE_IMAGE

RENDER_TYPE_SVG

Method Detail

getShowLegend

setShowLegend

getTitleExpression

getTitleFont

getTitlePositionValue

setTitlePosition

getTitleColor

getOwnTitleColor

setTitleColor

getSubtitleExpression

getSubtitleFont

getSubtitleColor

getOwnSubtitleColor

setSubtitleColor

getLegendColor

getOwnLegendColor

setLegendColor

getOwnLegendBackgroundColor

getLegendBackgroundColor

setLegendBackgroundColor

getLegendFont

getLegendPositionValue

setLegendPosition

getDataset

getPlot

getChartType

getCustomizerClass

getRenderType

setRenderType

getTheme

setTheme