JasperReports Ultimate Guide - Sample Reference - Schema Reference - Configuration Reference - API (Javadoc)

JasperReports - Schema Reference (version 5.6.1)


This document describes the JRXML structure of the report template files for the JasperReports Library.



Schemas
Report Schema Reference
Components Schema Reference

Report Schema Reference
anchorNameExpression
areaChart
areaPlot
axis
axisFormat
axisLevel
axisLevelBucket
background
band
bar3DChart
bar3DPlot
barChart
barPlot
bottomPen
box
break
bubbleChart
bubblePlot
bucket
bucketExpression
bucketProperty
candlestickChart
candlestickPlot
categoryAxisFormat
categoryAxisLabelExpression
categoryDataset
categoryExpression
categorySeries
cellContents
chart
chartLegend
chartSubtitle
chartTitle
closeExpression
columnFooter
columnGroup
columnHeader
comparatorExpression
component
componentElement
conditionalStyle
conditionExpression
connectionExpression
crosstab
crosstabCell
crosstabColumnHeader
crosstabDataset
crosstabHeader
crosstabHeaderCell
crosstabParameter
crosstabRowHeader
crosstabTotalColumnHeader
crosstabTotalRowHeader
dataAxis
dataRange
dataset
datasetParameter
datasetParameterExpression
datasetRun
dataSourceExpression
dateExpression
defaultValueExpression
detail
domainAxisMaxValueExpression
domainAxisMinValueExpression
elementGroup
ellipse
endDateExpression
field
fieldDescription
filterExpression
font
frame
ganttChart
ganttDataset
ganttSeries
genericElement
genericElementParameter
genericElementType
graphicElement
group
groupExpression
groupFooter
groupHeader
highExpression
highLowChart
highLowDataset
highLowPlot
highRange
hyperlinkAnchorExpression
hyperlinkPageExpression
hyperlinkParameter
hyperlinkParameterExpression
hyperlinkReferenceExpression
hyperlinkTooltipExpression
hyperlinkWhenExpression
image
imageExpression
import
incrementWhenExpression
initialValueExpression
itemHyperlink
itemLabel
jasperReport
keyExpression
labelExpression
labelExpression (in axisLevel)
labelExpression (in multiAxisMeasure)
labelFont
lastPageFooter
leftPen
line
lineChart
linePlot
lowExpression
lowRange
measure
measureExpression
mediumRange
meterChart
meterInterval
meterPlot
multiAxisChart
multiAxisData
multiAxisDataset
multiAxisMeasure
multiAxisPlot
noData
openExpression
orderByExpression
otherKeyExpression
otherLabelExpression
otherSectionHyperlink
pageFooter
pageHeader
paragraph
parameter
parameterDescription
parametersMapExpression
parameterValueExpression
patternExpression
pen
percentExpression
pie3DChart
pie3DPlot
pieChart
pieDataset
piePlot
pieSeries
plot
printWhenExpression
property
propertyExpression
queryString
rangeAxisMaxValueExpression
rangeAxisMinValueExpression
rectangle
reportElement
reportFont
returnValue
returnValue (in datasetRun)
rightPen
rowGroup
scatterChart
scatterPlot
scriptlet
scriptletDescription
sectionHyperlink
seriesColor
seriesExpression
sortField
stackedAreaChart
stackedBar3DChart
stackedBarChart
startDateExpression
staticText
style
subDataset
subreport
subreportExpression
subreportParameter
subreportParameterExpression
subtaskExpression
subtitleExpression
summary
tabStop
taskExpression
template
text
textElement
textField
textFieldExpression
thermometerChart
thermometerPlot
tickLabelFont
timeAxisFormat
timeAxisLabelExpression
timePeriodDataset
timePeriodExpression
timePeriodSeries
timeSeries
timeSeriesChart
timeSeriesDataset
timeSeriesPlot
title
titleCell (in crosstab)
titleExpression
topPen
valueAxisFormat
valueAxisLabelExpression
valueDataset
valueDisplay
valueExpression
valueExpression (in genericElementParameter)
valueExpression (in multiAxisMeasure)
variable
variableExpression
volumeExpression
whenNoDataCell
xAxisFormat
xAxisLabelExpression
xValueExpression
xyAreaChart
xyBarChart
xyDataset
xyLineChart
xySeries
xyzDataset
xyzSeries
yAxisFormat
yAxisLabelExpression
yValueExpression
zValueExpression






top

anchorNameExpression
If specified, it will supply the name of the local anchor that will mark to the corresponding element.

top

areaChart
Defines an area chart.

Contains
chart
categoryDataset
areaPlot

top

areaPlot
Defines rendering options for an <areaChart>

Contains
plot
categoryAxisLabelExpression?
categoryAxisFormat?
valueAxisLabelExpression?
valueAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

top

axis
Describes a range axis to use in a <multiAxisChart>. Each axis has its own range indicator and a data plot.

Attributes

position
Indicates where relative to the chart to display the range axis for this chart
Type:
Use: optional
Values
leftOrTopDisplay the axis to the left (for charts with a Vertical orientation) or top (for charts with a Horizontal orientation.)
rightOrBottomDisplay the axis to the right (for charts with a Vertical orientation) or bottom (for charts with a Horizontal orientation.)

top

axisFormat
Specifies the general formatting settings for an axis.

Contains
labelFont?
tickLabelFont?

Attributes

labelColor
The color to use for the caption of the axis.
Type: string
Use: optional

tickLabelColor
The color to use for the label of each tick mark on the axis.
Type: string
Use: optional

tickLabelMask
A formatting mask to use for the label of each tick mark on the axis. Only used if the axis is time based or numeric based. For numeric axes the format of the mask is described in documentation for java.text.DecimalFormat. For a date axis the format used is described in java.text.SimpleDateFormat. Finally, for date axes the values "SHORT", "MEDIUM", "LONG" and "FULL" can be used as described in java.text.DateFormat.
Type: string
Use: optional

verticalTickLabels
Flag to force rendering the tick labels rotated 90 degrees.
Type: boolean
Use: optional

axisLineColor
The color to use when drawing the line showing the axis.
Type: string
Use: optional

top

axisLevel

Contains
labelExpression
axisLevelBucket

Attributes

name
Type: string
Use: required

top

axisLevelBucket

Contains
bucketExpression?
comparatorExpression?
bucketProperty*

Attributes

class
Class of the bucket values.
Type: string
Use: optional
Default: java.lang.String

order
The bucket order type.
Type:
Use: optional
Values
AscendingThe buckets will be sorted in ascending order by using the specified comparator or by the natural order if no comparator specified.
DescendingThe buckets will be sorted in descending order by using the specified comparator or by the natural order if no comparator specified.
NoneNo sorting of bucket values will be performed, the buckets will show in the order the values come from the dataset.
Default: Ascending

top

background
Definition of the page background section for this report. The background section is displayed on every page and cannot overflow to the next page. Elements placed on this section are evaluated at page initialization time and are displayed in the back. All other page elements are displayed on top of the background elements. This section allows creating watermark or other similar effects in documents.

Contains
band?

top

band
Generic definition of a report section.

Contains
property*
printWhenExpression?
( break | line | rectangle | ellipse | image | staticText | textField | subreport | pieChart | pie3DChart | barChart | bar3DChart | xyBarChart | stackedBarChart | stackedBar3DChart | lineChart | xyLineChart | areaChart | xyAreaChart | scatterChart | bubbleChart | timeSeriesChart | highLowChart | candlestickChart | meterChart | thermometerChart | multiAxisChart | stackedAreaChart | ganttChart | elementGroup | crosstab | frame | componentElement | genericElement )*

Attributes

height
Height of the band.
Type: NMTOKEN
Use: optional
Default: 0

isSplitAllowed
Deprecated. Replaced by attribute splitType. Flag that indicates if the band is allowed to split when it stretches.
Type:
Use: optional
Values
truePage breaks are accepted within this band.
falseWhen the band stretches and it does not fit on the current page, the content of the band will be transferred on the next new page. On this new page the flag will be ignored since the band has to be displayed even there is not enough space to acquire the stretch.

splitType
Specifies the band split behavior.
Type:
Use: optional
Values
StretchThe band is allowed to split, but never within its declared height. This means the band splits only when its content stretches.
PreventPrevents the band from splitting on first break attempt. On subsequent pages/columns, the band is allowed to split, to avoid infinite loops.
ImmediateThe band is allowed to split anywhere, as early as needed, but not before at least one element being printed on the current page/column.

top

bar3DChart
Defines a bar chart with 3D effect

Contains
chart
categoryDataset
bar3DPlot

top

bar3DPlot
Defines plot options for a bar chart with 3D effect

Contains
plot
itemLabel?
categoryAxisLabelExpression?
categoryAxisFormat?
valueAxisLabelExpression?
valueAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

isShowLabels
Show labels flag.
Type:
Use: optional
Values
true
false

xOffset
Offset on the x axis.
Type: string
Use: optional

yOffset
Offset on the y axis.
Type: string
Use: optional

top

barChart
Defines a bar chart. Dataset used with this chart is <categoryDataset>

Contains
chart
categoryDataset
barPlot

top

barPlot
Plot options for a <barChart>

Contains
plot
itemLabel?
categoryAxisLabelExpression?
categoryAxisFormat?
valueAxisLabelExpression?
valueAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

isShowLabels
Show labels flag.
Type:
Use: optional
Values
true
false

isShowTickMarks
Show tick marks on the value axis
Type:
Use: optional
Values
true
false

isShowTickLabels
Show tick labels on the value axis
Type:
Use: optional
Values
true
false

top

bottomPen
Groups the properties of the pen used to draw bottom lines or borders.

Attributes

lineWidth
The line width of the pen.
Type: NMTOKEN
Use: optional

lineStyle
The line style of the pen.
Type:
Use: optional
Values
SolidSolid line.
DashedDashed line.
DottedDotted line.
DoubleDouble line.

lineColor
Line color for the pen. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white.
Type: string
Use: optional

top

box
Tag used to specify the border and padding properties of a report element.

Contains
pen?
topPen?
leftPen?
bottomPen?
rightPen?

Attributes

border
Deprecated. Replaced by tag <pen>
Type:
Use: optional
Values
NoneNo border.
ThinThin border.
1PointNormal border.
2PointMedium border.
4PointThick border.
DottedDotted border.

borderColor
Deprecated. Replaced by tag <pen>
Type: string
Use: optional

padding
The amount of empty space between the border and the element's content.
Type: NMTOKEN
Use: optional

topBorder
Deprecated. Replaced by tag <topPen>
Type:
Use: optional
Values
NoneNo top border.
ThinThin top border.
1PointNormal top border.
2PointMedium top border.
4PointThick top border.
DottedDotted top border.

topBorderColor
Deprecated. Replaced by tag <topPen>
Type: string
Use: optional

topPadding
The amount of empty space between the top border and the element's content.
Type: NMTOKEN
Use: optional

leftBorder
Deprecated. Replaced by tag <leftPen>
Type:
Use: optional
Values
NoneNo left border.
ThinThin left border.
1PointNormal left border.
2PointMedium left border.
4PointThick left border.
DottedDotted left border.

leftBorderColor
Deprecated. Replaced by tag <leftPen>
Type: string
Use: optional

leftPadding
The amount of empty space between the left border and the element's content.
Type: NMTOKEN
Use: optional

bottomBorder
Deprecated. Replaced by tag <bottomPen>
Type:
Use: optional
Values
NoneNo bottom border.
ThinThin bottom border.
1PointNormal bottom border.
2PointMedium bottom border.
4PointThick bottom border.
DottedDotted bottom border.

bottomBorderColor
Deprecated. Replaced by tag <bottomPen>
Type: string
Use: optional

bottomPadding
The amount of empty space between the bottom border and the element's content.
Type: NMTOKEN
Use: optional

rightBorder
Deprecated. Replaced by tag <rightPen>
Type:
Use: optional
Values
NoneNo right border.
ThinThin right border.
1PointNormal right border.
2PointMedium right border.
4PointThick right border.
DottedDotted right border.

rightBorderColor
Deprecated. Replaced by tag <rightPen>
Type: string
Use: optional

rightPadding
The amount of empty space between the right border and the element's content.
Type: NMTOKEN
Use: optional

top

break
Introduces a page break or column break

Contains
reportElement

Attributes

type
Specifies the type of the break element.
Type:
Use: optional
Values
PagePage break.
ColumnColumn break.
Default: Page

top

bubbleChart
Creates a bubble chart

Contains
chart
xyzDataset
bubblePlot

top

bubblePlot
Plot options for a <bubbleChart>

Contains
plot
xAxisLabelExpression?
xAxisFormat?
yAxisLabelExpression?
yAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

scaleType
Scale options for the bubble chart items
Type:
Use: optional
Values
BothAxes
DomainAxis
RangeAxis

top

bucket
Crosstab group bucketing information.

Contains
bucketExpression?
orderByExpression?
comparatorExpression?

Attributes

class
Class of the bucket values.
Type: string
Use: optional
Default: java.lang.String

order
The bucket order type.
Type:
Use: optional
Values
AscendingThe buckets will be sorted in ascending order by using the specified comparator or by the natural order if no comparator specified.
DescendingThe buckets will be sorted in descending order by using the specified comparator or by the natural order if no comparator specified.
NoneThe buckets will preserve the order in which the data is fed to the crosstab.
Default: Ascending

top

bucketExpression
Crosstab group bucketing expression.

Attributes

class
Type: string
Use: optional

top

bucketProperty

Attributes

name
Name of the bucket property.
Type: string
Use: required

top

candlestickChart
Creates a candlestick chart

Contains
chart
highLowDataset
candlestickPlot

top

candlestickPlot
Plot options for a <candlestickChart>

Contains
plot
timeAxisLabelExpression?
timeAxisFormat?
valueAxisLabelExpression?
valueAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

isShowVolume
Flag that enables showing volume values for a <candlestickChart>.
Type:
Use: optional
Values
true
false

top

categoryAxisFormat
Specifies the formatting of a category axis, including how to draw the axis line, its label and tick mark labels. Any tick label mask specified will be ignored.

Contains
axisFormat

Attributes

labelRotation
Degrees to rotate the text labels for the category axis of the chart. Positive values rotate the text clockwise and negative values rotate it counterclockwise.
Type: string
Use: optional

top

categoryAxisLabelExpression
Expression that will be displayed on category axis

top

categoryDataset
Creates a dataset with one or more series and values associated with categories

Contains
dataset?
categorySeries*

top

categoryExpression
Defines a category expression in a dataset.

top

categorySeries
Defines a series that will be mapped on the category axis.

Contains
seriesExpression?
categoryExpression?
valueExpression?
labelExpression?
itemHyperlink?

top

cellContents
Crosstab header or data cell contents.

There are some restrictions/rules regarding crosstab cells:
  • Subreports, crosstabs and charts are not allowed.
  • Delayed evaluation for text fields and images is not allowed.
  • Cells cannot split on multiple pages.

Contains
property*
box?
( line | rectangle | ellipse | image | staticText | textField | elementGroup | frame | componentElement | genericElement )*

Attributes

backcolor
Crosstab cell background color.

The cell is filled with the background color only if the cell has opaque mode.
Type: string
Use: optional

mode
Crosstab cell transparency mode.
Type:
Use: optional
Values
Opaque
Transparent

style
Name of the report level style to use (see <style> element).

The style is only used for cell background and borders and is not inherited by elements inside the cell.
Type: string
Use: optional

top

chart
Defines a chart report element

Contains
reportElement
box?
chartTitle?
chartSubtitle?
chartLegend?
anchorNameExpression?
hyperlinkReferenceExpression?
hyperlinkWhenExpression?
hyperlinkAnchorExpression?
hyperlinkPageExpression?
hyperlinkTooltipExpression?
hyperlinkParameter*

Attributes

isShowLegend
Show legend flag
Type:
Use: optional
Values
true
false

evaluationTime
The chart can be rendered at a specified moment. This could be useful, for example, when we want to have on the first page a chart that will be generated only after fetching all the data source rows.
Type: jr:basicEvaluationTime
Use: optional
Values
Now
Report
Page
Column
Group
Band
Default: Now

evaluationGroup
Used to specify the group at which to render the chart, when evaluationTime is "Group".
Type: string
Use: optional

hyperlinkType
Indicates the type of the hyperlink element.

The type can be:

Type: string
Use: optional

hyperlinkTarget
Indicates the target of the hyperlink.
Type: string
Use: optional

bookmarkLevel
The level of the bookmark corresponding to the anchor.

The PDF exporter can create a bookmark tree using anchors defined in the report. This attributes specifies the level of the tree entry corresponding to this element's anchor. If set to "0" (the default), no bookmark will be created for the anchor.
Type: NMTOKEN
Use: optional
Default: 0

customizerClass
The name of the chart customizer class.

A chart can have an associated customizer class to perform customizations that are not directly supported by JRXML. The customizer class should implement net.sf.jasperreports.engine.JRChartCustomizer. At fill time, the customize() method of this class will be called before the chart is rendered.

If values of report parameters, variables or fields are needed in the customization, the customizer implementation should extend net.sf.jasperreports.engine.JRAbstractChartCustomizer to gain access to such values.
Type: string
Use: optional

renderType
Represents the specified format used to render the chart.
Type: string
Use: optional

theme
The chart theme used to draw the chart.
Type: string
Use: optional

top

chartLegend
Specifies layout options for the legend of a chart.

Contains
font?

Attributes

textColor
The color of the text in the legend.
Type: string
Use: optional

backgroundColor
The color of the background of the legend.
Type: string
Use: optional

position
Position of the legend.
Type:
Use: optional
Values
Top
Bottom
Left
Right

top

chartSubtitle
Subtitle of the chart

Contains
font?
subtitleExpression?

Attributes

color
Color of the subtitle text
Type: string
Use: optional

top

chartTitle
Title text of the chart.

Contains
font?
titleExpression?

Attributes

position
Position of the title
Type:
Use: optional
Values
Top
Bottom
Left
Right

color
Color of the title text
Type: string
Use: optional

top

closeExpression
Expression for the close value for <candlestickChart>

top

columnFooter
Definition of the column footer section for this report. The column footer is printed at the bottom of each column on the report. If the report's column count is 1, column header and footer sections are ignored.

Contains
band?

top

columnGroup
Crosstab column group definition.

Each group in the crosstab has a variable that can be used inside the group header or inside the crosstab cells as the current group value. The variable has the same name as the group and the same type as the bucket expression of the group.

Contains
bucket
crosstabHeader?
crosstabColumnHeader?
crosstabTotalColumnHeader?

Attributes

name
Group name.
Type: string
Use: required

height
The height of the column group header.
Type: NMTOKEN
Use: required

totalPosition
The position of the total column for this group.

A group can have a total column summing the values for all the entries in the group. E.g. if there is a Year group having Month as a subgroup, the total column for the Year group would sum the values for all the years and the total column for the Month group would sum the values for all the months of an year.
Type:
Use: optional
Values
StartThe total column will be displayed before the group column.
EndThe total column will be displayed after the group column.
NoneThe total column will not be displayed.
Default: None

headerPosition
The position of the header contents on header span.

The column group headers stretch horizontally by spanning when there are multiple sub group entries. This attribute determines the way the header contents will be adjusted to the new width.
Type:
Use: optional
Values
LeftThe contents will be rendered on the left side of the header
CenterThe contents will be rendered on the center of the header
RightThe contents will be rendered on the right side of the header
StretchThe contents will be proportionally stretched to the new header width
Default: Left

top

columnHeader
Definition of the column header section for this report. The column header is printed at the beginning of each column on the report. If the report's column count is 1, column header and footer sections are ignored.

Contains
band?

top

comparatorExpression
Crosstab group bucket comparator expression.

The result of this expression is used to sort the buckets, in ascending or descending order. If the bucket has an order by expression, the comparator will be used to compare values as produced by that expression. If no comparator expression is specified, the natural order will be used.


top

component

top

componentElement

Contains
reportElement
component

top

conditionalStyle
Used for adding conditions to a current style, to create dynamic styles.

Modifies the properties of the parent style, based on various conditions evaluated at fill time. It must be placed inside a top level style.

Contains
conditionExpression?
style

top

conditionExpression
A boolean expression which indicates if the style properties associated with it should be applied to the parent style.

top

connectionExpression
If present, it is used to pass the java.sql.Connection object to the subreport filling or subdataset iteration routines.

top

crosstab
Crosstab definition.

To be noted that the crosstab will stretch downwards to fit the data but it will not exceed its report element width.

Contains
reportElement
box?
crosstabParameter*
parametersMapExpression?
crosstabDataset?
titleCell?
crosstabHeaderCell?
rowGroup*
columnGroup*
measure*
crosstabCell*
whenNoDataCell?

Attributes

isRepeatColumnHeaders
Flag that indicates whether the column headers will be reprinted after a page break.
Type:
Use: optional
Values
trueThe column headers will be reprinted after a page break.
falseThe column headers will be printed only on the page where the crosstab starts.
Default: true

isRepeatRowHeaders
Flag that indicates whether the row headers will be reprinted after a crosstab column break.
Type:
Use: optional
Values
trueThe row headers will be reprinted after a crosstab column break.
falseThe column headers will be printed for all rows only for the first set of columns and not after a column break.
Default: true

columnBreakOffset
Offset used when a column break occurs and the filling is continued on the same page.

When the crosstab columns do not fit the width, the crosstab breaks the columns and prints the ones that don't fit after printing the first set of columns for all rows. This attribute is the offset to be used when continuing the printing after a column break.
Type: NMTOKEN
Use: optional
Default: 10

runDirection
The crosstab run direction.

Crosstabs can either be filled from left to right (the default) or from right to left (mainly for reports in RTL languages).

When a crosstab is filled from right to left, the crosstab contents will start from the right extremity of the crosstab element area and grow towards the left.
Type:
Use: optional
Values
LTRLeft to right run direction.
RTLRight to left run direction.
Default: LTR

ignoreWidth
This attribute determines whether the crosstab will break at the width set for the crosstab element, or whether the crosstab is to expand over this width (and over the page width as well).

If this attribute is set to true, the crosstab will expand towards the right (or towards the left if the crosstab direction is RTL) as long as it needs to. This would result in crosstab cells being rendered over the page boundary; such elements will be exported by certain grid-based exporters such as the HTML or XLS ones, but will not be visible in export formats that observe the page width, such as the PDF exporter.

The default value of this flag is given by the net.sf.jasperreports.crosstab.ignore.width property.

Type: boolean
Use: optional

horizontalPosition
The position of the crosstab within its element box.

By default LTR crosstabs are positions at the left of the element box, and RTL crosstabs at the right of the box.
Type:
Use: optional
Values
LeftThe crosstab is positioned at the left of the element box.
RightThe crosstab is positioned at the right of the element box.
CenterThe crosstab is centered withing the element box.

top

crosstabCell
Crosstab data cell definition.

A crosstab can have multiple data cells for row/groups totals. Attributes rowTotalGroup and columnTotalGroup are used to specify that the cell corresponds to a total row/column.

E.g. if the crosstab has Country and City (subgroup of Country) row groups and Year and Month column groups, one can specify the following cells:
  • no rowTotalGroup and columnTotalGroup - the crosstab base cell (total for a city and a year)
  • columnTotalGroup="Month" - total for a city and a year
  • columnTotalGroup="Year" - total for a city and all years
  • rowTotalGroup="City" - total for all cities of a country and a month
  • rowTotalGroup="City" columnTotalGroup="Month" - total for all cities of a country and a year
  • rowTotalGroup="City" columnTotalGroup="Year" - total for all cities of a country and all years
  • rowTotalGroup="Country" - total for all countries and a month
  • rowTotalGroup="Country" columnTotalGroup="Month" - total for all countries and a year
  • rowTotalGroup="Country" columnTotalGroup="Year" - grand total

If the data cell for a total row/column is not specified, the cell will be inherited from lower level cells, if possible. For example, if the "total for all countries and a year" cell is not specified, the "total for a country and a year" or "total for a city and a year" cell will be used (in this order).

The data cell sizes are calculated from the base data cell sizes, i.e. the height of all data cells for a row will be the height of the base cell of that row. The base cell sizes are also inherited, e.g. if the height of a total row is not specified the height of the base row will be used.

Contains
cellContents?

Attributes

width
Crosstab cell width.

The width should be specified only for the base cell of a column (the one with no rowTotalGroup).
Type: NMTOKEN
Use: optional

height
Crosstab cell height.

The height should be specified only for the base cell of a row (the one with no columnTotalGroup).
Type: NMTOKEN
Use: optional

rowTotalGroup
If this cell corresponds to a total row, this attribute should specify the name of the corresponding row group. The attribute should not be specified if the cell corresponds to a base (not total) row.
Type: string
Use: optional

columnTotalGroup
If this cell corresponds to a total column, this attribute should specify the name of the corresponding column group. The attribute should not be specified if the cell corresponds to a base (not total) column.
Type: string
Use: optional

top

crosstabColumnHeader
Crosstab column header definition.

The size of the column header cell is computed based on the following rules:
  • the height of the header is given by the height attribute of <columnGroup>
  • the width of the last column group header is given by the width of the base cell
  • the width of a non-last column group header is the sum of the next group header's width and the next group total header's width (0 if the next group doesn't have a total header)

Contains
cellContents?

top

crosstabDataset
Crosstab dataset definition.

Contains
dataset?

Attributes

isDataPreSorted
Flag that indicates whether the crosstab data is already sorted according to the row bucket expressions and group bucket expressions (in this order).

The crosstab calculation engine can optimize the calculations if the data is sorted by the row groups and column groups. For example, if there are two row groups R1 and R2 (subgroup of R1) and three column groups C1, C2 and C3 the data should be sorted by R1, R2, C1, C2, C3.
Type:
Use: optional
Values
trueThe calculation engine will assume that the data is presorted. If the data is not presorted, the outcome is undefined.
falseThe crosstab dataset data is not presorted.
Default: false

top

crosstabHeader
Per column group cell that will be rendered at the left of the corresponding row of column headers, potentially overlapping the crosstab header cell.

The width of the cell is the total width of row group headers, and the height is the height of the corresponding column header.

Contains
cellContents

top

crosstabHeaderCell
Crosstab cell that will be rendered at the upper-left corner of the crosstab.

The cell size will be calculated based on the row/column header cell widths/heights.

Contains
cellContents

top

crosstabParameter
Crosstab parameter definition and value. Values from the report can only be accessed inside crosstab elements by passing them as parameters.

Contains
parameterValueExpression?

Attributes

name
Name of the parameter.
Type: string
Use: required

class
Class of the parameter values.
Type: string
Use: optional
Default: java.lang.String

top

crosstabRowHeader
Crosstab row header definition.

The size of the row header cell is computed based on the following rules:
  • the width of the header is given by the width attribute of <rowGroup>
  • the height of the last row group header is given by the height of the base cell
  • the height of a non-last row group header is the sum of the next group header's height and the next group total header's height (0 if the next group doesn't have a total header)

Contains
cellContents?

top

crosstabTotalColumnHeader
Crosstab total column header definition.

The size of a column group total header is computed based on the following rules:
  • the height is the sum the heights of this and subsequent column groups
  • the width is the width of the base cell for this total column

The total column is only printed if the totalPosition attribute of the group is different than None.

Contains
cellContents?

top

crosstabTotalRowHeader
Crosstab total row header definition.

The size of a row group total header is computed based on the following rules:
  • the width is the sum the widths of this and subsequent row groups
  • the height is the height of the base cell for this total row

The total row is only printed if the totalPosition attribute of the group is different than None.

Contains
cellContents?

top

dataAxis

Contains
axisLevel*

Attributes

axis
Type:
Use: required
Values
Rows
Columns

top

dataRange
Defines a numeric range, such as the bounds of chart or a section of a chart.

Contains
lowExpression
highExpression

top

dataset
Dataset definition for a chart or crosstab.

Contains
incrementWhenExpression?
datasetRun?

Attributes

resetType
Reset type for the dataset
Type:
Use: optional
Values
None
Report
Page
Column
Group

resetGroup
Reset group name
Type: string
Use: optional

incrementType
Increment type of the dataset.
Type:
Use: optional
Values
None
Report
Page
Column
Group
Default: None

incrementGroup
Increment group of the dataset
Type: string
Use: optional

top

datasetParameter
Definition of a subdataset parameter.

Contains
datasetParameterExpression?

Attributes

name
The name of the parameter that will be passed when iterating the subdataset.
Type: string
Use: required

top

datasetParameterExpression
Definition of the expression associated with the subdataset parameter.

top

datasetRun
Subdataset instantiation information for a chart/crosstab dataset.

Contains
property*
parametersMapExpression?
datasetParameter*
( connectionExpression? | dataSourceExpression? )?
returnValue*

Attributes

subDataset
The name of the <subdataset> to instantiate.
Type: string
Use: required

uuid
This attribute is auto-generated and is used to uniquely identify dataset runs.
Type: string
Use: optional

top

dataSourceExpression
If present, it is used to pass the net.sf.jasperreports.engine.JRDataSource object to the subreport filling or subdataset iteration routines.

top

dateExpression
Represents a date expression used in <timeSeriesChart>

top

defaultValueExpression
Specifies the parameter default value to use when not supplied by the parent application at runtime.

top

detail
Definition of a detail band for this report. A detail band is repeated for each line of data supplied by the report's data source. There can be multiple detail bands in a report.

Contains
band*

top

domainAxisMaxValueExpression
Defines the expression for the maximum value on the domain axis.

top

domainAxisMinValueExpression
Defines the expression for the minimum value on the domain axis.

top

elementGroup
Element for grouping objects on the report.

top

ellipse
Definition of an ellipse object.

Contains
reportElement
graphicElement?

top

endDateExpression

top

field
Represents the definition of a data field that will store values retrieved from the data source of the report.

Contains
property*
fieldDescription?

Attributes

name
Name of the field.
Type: string
Use: required

class
Class of the field values.
Type: string
Use: optional
Default: java.lang.String

top

fieldDescription
Can be used to specify a short text description for the field and is useful especially when creating special designed data sources and an extra information is needed in order to extract the value of the field.

top

filterExpression
Boolean expression used to filter the rows of a data source.

This expression is used to filter the rows of the data source that this dataset will iterate on.

This expression (if not null) is evaluated immediately after a new row is produced by the data source. The evaluation is performed using field and variable values corresponding to the new row. When the result of the evaluation is Boolean.TRUE the row gets processed by the report filling engine. When the result is null or Boolean.FALSE, the current row will be skipped and the datasource will be asked for the next row.


top

font
Defines the font to use with the text element.

Attributes

reportFont
Name of the report level font to use as base font (see <reportFont> element).
Type: string
Use: optional

fontName
Name of the font.
Type: string
Use: optional

size
Size of the font.
Type: NMTOKEN
Use: optional

isBold
Type:
Use: optional
Values
true
false

isItalic
Type:
Use: optional
Values
true
false

isUnderline
Type:
Use: optional
Values
true
false

isStrikeThrough
Type:
Use: optional
Values
true
false

pdfFontName
Name of the PDF font.
Type: string
Use: optional

pdfEncoding
Encoding type to use with the PDF font.
Type: string
Use: optional

isPdfEmbedded
Specifies if the PDF font should be embedded in the document.
Type:
Use: optional
Values
true
false

top

frame
A frame is a report element that contains sub elements. It has a backgroud, a border and it stretches to accommodate its content.

For the Graphics2D and PDF exporters, a frame is equivalent to a rectangle placed behind a group of elements. The HTML exporter creates sub-tables for frames and the XLS exporter includes the frame sub elements into the grid.

For elements inside a frame, the coordinates, positionType and stretchType properties and relative to the frame instead of the band.

Contains
reportElement
box?
( break | line | rectangle | ellipse | image | staticText | textField | subreport | pieChart | pie3DChart | barChart | bar3DChart | xyBarChart | stackedBarChart | stackedBar3DChart | lineChart | xyLineChart | areaChart | xyAreaChart | scatterChart | bubbleChart | timeSeriesChart | highLowChart | candlestickChart | meterChart | thermometerChart | multiAxisChart | stackedAreaChart | ganttChart | elementGroup | crosstab | frame | componentElement | genericElement )*

top

ganttChart
Defines a gantt chart

Contains
chart
ganttDataset
barPlot

top

ganttDataset
Defines an gantt type dataset

Contains
dataset?
ganttSeries*

top

ganttSeries
Defines a gantt series for a <ganttDataset>

Contains
seriesExpression?
taskExpression
subtaskExpression
startDateExpression?
endDateExpression?
percentExpression?

top

genericElement

Contains
reportElement
genericElementType
genericElementParameter*

Attributes

evaluationTime
Type: jr:complexEvaluationTime
Use: optional
Values
Now
Report
Page
Column
Group
Band
Auto
Default: Now

evaluationGroup
Type: string
Use: optional

top

genericElementParameter

Contains
valueExpression?

Attributes

name
Type: string
Use: required

skipWhenNull
Type: boolean
Use: optional
Default: false

top

genericElementType

Attributes

namespace
Type: string
Use: required

name
Type: string
Use: required

top

graphicElement
Element used to specify the common properties of a graphic object on the report (line, rectangle, ellipse or image).

Contains
pen?

Attributes

stretchType
The element will be printed when the specified group changes.
Type:
Use: optional
Values
NoStretch
RelativeToTallestObject
RelativeToBandHeight

pen
Deprecated. Replaced by tag <pen>.
Type:
Use: optional
Values
NoneNo line.
ThinThin line.
1PointNormal line.
2PointMedium line.
4PointThick line.
DottedDotted line.

fill
Type of the fill pattern used to fill objects.
Type:
Use: optional
Values
SolidSolid fill.

top

group
Definition of a group on the report.

Contains
groupExpression?
groupHeader?
groupFooter?

Attributes

name
Name of the group.
Type: string
Use: required

isStartNewColumn
Flag that signals if the group header should be printed always on a new column.
Type:
Use: optional
Values
trueGroup header section is printed always on a new column.
falseGroup header section is printed on the current column, if there is enough space.
Default: false

isStartNewPage
Flag that signals if the group header should be printed always on a new page.
Type:
Use: optional
Values
trueGroup header section is printed always on a new page.
falseGroup header section is printed on the current page, if there is enough space.
Default: false

isResetPageNumber
Flag that signals if the group header should be printed always on a new page, along with the re-initialization of the page number.
Type:
Use: optional
Values
trueGroup header section is printed always on a new page and the page number is reinitialized.
falseGroup header section is printed accordingly with the isStartNewPage attribute and the page number is not affected.
Default: false

isReprintHeaderOnEachPage
Flag that signals if the group header should be reprinted at the beginning of each page.
Type:
Use: optional
Values
trueGroup header section is reprinted always at the beginning of a new page.
falseGroup header section is not reprinted at the beginning of a new page.
Default: false

minHeightToStartNewPage
Minimum amount of vertically space needed at the bottom of the column in order to place the group header on the current column.
Type: NMTOKEN
Use: optional
Default: 0

footerPosition
Specifies how the group footer section behaves with regards to its position on the current page.
Type:
Use: optional
Values
NormalThe group footer section is rendered at normal position, just right after the last detail or right after the nested group footer section.
StackAtBottomThe group footer section is rendered at bottom of the current page, provided that an inner group having this value would force outer group footers to stack at the bottom of the current page, regardless of the outer group footer setting.
ForceAtBottomThe group footer section is rendered at bottom of the current page, provided that an inner group having this value would render its footer right at the bottom of the page, forcing the outer group footers to render on the next page.
CollateAtBottomThe group footer section is rendered at bottom of the current page, provided that the outer footers have a similar footer display option to render at the page bottom as well, because otherwise, they cannot be forced to change their behavior in any way.
Default: Normal

keepTogether
Flag that prevents the group from splitting on two separate pages/columns, but only on the first break attempt.
Type:
Use: optional
Values
trueGroup can split across two separate pages/column at any moment.
falseGroup is moved onto a new new page/column, before being split.
Default: false

top

groupExpression
Specifies the expression that will be evaluated at runtime to determine the group ruptures.

top

groupFooter
Contains the definition of the footer section for this group.

Contains
band*

top

groupHeader
Contains the definition of the header section for this group.

Contains
band*

top

highExpression
High expresion in a <highLowchart>.

top

highLowChart
Defines a high-low type chart

Contains
chart
highLowDataset
highLowPlot

top

highLowDataset
Defines a dataset that can be used with a <highLowChart>.

Contains
dataset?
seriesExpression?
dateExpression?
highExpression?
lowExpression?
openExpression?
closeExpression?
volumeExpression?
itemHyperlink?

top

highLowPlot
Plot options for a <highLowChart>

Contains
plot
timeAxisLabelExpression?
timeAxisFormat?
valueAxisLabelExpression?
valueAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

isShowCloseTicks
Show close tick flag.
Type:
Use: optional
Values
true
false

isShowOpenTicks
Show open tick flag.
Type:
Use: optional
Values
true
false

top

highRange
Defines the high range in a <thermometerChart>.

Contains
dataRange

top

hyperlinkAnchorExpression
Used in hyperlink elements to point to document anchors.

top

hyperlinkPageExpression
Used in hyperlink elements to point to document pages.

top

hyperlinkParameter
Definition of a hyperlink parameter. Hyperlink parameters can be used to parametrize hyperlinks of custom types.

Contains
hyperlinkParameterExpression

Attributes

name
The name of the hyperlink parameter.
Type: string
Use: required

top

hyperlinkParameterExpression
Expression that will produce the value for a hyperlink parameter.

Attributes

class
Type of the parameter value.
Type: string
Use: optional
Default: java.lang.String

top

hyperlinkReferenceExpression
Used in hyperlink elements to point to external documents and resources.

top

hyperlinkTooltipExpression
Used in hyperlink elements to generate a tooltip for the hyperlink. The type of the expression should be java.lang.String.

top

hyperlinkWhenExpression
Used in hyperlink elements to specify whether the hyperlink is to be displayed or not.

top

image
Definition of an image object.

Contains
reportElement
box?
graphicElement?
imageExpression?
anchorNameExpression?
hyperlinkReferenceExpression?
hyperlinkWhenExpression?
hyperlinkAnchorExpression?
hyperlinkPageExpression?
hyperlinkTooltipExpression?
hyperlinkParameter*

Attributes

scaleImage
Image displaying type.
Type:
Use: optional
Values
ClipOnly the portion of the image that fits the specified object width and height will be printed. Image is not stretched.
FillFrameImage will be stretched to adapt to the specified object width and height.
RetainShapeImage will adapt to the specified object width or height keeping its original shape.
RealHeightA scale image type that instructs the engine to stretch the image height to fit the actual height of the image. Several restrictions apply to the image stretching mechanism: It only works when the image renderer implements JRRenderable.getDimension(). If the actual image width exceeds the declared image element width, the image is proportionally stretched to fit the declared width. Images with delayed evaluation (see the evaluationTime attribute) do not stretch and is proportionally shrunk to fit the declared height/width. An image overflows (to the next page/column) only once, after this the image gets rendered on the available space by proportionally shrinking its size.
RealSizeA scale image type that stretches the images height in the same way as RealHeight, and in addition it changes the image width to the actual with of the image. This can be useful when, for instance, a border has to be drawn around the image, respecting its actual size.

hAlign
Horizontal image alignment.
Type:
Use: optional
Values
Left
Center
Right

vAlign
Vertical image alignment.
Type:
Use: optional
Values
Top
Middle
Bottom

isUsingCache
If true, tells the report engine to cache the images that are loaded from the same location.
Type:
Use: optional
Values
true
false

isLazy
Gives control over when the images are retrieved from their specified location.
Type:
Use: optional
Values
trueThe image is loaded from the specified location only when the document is viewed or exported to other formats.
falseThe image is loaded during the report filling process and stored in the resulting document.
Default: false

onErrorType
Controls the behavior of the engine in case the image is not available.
Type:
Use: optional
Values
ErrorAn exception is raised when loading the image.
BlankThe exception is ignored and the image displays as blank.
IconThe exception is ignored and an image replacement icon is displayed.
Default: Error

evaluationTime
The image to be printed is supplied by the associated expression. This expression can be evaluated at a specified moment. This could be useful, for example, when we want to have on the first page a chart that will be generated only after fetching all the data source rows.
Type: jr:complexEvaluationTime
Use: optional
Values
Now
Report
Page
Column
Group
Band
Auto
Default: Now

evaluationGroup
Used to specify the group at which to evaluate the image expression value, when evaluationTime is "Group".
Type: string
Use: optional

hyperlinkType
Indicates the type of the hyperlink element.

The type can be:

Type: string
Use: optional

hyperlinkTarget
Indicates the target of the hyperlink.
Type: string
Use: optional

bookmarkLevel
The level of the bookmark corresponding to the anchor.

The PDF exporter can create a bookmark tree using anchors defined in the report. This attributes specifies the level of the tree entry corresponding to this element's anchor. If set to "0" (the default), no bookmark will be created for the anchor.
Type: NMTOKEN
Use: optional
Default: 0

top

imageExpression
Definition of the expression that will be used to determine the image to be displayed.

Attributes

class
Class of the image source.
Type:
Use: optional
Default: java.lang.String

top

import
Translates into an import statement inside the expression class order to eliminate the need to use complete class names in the report expressions.

Attributes

value
Class name or package to import.
Type: string
Use: required

top

incrementWhenExpression
Boolean expression that determines whether a chart or crosstab dataset will be incremented or not.

The expression is evaluated before each increment of the dataset. The increment will be carried on only when the result of the evaluation is Boolean.TRUE; if the result is null or Boolean.FALSE, the dataset will not be incremented.


top

initialValueExpression
Definition of the expression that will be used to calculate the initial value of the variable, before any calculations are made.

top

itemHyperlink
Hyperlink specification for chart items. This hyperlink definition will be evaluated for every chart item and an image map will be created for the chart.

Contains
hyperlinkReferenceExpression?
hyperlinkWhenExpression?
hyperlinkAnchorExpression?
hyperlinkPageExpression?
hyperlinkTooltipExpression?
hyperlinkParameter*

Attributes

hyperlinkType
Indicates the type of the hyperlink element.

The type can be:

Type: string
Use: optional

hyperlinkTarget
Indicates the target of the hyperlink.
Type: string
Use: optional

top

itemLabel
Configures settings for item labels in a category plot.

Contains
font?

Attributes

color
The color of the label's text.
Type: string
Use: optional

backgroundColor
The background color of the label's text.
Type: string
Use: optional

top

jasperReport
Root element representing the definition of a report.

Contains
property*
import*
template*
reportFont*
style*
subDataset*
scriptlet*
parameter*
queryString?
field*
sortField*
variable*
filterExpression?
group*
background?
title?
pageHeader?
columnHeader?
detail?
columnFooter?
pageFooter?
lastPageFooter?
summary?
noData?

Attributes

name
Name of the report.
Type: string
Use: required

language
Specifies the language used for the report expressions.
Type: string
Use: optional
Default: java

columnCount
Number of columns on the report.
Type: NMTOKEN
Use: optional
Default: 1

printOrder
Columns filling order.
Type:
Use: optional
Values
VerticalColumns on the report are filled vertically.
HorizontalColumns on the report are filled horizontally.
Default: Vertical

columnDirection
Columns filling direction.
Type:
Use: optional
Values
LTRColumns on the report are filled from left to right.
RTLColumns on the report are filled from right to left.
Default: LTR

pageWidth
Page width.
Type: NMTOKEN
Use: optional
Default: 595

pageHeight
Page height.
Type: NMTOKEN
Use: optional
Default: 842

orientation
Page printing orientation.
Type:
Use: optional
Values
PortraitPortrait page layout.
LandscapeLandscape page layout.
Default: Portrait

whenNoDataType
Allows users to customize the behavior of the reporting engine when there are now rows in the data source.
Type:
Use: optional
Values
NoPagesThe generated document contains zero pages.
BlankPageThe generated document contains one blank page.
AllSectionsNoDetailAll the report sections except the detail section will get printed.
NoDataSectionThe generated document contains only the noData section.
Default: NoPages

columnWidth
Column width.
Type: NMTOKEN
Use: optional
Default: 555

columnSpacing
Space between columns.
Type: NMTOKEN
Use: optional
Default: 0

leftMargin
Left margin.
Type: NMTOKEN
Use: optional
Default: 20

rightMargin
Right margin.
Type: NMTOKEN
Use: optional
Default: 20

topMargin
Top margin.
Type: NMTOKEN
Use: optional
Default: 30

bottomMargin
Bottom margin.
Type: NMTOKEN
Use: optional
Default: 30

isTitleNewPage
Flag used to specify if the title section should be printed on a separate initial page.
Type:
Use: optional
Values
trueTitle section will be printed on a separate initial page
falseTitle section will be printed on the first page of the report, along with the other sections.
Default: false

isSummaryNewPage
Flag used to specify if the summary section should be printed on a separate last page.
Type:
Use: optional
Values
trueSummary section will be printed on a separate last page.
falseSummary section will be printed on the last page of the report, along with the other sections, if there is enough space.
Default: false

isSummaryWithPageHeaderAndFooter
Flag used to specify if the summary section should be accompanied by the page header and footer.
Type:
Use: optional
Values
trueSummary section will be printed along with the page header and footer.
falseSummary section will be printed without page header and footer.
Default: false

isFloatColumnFooter
Flag used to specify if the column footer section should be printed at the bottom of the column or if it should immediately follow the last detail or group footer printed on the current column.
Type:
Use: optional
Values
trueThe column footer section is printed immediately after the last detail or group footer printed on the current column.
falseThe column footer section is printed at the bottom of the current column.
Default: false

scriptletClass
Indicates which class implements the scriptlets functionality for this report. The specified class must be a subclass of JRAbstractScriptlet class. If omitted, an instance of JRDefaultScriptlet will be created.
Type: string
Use: optional

resourceBundle
The base name of the report associated resource bundle.
Type: string
Use: optional

whenResourceMissingType
Allows customizing the way the engine deals with missing resources in the resource bundle.
Type:
Use: optional
Values
NullNull is returned for the missing resource.
EmptyAn empty string is returned for the missing resource.
KeyThe key is returned for the missing resources.
ErrorAn exception is thrown when the resource with the specified key is missing.
Default: Null

isIgnorePagination
Flag used to specify whether to use pagination.

This attribute can be overridden at fill time by the IS_IGNORE_PAGINATION parameter.
Type:
Use: optional
Values
trueThe report will be generated on one long page. The specified page height will still be used for report design.
falseThe report will be paginated according to the pageHeight attribute.
Default: false

formatFactoryClass
Specifies the name of the class implementing the net.sf.jasperreports.engine.util.FormatFactory interface to use with this report. If omitted, an instance of net.sf.jasperreports.engine.util.DefaultFormatFactory will be created.
Type: string
Use: optional

uuid
This attribute is auto-generated and is used to uniquely identify JRXMLs.
Type: string
Use: optional

top

keyExpression
Defines a key in a <pieDataset> or <pieSeries>

top

labelExpression
Defines a label in a <pieDataset> or <pieSeries>.

top

labelExpression (in axisLevel)

top

labelExpression (in multiAxisMeasure)

top

labelFont
Specifies the font to use when drawing the label of an axis in a chart. The label of an axis is the text that describes the axis.

Contains
font?

top

lastPageFooter
The page footer section to use on the last page instead of the normal page footer. This might not be the very last page of the document in case the summary section is also present. This section is sometimes useful when summary information has to be displayed at the bottom of the last page.

Contains
band?

top

leftPen
Groups the properties of the pen used to draw left lines or borders.

Attributes

lineWidth
The line width of the pen.
Type: NMTOKEN
Use: optional

lineStyle
The line style of the pen.
Type:
Use: optional
Values
SolidSolid line.
DashedDashed line.
DottedDotted line.
DoubleDouble line.

lineColor
Line color for the pen. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white.
Type: string
Use: optional

top

line
Definition of a line object.

Contains
reportElement
graphicElement?

Attributes

direction
Lines are drawn as diagonals of the rectangle defined by the report element properties. This attribute specifies which of the two diagonals should be drawn.
Type:
Use: optional
Values
TopDownThe diagonal that starts in the top-left corner of the rectangle will be drawn.
BottomUpThe diagonal that starts in the bottom-left corner of the rectangle will be drawn.
Default: TopDown

top

lineChart
Defines a line chart

Contains
chart
categoryDataset
linePlot

top

linePlot
Defines plot options for a <lineChart>

Contains
plot
categoryAxisLabelExpression?
categoryAxisFormat?
valueAxisLabelExpression?
valueAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

isShowLines
Show lines flag.
Type:
Use: optional
Values
true
false

isShowShapes
Show shapes flag.
Type:
Use: optional
Values
true
false

top

lowExpression
Low expresion in a <highLowchart>.

top

lowRange
Defines the low range in a <thermometerChart>.

Contains
dataRange

top

measure
Crosstab measure definition.

A measure is a value accumulated by the crosstab calculation engine and displayed in the crosstab data cells.

Each measure in the crosstab has a variable that can be used inside the data cells as the current measure value. The variable has the same name and type as the measure.

Variables representing totals at different levels are also available. The names of these variables are:
  • <Measure>_<Row/Column Group>_ALL - the total for the column/row group
  • <Measure>_<Row Group>_<Column Group>_ALL - the combined total for the column and row groups

For instance, if one defines "Year" and "Month" column groups, a "City" row group and a "Sales" measure, then:
  • Sales_Month_ALL will hold the total for all months (i.e. for one year)
  • Sales_City_Month_ALL will hold the total for all months (one year) and all cities
  • Sales_City_Year_ALL will hold the grand total

Contains
measureExpression?

Attributes

name
Measure name.
Type: string
Use: required

class
The measure values class.
Type: string
Use: optional

calculation
The calculation type to be performed on the measure values.
Type: jr:aggregationCalculationType
Use: optional
Default: Nothing

incrementerFactoryClass
The name of a class that implements the net.sf.jasperreports.engine.fill.JRIncrementerFactory interface to use when creating the incrementer instance for this measure. Incrementers are objects that implement the net.sf.jasperreports.engine.fill.JRIncrementer interface and handle the incremental calculation performed on the measure's current value with every entry in the crosstab dataset.
Type: string
Use: optional

percentageOf
The percentage calculation type performed on this measure.

If percentage calculation is required, the value class should be one of the built-in supported percentage types or the percentage calculator class should be specified. The classes with built-in support are java.lang.Float, java.lang.Double, java.lang.Byte, java.lang.Short, java.lang.Integer, java.lang.Long, java.math.BigDecimal and java.math.BigInteger.
Type:
Use: optional
Values
NoneThe value will not be calculated as a percentage
GrandTotalThe value will be calculated as percentage of the grand total value
Default: None

percentageCalculatorClass
The percentage calcualtor class name.

The class should implement the net.sf.jasperreports.crosstabs.fill.JRPercentageCalculator interface.
Type: string
Use: optional

top

measureExpression
Crosstab measure expression.

top

mediumRange
Defines the medium range in a <thermometerChart>.

Contains
dataRange

top

meterChart
Defines a meter chart. A meter chart plots a single value on a dial. In addition to the value being plotted multiple ranges can be specified to help interpret the value.

Contains
chart
valueDataset
meterPlot

top

meterInterval
Describes a range of a <meterChart> to highlight. A typical use is to divide a meter up into sections such as "normal", "warning" and "critical" and color code them.

Contains
dataRange

Attributes

label
The name of this region. The name will appear in the meter's legend if the legend is being displayed.
Type: string
Use: optional

color
The color used to shade the region in the meter. If not set the region will have no visual indicator.
Type: string
Use: optional

alpha
The alpha (transparency) of the shading for the region. The values range from 0.0 (completely transparent) to 1.0 (completely opaque).
Type: string
Use: optional

top

meterPlot
Plot options for a <meterChart>.

Contains
plot
tickLabelFont?
valueDisplay?
dataRange
meterInterval*

Attributes

shape
Defines the shape of the meter. The final appearance is determined by the combination of this attribute and the angle attribute. This attribute only matters when the meter is using an angle over 180 degrees.

When a meter is over 180 degrees wide the space between the start and end of the meter can be filled in several different ways. The best way to visualize this is to think of a twelve hour clock. If the angle of the meter is 240 degrees the meter will start at 8, sweep up past 12 and down to 4. This attribute specifies how to fill the area between 4 o'clock and 8 o'clock.

Type:
Use: optional
Values
chordA straight line is drawn between the start point and the end point, and the area bounded by the meter and this line is shaded with the background color.
circleThe unused portion of the circle that describes the meter is shaded with the background color.
pieThe unused portion of the circle that describes the meter is not shaded at all.
dialThe unused portion of the circle that describes the meter is shaded with the background color and handled with specific dial objects.

angle
The extent of the meter in degrees. Use 180 for a semicircle.
Type: string
Use: optional

units
An optional string that describes the unit that the meter is displaying. This string will be appended to the value.
Type: string
Use: optional

tickInterval
The amount of space between values to mark as "ticks" on the face of the meter. If the meter has a data range of 0-100 and the tick interval is 20, there will be 4 ticks at 20, 40, 60 and 80.
Type: string
Use: optional

meterColor
The color of meter. If <meterIntervals> are defined they may mask this color.
Type: string
Use: optional

needleColor
The color used to draw the needle in the meter.
Type: string
Use: optional

tickColor
The color of the meter ticks, if any.
Type: string
Use: optional

tickCount
The number of major ticks on the meter scale.
Type: string
Use: optional

top

multiAxisChart
Definition of chart with multiple range axis, all sharing a common domain axis. The domain is determined by the dataset of each nested report, and they must all use the same type of dataset. The time period datasets (highLowDataset, candlestickDataset and timeSeriesDataset) are considered the same and can be mixed.

Each nested chart has its own range, so you can combine charts with significantly different scales. Each chart will have its own axis showing its range, and it is highly recommended to color the data series and the axis to match.

The plot options of the nested reports are ignored - the plot is configured via the multiAxisPlot. The only exception to this is any seriesColors specified in the plot of a nested report, which will be used to color a specific series in that report. In this case the seriesOrder in the seriesColor is an absolute specification of a series to color, not a relative ordering.

Contains
chart
multiAxisPlot

top

multiAxisData

Contains
multiAxisDataset?
dataAxis*
multiAxisMeasure*

top

multiAxisDataset

Contains
dataset?

top

multiAxisMeasure

Contains
labelExpression
valueExpression?

Attributes

name
Type: string
Use: required

class
Type: string
Use: optional

calculation
Type: jr:aggregationCalculationType
Use: optional
Default: Nothing

incrementerFactoryClass
Type: string
Use: optional

top

multiAxisPlot
Plot options for a <multiAxisChart>. The set plot options will be shared by all the charts inside this plot, and the nested charts are specified via the <axis> tags. All nested charts must share the same type of domain axis - a category, a numeric (xy) or a time based axis.

Contains
plot
axis*

top

noData
Definition of the noData section for this report. The noData section is printed only if whenNoDataType attribute is set to "NoDataSection".

Contains
band?

top

openExpression
Open expression for a <candlestickChart>

top

orderByExpression
Expression that provides order by values for group buckets. If not set, the bucket values as returned by bucketExpression are used to order the buckets.

The expression is evaluated in the context of the crosstab group and can reference measure variables, which evaluate to group totals.


Attributes

class
Type: string
Use: optional

top

otherKeyExpression

top

otherLabelExpression

top

otherSectionHyperlink

Contains
hyperlinkReferenceExpression?
hyperlinkWhenExpression?
hyperlinkAnchorExpression?
hyperlinkPageExpression?
hyperlinkTooltipExpression?
hyperlinkParameter*

Attributes

hyperlinkType
Indicates the type of the hyperlink element.

The type can be:

Type: string
Use: optional

hyperlinkTarget
Indicates the target of the hyperlink.
Type: string
Use: optional

top

pageFooter
Definition of the page footer section for this report. The page footer is printed at the bottom of each page on the report.

Contains
band?

top

pageHeader
Definition of the page header section for this report. The page header is printed at the beginning of each page on the report.

Contains
band?

top

paragraph
Paragraph properties for text elements.

Contains
tabStop*

Attributes

lineSpacing
Type of line spacing for the text object.
Type:
Use: optional
Values
SingleNormal line spacing
1_1_2Medium line spacing.
DoubleDouble line spacing
AtLeastLine spacing is at least the amount specified by lineSpacingSize.
FixedLine spacing is exactly as specified bye lineSpacingSize.
ProportionalLine spacing is normal line spacing multiplied by lineSpacingSize.

lineSpacingSize
The line spacing size to be used in combination with the line spacing type.
Type: NMTOKEN
Use: optional

firstLineIndent
The indent of the first line of text.
Type: NMTOKEN
Use: optional

leftIndent
The left indent of text.
Type: NMTOKEN
Use: optional

rightIndent
The right indent of text.
Type: NMTOKEN
Use: optional

spacingBefore
The spacing before text.
Type: NMTOKEN
Use: optional

spacingAfter
The spacing after text.
Type: NMTOKEN
Use: optional

tabStopWidth
The tab stop width of the text.
Type: NMTOKEN
Use: optional

top

parameter
Represents the definition of a report parameter. Parameters are very useful for passing data to the report engine and can be used in the expressions or in the query string of the report.

Contains
property*
parameterDescription?
defaultValueExpression?

Attributes

name
Name of the parameter.
Type: string
Use: required

class
Class of the parameter values.
Type: string
Use: optional
Default: java.lang.String

nestedType
Type of the nested elements, if the parameter's value is a collection
Type: string
Use: optional

isForPrompting
Optional flag that might be used by the parent application to prompt the user for the parameter value.
Type:
Use: optional
Values
true
false
Default: true

top

parameterDescription
Can be used to specify a short text description for the parameter and is useful especially when prompting for the user to supply a value for this parameter at runtime.

top

parametersMapExpression
Allows bulk passing the parameters to the subreport/subdataset into a java.lang.Map object. There are cases when we want to pass to the subreport/subdataset the same parameters that the master report has received. This can be achieved by passing the system-defined parameter called REPORT_PARAMETERS_MAP and maybe adding to or overriding those parameters using additional <subreportParameter> elements.

top

parameterValueExpression
Crosstab parameter value expression.

top

patternExpression
Defines the pattern expression to use for this textField.

top

pen
Groups the properties of the pen used to draw lines or borders.

Attributes

lineWidth
The line width of the pen.
Type: NMTOKEN
Use: optional

lineStyle
The line style of the pen.
Type:
Use: optional
Values
SolidSolid line.
DashedDashed line.
DottedDotted line.
DoubleDouble line.

lineColor
The line color of the pen.
Type: string
Use: optional

top

percentExpression
Specifies the expression used to determine the percent in a <ganttSeries>.

top

pie3DChart
Defines a pie chart with 3D effect

Contains
chart
pieDataset
pie3DPlot

top

pie3DPlot
Defines plot options for a <pie3DChart>

Contains
plot
itemLabel?

Attributes

isShowLabels
Show labels flag.
Type:
Use: optional
Values
true
false

depthFactor
Depth factor for a pie chart plot.
Type: string
Use: optional

isCircular
Indicates whether the pie chart is circular, or stretched into an elliptical shape
Type:
Use: optional
Values
true
false

labelFormat
Type: string
Use: optional

legendLabelFormat
Type: string
Use: optional

top

pieChart
Defines a pie type chart

Contains
chart
pieDataset
piePlot

top

pieDataset
Defines a dataset to be used with <pieChart>

Contains
dataset?
pieSeries*
keyExpression?
valueExpression?
labelExpression?
sectionHyperlink?
otherKeyExpression?
otherLabelExpression?
otherSectionHyperlink?

Attributes

minPercentage
Type: NMTOKEN
Use: optional

maxCount
Type: NMTOKEN
Use: optional

top

piePlot
Plot options for a <pieChart>

Contains
plot
itemLabel?

Attributes

isShowLabels
Show labels flag.
Type:
Use: optional
Values
true
false

isCircular
Indicates whether the pie chart is circular, or stretched into an elliptical shape
Type:
Use: optional
Values
true
false

labelFormat
Type: string
Use: optional

legendLabelFormat
Type: string
Use: optional

top

pieSeries

Contains
keyExpression?
valueExpression?
labelExpression?
sectionHyperlink?

top

plot
Defines generic plot options for charts

Contains
seriesColor*

Attributes

backcolor
Background color of the chart
Type: string
Use: optional

orientation
Orientation of the chart
Type:
Use: optional
Values
Horizontal
Vertical

backgroundAlpha
Alpha (transparency) parameter for the background.
Type: NMTOKEN
Use: optional

foregroundAlpha
Alpha (transparency) parameter for the foreground.
Type: NMTOKEN
Use: optional

labelRotation
Deprecated. Replaced by attribute labelRotation of tag <categoryAxisFormat>. Degrees to rotate the text labels for the x axis of the chart. Positive values rotate the text clockwise and negative values rotate it counterclockwise. This attribute has no effect on charts where the x axis is either numeric or a date.
Type: string
Use: optional

top

printWhenExpression
Definition of a Boolean expression that will determine if the element or the band should be printed or not.

top

property
Allows the creation of a name-value pair property for a report object (e.g. the report itself, a field, a parameter, etc).

Attributes

name
Name of the object property.
Type: string
Use: required

value
Value of the object property.
Type: string
Use: optional

top

propertyExpression
Allows the creation of a dynamic name-value pair property for a report element. The contents of this element is interpreted as a java.lang.String expression, which will be evaluated at fill time, the result being used as property value.

Attributes

name
Name of the object property.
Type: string
Use: required

top

queryString
Contains the SQL query that will be used to retrieve the data needed to fill the report.

Attributes

language
Specifies the query language.

Based on the query language, a corresponding net.sf.jasperreports.engine.query.JRQueryExecuterFactory is used to create net.sf.jasperreports.engine.query.JRQueryExecuter instance. The query executer is responsible for executing the query and creating a JRDataSource from the result.

A executer for a query language is registered using a JR propery named net.sf.jasperreports.query.executer.factory.<language>
Type: string
Use: optional
Default: sql

top

rangeAxisMaxValueExpression
Defines the expression for the maximum value on the range axis.

top

rangeAxisMinValueExpression
Defines the expression for the minimum value on the range axis.

top

rectangle
Definition of a rectangle object.

Contains
reportElement
graphicElement?

Attributes

radius
The radius of the arc corner.
Type: NMTOKEN
Use: optional

top

reportElement
Element used to specify the common properties of an object on the report.

Contains
property*
propertyExpression*
printWhenExpression?

Attributes

uuid
This attribute is auto-generated and is used to uniquely identify elements across multiple report templates.
Type: string
Use: optional

key
This attribute is used to identify band elements by their "key" when wanting to alter their settings at runtime. The key value must be unique for elements within report band.
Type: string
Use: optional

style
Name of the report level style to use as base style (see <style> element).
Type: string
Use: optional

positionType
Specifies the object position when the report section is affected by stretch.
Type:
Use: optional
Values
FloatThe element moves relative to the size of the surrounding elements.
FixRelativeToTopThe element maintains its position relative to the top of the band.
FixRelativeToBottomThe element maintains its position relative to the bottom of the band.
Default: FixRelativeToTop

stretchType
Specifies the graphic element stretch behavior when the report section is affected by stretch.
Type:
Use: optional
Values
NoStretchThe graphic element won't stretch vertically as the band stretches to display field data.
RelativeToTallestObjectThe graphic element will stretch to accommodate the tallest object in its group. See the elementGroup element, to see how to group elements in bands.
RelativeToBandHeightThe graphic element will stretch to fit in the band.
Default: NoStretch

isPrintRepeatedValues
This flag allows suppressing the repeating values for the dynamic elements such as text fields and image fields and to fully customize the behavior of the static elements like rectangles, lines, ellipses and static texts.
Type:
Use: optional
Values
trueDynamic elements will print even if their values repeat. Static elements will appear every time the band that contains them is started.
falseSuppresses the repeated values for the dynamic elements. The static elements will print only according to the other 3 attributes: isPrintInFirstWholeBand, isPrintWhenDetailOverflows, printWhenGroupChanges.
Default: true

mode
Specifies whether the background of an object is transparent or opaque.
Type:
Use: optional
Values
Opaque
Transparent

x
Specifies the x coordinate for the object within the band.
Type: NMTOKEN
Use: required

y
Specifies the y coordinate for the object within the band.
Type: NMTOKEN
Use: required

width
Width of the object.
Type: NMTOKEN
Use: required

height
Height of the object.
Type: NMTOKEN
Use: required

isRemoveLineWhenBlank
Collapses the band if the element is not printing and no other element is occupying the same horizontal space.
Type:
Use: optional
Values
true
false
Default: false

isPrintInFirstWholeBand
The element gets printed in the first band of a new page or column that is not an overflow from a previous page or column.
Type:
Use: optional
Values
true
false
Default: false

isPrintWhenDetailOverflows
The element will be printed when the band overflows to a new page or a new column.
Type:
Use: optional
Values
true
false
Default: false

printWhenGroupChanges
The element will be printed when the specified group changes.
Type: string
Use: optional

forecolor
Fore color to use when drawing the object. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white.
Type: string
Use: optional

backcolor
Back color to use when drawing the object. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white.
Type: string
Use: optional

top

reportFont
Represents the definition of a report font. Report fonts are used as default or base font settings in other font definitions throughout the report.

Attributes

name
Name of the report font definition.
Type: string
Use: required

isDefault
The default report font is used as base font for all the font definitions that do not explicitly reference a report font definition.
Type:
Use: optional
Values
true
false
Default: false

fontName
Name of the font.
Type: string
Use: optional

size
Size of the font.
Type: NMTOKEN
Use: optional

isBold
Flag indicating if the font weight is bold
Type:
Use: optional
Values
true
false

isItalic
Flag indicating if the font is italic
Type:
Use: optional
Values
true
false

isUnderline
Flag indicating if the font is underlined
Type:
Use: optional
Values
true
false

isStrikeThrough
Flag indicating if the font is strikethrough
Type:
Use: optional
Values
true
false

pdfFontName
Name of the PDF font.
Type: string
Use: optional

pdfEncoding
Encoding type to use with the PDF font.
Type: string
Use: optional

isPdfEmbedded
Specifies if the PDF font should be embedded in the document.
Type:
Use: optional
Values
true
false

top

returnValue
Maps a subreport variable to a master report variable in order to allow returning values from subreport to the master report.

Attributes

subreportVariable
Name of the subreport variable whose value will be returned to the master report.
Type: string
Use: optional

toVariable
Name of the master report variable to which the value is returned. This should be a variable with calculation="System"
Type: string
Use: optional

calculation
Calculation to perform on the master report variable when returning the value from the subreport.
Type:
Use: optional
Values
NothingNo calculations are performed.
CountVariable stores the number of the not null values returned from the subreport.
DistinctCountVariable stores the number of distinct not null values returned from the subreport.
SumVariable stores the sum of the not null values returned from the subreport. Numeric variables only.
AverageVariable stores the average of the not null values returned from the subreport. Numeric variables only.
LowestVariable stores the lowest value returned from the subreport.
HighestVariable stores the highest value returned from the subreport.
StandardDeviationVariable stores the standard deviation of the not null values returned from the subreport. Numeric variables only.
VarianceVariable stores the variance of the not null values returned from the subreport. Numeric variables only.
FirstVariable stores the first value encountered and ignores subsequent values.
Default: Nothing

incrementerFactoryClass
The name of a class that implements the net.sf.jasperreports.engine.fill.JRIncrementerFactory interface to use when creating the incrementer instance to handle the value returned from the subreport.
Type: string
Use: optional

top

returnValue (in datasetRun)

top

rightPen
Groups the properties of the pen used to draw right lines or borders.

Attributes

lineWidth
The line width of the pen.
Type: NMTOKEN
Use: optional

lineStyle
The line style of the pen.
Type:
Use: optional
Values
SolidSolid line.
DashedDashed line.
DottedDotted line.
DoubleDouble line.

lineColor
Line color for the pen. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white.
Type: string
Use: optional

top

rowGroup
Crosstab row group definition.

Each group in the crosstab has a variable that can be used inside the group header or inside the crosstab cells as the current group value. The variable has the same name as the group and the same type as the bucket expression of the group.

Contains
bucket
crosstabRowHeader?
crosstabTotalRowHeader?

Attributes

name
Group name.
Type: string
Use: required

width
The width of the row group header.
Type: NMTOKEN
Use: required

totalPosition
The position of the total row for this group.

A group can have a total row summing the values for all the entries in the group. E.g. if there is a Year group having Month as a subgroup, the total row for the Year group would sum the values for all the years and the total row for the Month group would sum the values for all the months of an year.
Type:
Use: optional
Values
StartThe total row will be displayed before the group rows.
EndThe total row will be displayed after the group rows.
NoneThe total row will not be displayed.
Default: None

headerPosition
The position of the header contents on header span.

The row group headers stretch vertically by spanning when there are multiple sub group entries. This attribute determines the way the header contents will be adjusted to the new height.
Type:
Use: optional
Values
TopThe contents will be rendered at the top of the header
MiddleThe contents will be rendered on the center of the header
BottomThe contents will be rendered at the bottom of the header
StretchThe contents will be proportionally stretched to the new header height
Default: Top

top

scatterChart
Defines a scatter chart

Contains
chart
xyDataset
scatterPlot

top

scatterPlot
Specifies the plot options for a <scatterChart>

Contains
plot
xAxisLabelExpression?
xAxisFormat?
yAxisLabelExpression?
yAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

isShowLines
Show lines flag
Type:
Use: optional
Values
true
false

isShowShapes
Show shapes flag
Type:
Use: optional
Values
true
false

top

scriptlet

Contains
property*
scriptletDescription?

Attributes

name
Type: string
Use: required

class
Type: string
Use: required

top

scriptletDescription

top

sectionHyperlink
Hyperlink specification for pie chart sections. This hyperlink definition will be evaluated for every chart section and a image map will be created for the chart.

Contains
hyperlinkReferenceExpression?
hyperlinkWhenExpression?
hyperlinkAnchorExpression?
hyperlinkPageExpression?
hyperlinkTooltipExpression?
hyperlinkParameter*

Attributes

hyperlinkType
Indicates the type of the hyperlink element.

The type can be:

Type: string
Use: optional

hyperlinkTarget
Indicates the target of the hyperlink.
Type: string
Use: optional

top

seriesColor
Defines the color to use for a series in the report. If only one seriesColor is specified it becomes the color of the first series. If more than one seriesColor is specified the chart will cycle through the supplied colors. Meter and Thermometer charts do not have series and will ignore any seriesColor settings.

When used in a chart that part of a multi-axis chart series color is treated a bit differently. The default color series to cycle through is defined in the plot of the multi axis chart, and the color series for the nested charts define series colors for that chart only. This is useful when a multiple axis chart contains several line charts, each with one series. By default every line will be the first in its plot and will have the first color defined in the multi axis plot, so every line will be the same color. To solve this you can set a seriesColor for each nested chart to override the default colors.

Attributes

seriesOrder
The relative order of this color. All seriesColors are sorted by the value of this attribute, and appear in that order when coloring the series.

When the chart is nested inside a multiple axis chart the seriesOrder is the actual series number to apply the color to. Series use zero-based indexing.
Type: string
Use: required

color
The color to use for the series
Type: string
Use: required

top

seriesExpression
Defines a series expression in a dataset

top

sortField
Introduces a field to use for sorting the data source.

Attributes

name
Name of the report field to use for sorting.
Type: string
Use: required

order
The sort order for the field.
Type:
Use: optional
Values
Ascending
Descending
Default: Ascending

type
The type of the sort field.
Type:
Use: optional
Values
Field
Variable
Default: Field

top

stackedAreaChart
Defines a stacked area chart

Contains
chart
categoryDataset
areaPlot

top

stackedBar3DChart
Defines a stacked bar chart with 3D effect

Contains
chart
categoryDataset
bar3DPlot

top

stackedBarChart
Defines a stacked bar chart

Contains
chart
categoryDataset
barPlot

top

startDateExpression

top

staticText
Definition of a static text object.

Contains
reportElement
box?
textElement?
text?

top

style
Definition of a report style.

Contains
pen?
box?
paragraph?
conditionalStyle*

Attributes

name
Name of the report style definition.
Type: string
Use: optional

isDefault
The default report style is used as base style for all the elements that do not explicitly reference a report style definition.
Type:
Use: optional
Values
true
false

style
Parent style reference.
Type: string
Use: optional

mode
Type:
Use: optional
Values
Opaque
Transparent

forecolor
Type: string
Use: optional

backcolor
Type: string
Use: optional

pen
Deprecated. Replaced by tag <pen>.
Type:
Use: optional
Values
None
Thin
1Point
2Point
4Point
Dotted

fill
Type:
Use: optional
Values
Solid

radius
Type: NMTOKEN
Use: optional

scaleImage
Type:
Use: optional
Values
Clip
FillFrame
RetainShape
RealHeight
RealSize

hAlign
Type:
Use: optional
Values
Left
Center
Right
Justified

vAlign
Type:
Use: optional
Values
Top
Middle
Bottom

border
Deprecated. Replaced by tag <box>.
Type:
Use: optional
Values
None
Thin
1Point
2Point
4Point
Dotted

borderColor
Deprecated. Replaced by tag <box>.
Type: string
Use: optional

padding
Deprecated. Replaced by tag <box>.
Type: NMTOKEN
Use: optional

topBorder
Deprecated. Replaced by tag <box>.
Type:
Use: optional
Values
None
Thin
1Point
2Point
4Point
Dotted

topBorderColor
Deprecated. Replaced by tag <box>.
Type: string
Use: optional

topPadding
Deprecated. Replaced by tag <box>.
Type: NMTOKEN
Use: optional

leftBorder
Deprecated. Replaced by tag <box>.
Type:
Use: optional
Values
None
Thin
1Point
2Point
4Point
Dotted

leftBorderColor
Deprecated. Replaced by tag <box>.
Type: string
Use: optional

leftPadding
Deprecated. Replaced by tag <box>.
Type: NMTOKEN
Use: optional

bottomBorder
Deprecated. Replaced by tag <box>.
Type:
Use: optional
Values
None
Thin
1Point
2Point
4Point
Dotted

bottomBorderColor
Deprecated. Replaced by tag <box>.
Type: string
Use: optional

bottomPadding
Deprecated. Replaced by tag <box>.
Type: NMTOKEN
Use: optional

rightBorder
Deprecated. Replaced by tag <box>.
Type:
Use: optional
Values
None
Thin
1Point
2Point
4Point
Dotted

rightBorderColor
Deprecated. Replaced by tag <box>.
Type: string
Use: optional

rightPadding
Deprecated. Replaced by tag <box>.
Type: NMTOKEN
Use: optional

rotation
Type:
Use: optional
Values
None
Left
Right
UpsideDown

lineSpacing
Type:
Use: optional
Values
Single
1_1_2
Double

isStyledText
Deprecated. Replaced by attribute markup.
Type:
Use: optional
Values
true
false

markup
Type: string
Use: optional

fontName
Type: string
Use: optional

fontSize
Type: NMTOKEN
Use: optional

isBold
Type:
Use: optional
Values
true
false

isItalic
Type:
Use: optional
Values
true
false

isUnderline
Type:
Use: optional
Values
true
false

isStrikeThrough
Type:
Use: optional
Values
true
false

pdfFontName
Type: string
Use: optional

pdfEncoding
Type: string
Use: optional

isPdfEmbedded
Type:
Use: optional
Values
true
false

pattern
Type: string
Use: optional

isBlankWhenNull
Type:
Use: optional
Values
true
false

top

subDataset
Definition of a dataset. A dataset can be used to feed data not present in the report to charts and crosstabs without using subreports.

Contains
property*
scriptlet*
parameter*
queryString?
field*
sortField*
variable*
filterExpression?
group*

Attributes

name
Name of the dataset.
Type: string
Use: required

scriptletClass
Indicates which class implements the scriptlets functionality for this dataset. The specified class must be a subclass of JRAbstractScriptlet class. If omitted, an instance of JRDefaultScriptlet will be created.
Type: string
Use: optional

resourceBundle
The base name of the dataset associated resource bundle.
Type: string
Use: optional

whenResourceMissingType
Allows customizing the way the engine deals with missing resources in the resource bundle.
Type:
Use: optional
Values
NullNull is returned for the missing resource.
EmptyAn empty string is returned for the missing resource.
KeyThe key is returned for the missing resources.
ErrorAn exception is thrown when the resource with the specified key is missing.
Default: Null

uuid
This attribute is auto-generated and is used to uniquely identify subdatasets.
Type: string
Use: optional

top

subreport
Definition of a subreport object.

Contains
reportElement
parametersMapExpression?
subreportParameter*
( connectionExpression? | dataSourceExpression? )?
returnValue*
subreportExpression?

Attributes

isUsingCache
If true, tells the report engine to cache the report definition objects that are loaded from the same location.
Type:
Use: optional
Values
true
false

runToBottom
Flag to specify if the subreport should consume all the available space on the current page. When this flag is set, the subreport would consume the entire vertical space available on the master page, and its column and page footers will be printed at the bottom of this space.
Type:
Use: optional
Values
true
false

overflowType
Determines what happens when the subreport contents overflows the element height. If not specified, the subreport will stretch to accomodate the contents.
Type:
Use: optional
Values
StretchThe subreport stretches to to accomodate the overflown contents.
NoStretchThe contents do not stretch beyond the subreport element height. The band on which the subreport is placed overflows to a new page if allowed, and the subreport contents continues there.

top

subreportExpression
Definition of the expression that will be used to determine the report object that will be loaded as a subreport.

Attributes

class
Class of the image source.
Type:
Use: optional

top

subreportParameter
Definition of a subreport parameter.

Contains
subreportParameterExpression?

Attributes

name
The name of the parameter that will be passed when filling the subreport.
Type: string
Use: required

top

subreportParameterExpression
Definition of the expression associated with the subreport parameter.

top

subtaskExpression
Specifies the expression used to determine subtasks in a <ganttSeries>.

top

subtitleExpression
Defines the expression for the chart subtitle

top

summary
Definition of the summary section for this report. The summary section is printed only once at the end of the report.

Contains
band?

top

tabStop
Custom tab stop definition.

Attributes

alignment
The alignment of the custom tab stop.
Type:
Use: optional
Values
LeftLeft aligned tab stop.
CenterCenter aligned tab stop.
RightRight aligned tab stop.

position
The position of the custom tab stop.
Type: NMTOKEN
Use: required

top

taskExpression
Specifies the expression used to determine tasks in a <ganttSeries>.

top

template
A style template (*.jrtx file/JRTemplate instance) included in a report. The contents of this element is interpreted as an expression which is resolved to a style template at fill time.

Attributes

class
Class for the style template source expression.
Type:
Use: optional
Default: java.lang.String

top

text
Specifies the text to print for a static text object.

top

textElement
Element used to specify the common properties of a text object on the report (<staticText> or <textField>).

Contains
font?
paragraph?

Attributes

textAlignment
Type of alignment for the text object.
Type:
Use: optional
Values
LeftText is aligned to the left.
CenterText is centered.
RightText is aligned to the right.
JustifiedText is justified.

verticalAlignment
Type of vertical alignment for the text object.
Type:
Use: optional
Values
TopText is aligned to the top.
MiddleText is vertically centered.
BottomText is aligned to the bottom.

rotation
Type of rotation for the text object.
Type:
Use: optional
Values
NoneText runs horizontally from left to right and from top to bottom.
LeftText runs vertically from bottom to top and from left to right.
RightText runs vertically from top to bottom and from right to left.
UpsideDownText is rotated with 180 degrees.

lineSpacing
Type of line spacing for the text object.
Type:
Use: optional
Values
SingleNormal line spacing
1_1_2Medium line spacing.
DoubleDouble line spacing

isStyledText
Deprecated. Replaced by attribute markup.

When set to true, this attribute signals to the rendering engine that the text element contains preformatted text. Style information can be introduced in the text content using nested <style> tags that support the folowing attributes : fontName, size, isBold, isItalic, isUnderline, isStrikeThrough, pdfFontName, pdfEncoding, isPdfEmbedded, forecolor, backcolor.
Type:
Use: optional
Values
trueThe text element contains text formatted using nested <style> tags.
falseThe text element has a pure text content, without style information.

markup
Specifies the name of the markup language used to embed style information into the text content. Supported values are none (plain text), styled (styled text), rtf (RTF format) and html (HTML format), but any custom made markup language can be used as long as there is a net.sf.jasperreports.engine.util.MarkupProcessorFactory implementation specified using a net.sf.jasperreports.markup.processor.factory.{markup} configuration property.
Type: string
Use: optional

top

textField
Definition of a text field object.

Contains
reportElement
box?
textElement?
textFieldExpression?
patternExpression?
anchorNameExpression?
hyperlinkReferenceExpression?
hyperlinkWhenExpression?
hyperlinkAnchorExpression?
hyperlinkPageExpression?
hyperlinkTooltipExpression?
hyperlinkParameter*

Attributes

isStretchWithOverflow
Instructs the report engine to allow the text field to stretch downwards in order to display all its text when it doesn't fit in the defined text field height.
Type:
Use: optional
Values
true
false
Default: false

evaluationTime
Text to be printed is supplied by the text field associated expression. This expression can be evaluated at a specified moment. This could be useful, for example, when we want to have on the first page the total number of pages. The total number of pages is known only after filling the entire report, so we can specify that the text filed that will represent the total number of pages placed at the beginning of the report should be evaluated only when reaching the end of the report.
Type: jr:complexEvaluationTime
Use: optional
Values
Now
Report
Page
Column
Group
Band
Auto
Default: Now

evaluationGroup
Used to specify the group at which to evaluate the text field value, when evaluationTime is "Group".
Type: string
Use: optional

pattern
Pattern to use when formatting the output of the text field expression.
Type: string
Use: optional

isBlankWhenNull
Specifies that the text field should display a blank character instead of "null" when the text field expression evaluates to null.
Type:
Use: optional
Values
true
false

hyperlinkType
Indicates the type of the hyperlink element.

The type can be:

Type: string
Use: optional

hyperlinkTarget
Indicates the target of the hyperlink.
Type: string
Use: optional

bookmarkLevel
The level of the bookmark corresponding to the anchor.

The PDF exporter can create a bookmark tree using anchors defined in the report. This attributes specifies the level of the tree entry corresponding to this element's anchor. If set to "0" (the default), no bookmark will be created for the anchor.
Type: NMTOKEN
Use: optional
Default: 0

top

textFieldExpression
Defines the expression to use for this textField.

Attributes

class
Class for the text field values.
Type:
Use: optional

top

thermometerChart
Defines a thermometer chart. A thermometer chart plots a single value on a thermometer. In addition to the value being plotted three ranges can be specified to help interpret the value.

Contains
chart
valueDataset
thermometerPlot

top

thermometerPlot
Plot options for a <thermometerChart>.

Contains
plot
valueDisplay?
dataRange
lowRange?
mediumRange?
highRange?

Attributes

valueLocation
Defines where to display the textual representation of the value being displayed, relative to the thermometer outline.
Type:
Use: optional
Values
noneThe textual value is not displayed.
leftThe text value is displayed to the left of the thermometer outline.
rightThe text value is displayed to the right of the thermometer outline.
bulbThe text value is displayed in the bulb at the bottom of the thermometer.
Default: bulb

isShowValueLines
Defines whether or not lines are drawn showing values on the thermometer.
Type:
Use: optional
Values
trueValue lines are drawn.
falseValue lines are not drawn.
Default: false

mercuryColor
The color used to fill the thermometer.

If the value of the thermometer falls in one of the defined ranges the color specified in that range will be used instead of this color.
Type: string
Use: optional

top

tickLabelFont
Specifies the font to use when drawing the label for each tick mark on an axis in a chart.

Contains
font?

top

timeAxisFormat
Specifies the formatting of a time axis, including how to draw the axis line, its label and tick mark labels. If a tick label mask is specified it will be treated as a date mask.

Contains
axisFormat

top

timeAxisLabelExpression
Defines the expression used for the time axis label

top

timePeriodDataset
Defines a time period dataset

Contains
dataset?
timePeriodSeries*

top

timePeriodExpression
Defines the expression used for a time period

top

timePeriodSeries
Defines a time period series for a <timePeriodDataset>

Contains
seriesExpression?
startDateExpression?
endDateExpression?
valueExpression?
labelExpression?
itemHyperlink?

top

timeSeries
Defines a time series for <timeSeriesDataset>.

Contains
seriesExpression?
timePeriodExpression?
valueExpression?
labelExpression?
itemHyperlink?

top

timeSeriesChart
Defines a time series chart.

Contains
chart
timeSeriesDataset
timeSeriesPlot

top

timeSeriesDataset
Defines a time series dataset

Contains
dataset?
timeSeries*

Attributes

timePeriod
Time period for the dataset.
Type:
Use: optional
Values
Year
Quarter
Month
Week
Day
Hour
Minute
Second
Milisecond
Default: Day

top

timeSeriesPlot
Defines plot options for a <timeSeriesChart>

Contains
plot
timeAxisLabelExpression?
timeAxisFormat?
valueAxisLabelExpression?
valueAxisFormat?
domainAxisMinValueExpression?
domainAxisMaxValueExpression?
rangeAxisMinValueExpression?
rangeAxisMaxValueExpression?

Attributes

isShowLines
Show lines flag.
Type:
Use: optional
Values
true
false

isShowShapes
Show shapes flag.
Type:
Use: optional
Values
true
false

top

title
Definition of the title section for this report. The title section appears only once at the beginning of the report.

Contains
band?

top

titleCell (in crosstab)

top

titleExpression
Title expression of the chart

top

topPen
Groups the properties of the pen used to draw top lines or borders.

Attributes

lineWidth
The line width of the pen.
Type: NMTOKEN
Use: optional

lineStyle
The line style of the pen.
Type:
Use: optional
Values
SolidSolid line.
DashedDashed line.
DottedDotted line.
DoubleDouble line.

lineColor
Line color for the pen. Hexadecimal formatted values preceded by the # character or decimal values are accepted along with the following predefined color values: black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, yellow, white.
Type: string
Use: optional

top

valueAxisFormat
Specifies the formatting of a value axis, including how to draw the axis line, its label and tick mark labels. If a tick label mask is specified it will be treated as a numeric mask.

Contains
axisFormat

top

valueAxisLabelExpression
Defines the expression for the value axis of the chart

top

valueDataset
Defines a dataset that contains a single value.

Contains
dataset?
valueExpression

top

valueDisplay
Controls how the single data value is displayed in a <meterChart> or <thermometerChart>.

Contains
font?

Attributes

color
The color to use when displaying the value.
Type: string
Use: optional

mask
The formatting mask to use to display the value. This mask must follow the rules specified for a java.text.DecimalFormat pattern.

This attribute is currently ignored for a <meterChart>.
Type: string
Use: optional

top

valueExpression
Defines the expression for the value of a point in a chart.

top

valueExpression (in genericElementParameter)
Indicates the specific <valueExpression> tag for generic element parameters. Unlike other <valueExpression> elements, it contains a class attribute.

Attributes

class
Type: string
Use: optional
Default: java.lang.Object

top

valueExpression (in multiAxisMeasure)

top

variable
Represents the definition of a report variable. Variables are objects that store the values of their associated expressions or perform various calculations on those expression values. Expressions are java expressions build on top of fields and variables declared in the report. They are evaluated at runtime, when filling the report.

Contains
variableExpression?
initialValueExpression?

Attributes

name
Name of the variable.
Type: string
Use: required

class
Class of the variable values.
Type: string
Use: optional
Default: java.lang.String

resetType
Reset level for variables that perform calculations.
Type:
Use: optional
Values
NoneVariable is never initialized using the initial value expression and only holds the values obtained by evaluating its main expression.
ReportVariable is initialized only once, at the beginning of the report.
PageVariable is initialized at the beginning of each page.
ColumnVariable is initialized at the beginning of each column.
GroupVariable is initialized when the group specified by the resetGroup attribute changes.
Default: Report

resetGroup
Name of the group at which the variable is reinitialized, when resetType is "Group".
Type: string
Use: optional

incrementType
Increment level for variables that perform calculations.
Type:
Use: optional
Values
NoneVariable is incremented with every record in the data source.
ReportVariable is incremented only once, at the end of the report.
PageVariable is incremented at the end of each page.
ColumnVariable is incremented at the end of each column.
GroupVariable is incremented when the group specified by the incrementGroup attribute changes.
Default: None

incrementGroup
Name of the group at which the variable is incremented, when incrementType is "Group".
Type: string
Use: optional

calculation
Calculation to perform on the variable expression when filling the report.
Type:
Use: optional
Values
NothingNo calculations are performed.
CountVariable stores the number of the not null values encountered for the variable expression.
DistinctCountVariable stores the number of distinct not null values encountered for the variable expression.
SumVariable stores the sum of the not null values encountered for the variable expression. Numeric variables only.
AverageVariable stores the average of the not null values encountered for the variable expression. Numeric variables only.
LowestVariable stores the lowest value encountered for the variable expression.
HighestVariable stores the highest value encountered for the variable expression.
StandardDeviationVariable stores the standard deviation of the not null values encountered for the variable expression. Numeric variables only.
VarianceVariable stores the variance of the not null values encountered for the variable expression. Numeric variables only.
SystemVariable stores a system (custom) calculated value.
FirstVariable stores the first value encountered and ignores subsequent values.
Default: Nothing

incrementerFactoryClass
The name of a class that implements the net.sf.jasperreports.engine.fill.JRIncrementerFactory interface to use when creating the incrementer instance for this variable. Incrementers are objects that implement the net.sf.jasperreports.engine.fill.JRIncrementer interface and handle the incremental calculation performed on the variable's current value with every iteration in the data source.
Type: string
Use: optional

top

variableExpression
Definition of the expression associated with the variable. The value of this expression will be calculated at runtime and will represent the value of the corresponding variable or it will be used in calculation to obtain the value of the calculated variable.

top

volumeExpression
Defines the volumeExpression for a <highLowDataset>

top

whenNoDataCell
Crosstab cell that will be rendered when no data was fed to the crosstab.

If this cell is not specified for a crosstab, nothing will be rendered for an empty crosstab.

The cell size is the same as the crosstab element size.

Contains
cellContents

top

xAxisFormat
Specifies the formatting of an x axis, including how to draw the axis line, its label and tick mark labels. If a tick label mask is specified it will be treated as a numeric mask.

Contains
axisFormat

top

xAxisLabelExpression
Defines the expression for the label of the X axis of the chart

top

xValueExpression
Defines the expression for the value of the X axis of the chart.

top

xyAreaChart
Defines a area chart that uses an <xyDataset>

Contains
chart
xyDataset
areaPlot

top

xyBarChart
Defines a bar chart that uses an <xyDataset>

Contains
chart
( timePeriodDataset | timeSeriesDataset | xyDataset )
barPlot

top

xyDataset
Defines an XY type dataset

Contains
dataset?
xySeries*

top

xyLineChart
Defines a line chart that uses an <xyzDataset>

Contains
chart
xyDataset
linePlot

top

xySeries
Defines a series used in an <xyDataset>

Contains
seriesExpression?
xValueExpression?
yValueExpression?
labelExpression?
itemHyperlink?

Attributes

autoSort
Auto sort values on x-axis.
Type:
Use: optional
Values
true
false

top

xyzDataset
Defines a dataaset used for <bubbleChart>

Contains
dataset?
xyzSeries*

top

xyzSeries
Defines a series in an <xyzDataset>

Contains
seriesExpression?
xValueExpression?
yValueExpression?
zValueExpression?
itemHyperlink?

top

yAxisFormat
Specifies the formatting of a y axis, including how to draw the axis line, its label and tick mark labels. If a tick label mask is specified it will be treated as a numeric mask.

Contains
axisFormat

top

yAxisLabelExpression
Defines the expression for the Y axis label of the chart

top

yValueExpression
Defines the value for the Y axis.

top

zValueExpression
Expression that defines the value for the Z axis in an <xyzSeries>



© 2001- TIBCO Software Inc. www.jaspersoft.com