| |
top |
|
| anchorNameExpression |
| |
| If specified, it will supply the name of the local anchor that will mark to the corresponding element. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| areaChart |
| |
| Defines an area chart |
| Contains |
| (
chart,
categoryDataset,
areaPlot
) |
| Attributes |
|
|
top |
|
| areaPlot |
| |
| Defines rendering options for an <areaChart> |
| Contains |
| (
plot,
categoryAxisLabelExpression?,
categoryAxisFormat?,
valueAxisLabelExpression?,
valueAxisFormat?
) |
| Attributes |
|
|
top |
|
| axis |
| |
| Describes a range axis to use in a
<multiAxisChart>. Each
axis has its own range indicator and a data plot. |
| Contains |
| (
barChart |
bar3DChart |
xyBarChart |
stackedBarChart |
stackedBar3DChart |
lineChart |
xyLineChart |
areaChart |
xyAreaChart |
scatterChart |
bubbleChart |
timeSeriesChart |
highLowChart |
candlestickChart |
stackedBarChart
) |
| Attributes |
|
| |
| position |
| |
| Where relative to the chart to display the range axis
for this chart |
| Values |
|
| |
leftOrTop |
| Display the axis to the left (for charts with
a Vertical orientation) or top (for charts with a
Horizontal orientation.) |
rightOrBottom |
| Display the axis to the right (for charts with
a Vertical orientation) or bottom (for charts with a
Horizontal orientation.) |
|
Default leftOrTop |
|
top |
|
| axisFormat |
| |
| |
| Contains |
| (
labelFont?,
tickLabelFont?
) |
| Attributes |
|
| |
| labelColor |
| |
| The color to use for the caption of the axis. |
Required false |
| tickLabelColor |
| |
| The color to use for the label of each tick mark on the axis. |
Required false |
| 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.
|
Required false |
| lineColor |
| |
| The color to use when drawing the line showing the axis. |
Required false |
|
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?
) |
| Attributes |
|
|
top |
|
| band |
| |
| Generic definition of a report section. |
| Contains |
| (
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 |
elementGroup |
crosstab |
frame
)*) |
| Attributes |
|
| |
| height |
| |
| Height of the band. |
Default 0 |
| isSplitAllowed |
| |
| Flag that indicates if the band is allowed to split when it stretches. |
| Values |
|
| |
true |
| Page breaks are accepted within this band. |
false |
| When 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. |
|
Default true |
|
top |
|
| bar3DChart |
| |
| Defines a bar chart with 3D effect |
| Contains |
| (
chart,
categoryDataset,
bar3DPlot
) |
| Attributes |
|
|
top |
|
| bar3DPlot |
| |
| Defines plot options for a bar chart with 3D effect |
| Contains |
| (
plot,
categoryAxisLabelExpression?,
categoryAxisFormat?,
valueAxisLabelExpression?,
valueAxisFormat?
) |
| Attributes |
|
| |
| isShowLabels |
| |
| Show labels flag |
| Values |
|
|
Default false |
| xOffset |
| |
| Offset on the x axis |
| yOffset |
| |
| Offset on the y axis |
|
top |
|
| barChart |
| |
| Defines a bar chart. Dataset used with this chart is <categoryDataset> |
| Contains |
| (
chart,
categoryDataset,
barPlot
) |
| Attributes |
|
|
top |
|
| barPlot |
| |
| Plot options for a <barChart> |
| Contains |
| (
plot,
categoryAxisLabelExpression?,
categoryAxisFormat?,
valueAxisLabelExpression?,
valueAxisFormat?
) |
| Attributes |
|
| |
| isShowLabels |
| |
| Show labels flag |
| Values |
|
|
Default false |
| isShowTickMarks |
| |
| Show tick marks on the value axis |
| Values |
|
|
Default true |
| isShowTickLabels |
| |
| Show tick labels on the value axis |
| Values |
|
|
Default true |
|
top |
|
| bottomPen |
| |
| Groups the properties of the pen used to draw lines or borders. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| lineWidth |
| |
| The line width of the pen. |
Required false |
| lineStyle |
| |
| The line style of the pen. |
| Values |
|
| |
Solid |
| Solid line. |
Dashed |
| Dashed line. |
Dotted |
| Dotted line. |
Double |
| Double line. |
|
Default Solid |
| 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. |
Required false |
|
top |
|
| box |
| |
| Element used to specify the common properties of a graphic object on the report (line, rectangle, ellipse or image). |
| Contains |
| (
pen?,
topPen?,
leftPen?,
bottomPen?,
rightPen?
) |
| Attributes |
|
| |
| border, topBorder, leftBorder, bottomBorder, rightBorder |
| Deprecated. Replaced by tags <pen>, <topPen>, <leftPen>, <bottomPen>, <rightPen>. |
| Type of the border to draw around the element. |
| Values |
|
| |
None |
| No border. |
Thin |
| Thin border. |
1Point |
| Normal border. |
2Point |
| Medium border. |
4Point |
| Thick border. |
Dotted |
| Dotted border. |
|
Default None |
| borderColor, topBorderColor, leftBorderColor, bottomBorderColor, rightBorderColor |
| Deprecated. Replaced by tags <pen>, <topPen>, <leftPen>, <bottomPen>, <rightPen>. |
| Color used to draw the specified border. |
Default forecolor |
| padding, topPadding, leftPadding, bottomPadding, rightPadding |
| |
| The amount of empty space between the border and the element's content. |
Default 0 |
|
top |
|
| break |
| |
| Introduces a page break or column break |
| Contains |
| (
reportElement
) |
| Attributes |
|
| |
| type |
| |
| Specifies the type of the break element. |
| Values |
|
| |
Page |
| Page break. |
Column |
| Column break. |
|
Default Page |
|
top |
|
| bubbleChart |
| |
| Creates a bubble chart |
| Contains |
| (
chart,
xyzDataset,
bubblePlot
) |
| Attributes |
|
|
top |
|
| bubblePlot |
| |
| Plot options for a <bubbleChart> |
| Contains |
| (
plot,
xAxisLabelExpression?,
xAxisFormat?,
yAxisLabelExpression?,
yAxisFormat?
) |
| Attributes |
|
| |
| scaleType |
| |
| Scale options for the bubble chart items |
| Values |
|
| |
BothAxes |
| |
DomainAxis |
| |
RangeAxis |
| |
|
Default RangeAxis |
|
top |
|
| bucket |
| |
| Crosstab group bucketing information. |
| Contains |
| (
bucketExpression,
comparatorExpression?
) |
| Attributes |
|
| |
| order |
| |
| The bucket order type. |
| Values |
|
| |
Ascending |
| The buckets will be sorted in ascending order by using the specified comparator or by the natural order if no comparator specified. |
Descending |
| The buckets will be sorted in descending order by using the specified comparator or by the natural order if no comparator specified. |
|
Default Ascending |
|
top |
|
| bucketExpression |
| |
| Crosstab group bucketing expression. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
| |
| class |
| |
| The bucket values class. |
Required true |
|
top |
|
| candlestickChart |
| |
| Creates a candlestick chart |
| Contains |
| (
chart,
highLowDataset,
candlestickPlot
) |
| Attributes |
|
|
top |
|
| candlestickPlot |
| |
| Plot options for a <candlestickChart> |
| Contains |
| (
plot,
timeAxisLabelExpression?,
timeAxisFormat?,
valueAxisLabelExpression?,
valueAxisFormat?
) |
| Attributes |
|
| |
| isShowVolume |
| |
| Flag that enables showing volume values for a <candlestickChart> |
| Values |
|
|
Default true |
|
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 |
|
|
top |
|
| categoryAxisLabelExpression |
| |
| Expression that will be displayed on category axis |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| categoryDataset |
| |
| Creates a dataset with one or more series and values associated with categories |
| Contains |
| (
dataset,
categorySeries +
) |
| Attributes |
|
|
top |
|
| categoryExpression |
| |
| Defines a category expression in a dataset |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| categorySeries |
| |
| Defines a series that will be mapped on the category axis |
| Contains |
| (
seriesExpression,
categoryExpression,
valueExpression,
labelExpression?,
itemHyperlink?
) |
| Attributes |
|
|
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 |
| (
box?,
(
line |
rectangle |
ellipse |
image |
staticText |
textField |
elementGroup |
frame
)*
) |
| Attributes |
|
| |
| backcolor |
| |
| Crosstab cell background color.
The cell is filled with the background color only if the cell has opaque mode.
|
| mode |
| |
| Crosstab cell transparency mode. |
| Values |
|
|
| 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.
|
|
top |
|
| chart |
| |
| Defines a chart report element |
| Contains |
| (
reportElement,
box?,
chartTitle?,
chartSubtitle?,
chartLegend?
anchorNameExpression?,
hyperlinkReferenceExpression?,
hyperlinkAnchorExpression?,
hyperlinkPageExpression?,
hyperlinkTooltipExpression?,
hyperlinkParameter*
) |
| Attributes |
|
| |
| isShowLegend |
| |
| Show legend flag |
| Values |
|
|
Default true |
| 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. |
| Values |
|
| |
Now |
| The chart is rendered when filling the current band (section). |
Report |
| The chart is rendered when reaching the end of the report. |
Page |
| The chart is rendered when reaching the end of the current page. |
Column |
| The chart is rendered when reaching the end of the current column. |
Group |
| The chart is rendered when the group specified by the evaluationGroup attribute changes. |
Band |
| The chart is rendered after the parent band has finished rendering all the other elements. |
|
Default Now |
| evaluationGroup |
| |
| Used to specify the group at which to render the chart, when evaluationTime is "Group". |
| hyperlinkType |
| |
|
Indicates the type of the hyperlink element.
The type can be:
One of the built-in types:
None
The current element doesn't represent a hyperlink.
Reference
The current hyperlink points to an external resource specified by the corresponding <hyperlinkReferenceExpression> element, usually an URL.
LocalAnchor
The current hyperlink points to a local anchor specified by the corresponding <hyperlinkAnchorExpression> element.
LocalPage
The current hyperlink points to a 1 based page index within the current document specified by the corresponding <hyperlinkPageExpression> element.
RemoteAnchor
The current hyperlink points to an anchor specified by the <hyperlinkAnchorExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
RemotePage
The current hyperlink points to a 1 based page index specified by the <hyperlinkPageExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
A custom (arbitrary) type.
|
Default None |
| hyperlinkTarget |
| |
| Indicates the target of the hyperlink. |
| Values |
|
| |
Self |
| Loads the hyperlink destination document into the window in which the link was clicked. |
Blank |
| Loads the hyperlink destination document into a new blank window. |
|
Default Self |
| 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.
|
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.
|
|
top |
|
| chartLegend |
| |
| Specifies layout options for the legend of a chart. |
| Contains |
| (
font?
) |
| Attributes |
|
| |
| textColor |
| |
| The color of the text in the legend. |
Required false |
| backgroundColor |
| |
| The color of the background of the legend. |
Required false |
|
top |
|
| chartSubtitle |
| |
| Subtitle of the chart |
| Contains |
| (
font?,
subtitleExpression?
) |
| Attributes |
|
| |
| color |
| |
| Color of the subtitle text |
|
top |
|
| chartTitle |
| |
| Title text of the chart |
| Contains |
| (
font?,
titleExpression?
) |
| Attributes |
|
| |
| position |
| |
| Position of the title |
| Values |
|
|
Default Top |
| color |
| |
| Color of the title text |
|
top |
|
| closeExpression |
| |
| Expression for the close value for <candlestickChart> |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
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,
crosstabColumnHeader?,
crosstabTotalColumnHeader?
) |
| Attributes |
|
| |
| name |
| |
| Group name. |
Required true |
| height |
| |
| The height of the column group header. |
Required true |
| 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.
|
| Values |
|
| |
Start |
| The total column will be displayed before the group column. |
End |
| The total column will be displayed after the group column. |
None |
| The 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.
|
| Values |
|
| |
Left |
| The contents will be rendered on the left side of the header |
Center |
| The contents will be rendered on the center of the header |
Right |
| The contents will be rendered on the right side of the header |
Stretch |
| The contents will be proportionally stretched to the new header width |
|
Default Left |
|
top |
|
| comparatorExpression |
| |
| Crosstab group bucket comparator expression.
The result of this expression is used to sort the buckets, in ascending or descending order.
If no comparator expression is specified, the natural order will be used.
|
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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
) |
| Attributes |
|
|
top |
|
| conditionExpression |
| |
| A boolean expression which indicates if the style properties associated with it should be applied to the parent style.
|
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| connectionExpression |
| |
| If present, it is used to pass the java.sql.Connection object to the subreport filling or subdataset iteration routines. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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,
crosstabParameter*,
parametersMapExpression?,
crosstabDataset?,
crosstabHeaderCell?,
rowGroup*,
columnGroup*,
measure*,
crosstabCell*,
whenNoDataCell?
) |
| Attributes |
|
| |
| isRepeatColumnHeaders |
| |
| Flag that indicates whether the column headers will be reprinted after a page break. |
| Values |
|
| |
true |
| The column headers will be reprinted after a page break. |
false |
| The 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. |
| Values |
|
| |
true |
| The row headers will be reprinted after a crosstab column break. |
false |
| The 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.
|
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.
|
| Values |
|
| |
LTR |
| Left to right run direction. |
RTL |
| Right to left run direction. |
|
Default LTR |
|
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).
|
| height |
| |
| Crosstab cell height.
The height should be specified only for the base cell of a row (the one with no columnTotalGroup).
|
| 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.
|
| 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.
|
|
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?
) |
| Attributes |
|
|
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.
|
| Values |
|
| |
true |
| The calculation engine will assume that the data is presorted. If the data is not presorted, the outcome is undefined. |
false |
| The crosstab dataset data is not presorted. |
|
Default false |
|
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
) |
| Attributes |
|
|
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. |
Required true |
| class |
| |
| Class of the parameter values. |
Required true |
|
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?
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
top |
|
| dataset |
| |
| Dataset definition for a chart or crosstab. |
| Contains |
| (
incrementWhenExpression?,
datasetRun?
) |
| Attributes |
|
| |
| resetType |
| |
| Reset type for the dataset |
| Values |
|
| |
None |
| |
Report |
| |
Page |
| |
Column |
| |
Group |
| |
|
Default Report |
| resetGroup |
| |
| Reset group name |
| incrementType |
| |
| incrementType description |
| Values |
|
| |
None |
| |
Report |
| |
Page |
| |
Column |
| |
Group |
| |
|
Default Report |
| incrementGroup |
| |
| Increment group of the dataset |
|
top |
|
| datasetParameter |
| |
| Definition of a subdataset parameter. |
| Contains |
| (
datasetParameterExpression?
) |
| Attributes |
|
| |
| name |
| |
| The name of the parameter that will be passed when iterating the subdataset. |
Required true |
|
top |
|
| datasetParameterExpression |
| |
| Definition of the expression associated with the subdataset parameter. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| dataRange |
| |
| Defines a numeric range, such as the bounds of chart or a section of a chart. |
| Contains |
| (
lowExpression,
highExpression
) |
| Attributes |
|
|
top |
|
| datasetRun |
| |
| Subdataset instantiation information for a chart/crosstab dataset. |
| Contains |
| (
parametersMapExpression?,
datasetParameter*, (
connectionExpression |
dataSourceExpression )?
) |
| Attributes |
|
| |
| subDataset |
| |
| The name of the subdataset to instantiate. |
Required true |
|
top |
|
| dataSourceExpression |
| |
| If present, it is used to pass the net.sf.jasperreports.engine.JRDataSource object to the subreport filling or subdataset iteration routines. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| dateExpression |
| |
| Represents a date expression used in <time series chart> |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| detail |
| |
| Definition of the detail section for this report. The detail section is repeted for each line of data supplied by the report's data source. |
| Contains |
| (
band?
) |
| Attributes |
|
|
top |
|
| defaultValueExpression |
| |
| Specifies the parameter default value to use when not supplied by the parent application at runtime. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| elementGroup |
| |
| Element for grouping objects on the report. |
| Contains |
| (
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 |
elementGroup |
crosstab |
frame
)* |
| Attributes |
|
|
top |
|
| ellipse |
| |
| Definition of an ellipse object. |
| Contains |
| (
reportElement,
graphicElement?
) |
| Attributes |
|
|
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. |
Required true |
| class |
| |
| Class of the field values. |
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. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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.
|
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| font |
| |
| Defines the font to use with the text element. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| reportFont |
| |
| Name of the report level font to use as base font (see <reportFont> element). |
| fontName |
| |
| Name of the font. |
| size |
| |
| Size of the font. |
| isBold |
| |
| |
| Values |
|
|
| isItalic |
| |
| |
| Values |
|
|
| isUnderline |
| |
| |
| Values |
|
|
| isStrikeThrough |
| |
| |
| Values |
|
|
| pdfFontName |
| |
| Name of the PDF font. |
| pdfEncoding |
| |
| Encoding type to use with the PDF font. |
| isPdfEmbedded |
| |
| Specifies if the PDF font should be embedded in the document. |
| Values |
|
|
|
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 |
elementGroup |
crosstab |
frame
)*
) |
| Attributes |
|
|
top |
|
| graphicElement |
| |
| Element used to specify the common properties of a graphic object on the report (line, rectangle, ellipse or image). |
| Contains |
| (
pen?
) |
| Attributes |
|
| |
| pen |
| Deprecated. Replaced by tag <pen>. |
| Type of the lines used to draw the object. |
| Values |
|
| |
None |
| No line. |
Thin |
| Thin line. |
1Point |
| Normal line. |
2Point |
| Medium line. |
4Point |
| Thick line. |
Dotted |
| Dotted line. |
|
| fill |
| |
| Type of the fill pattern used to fill objects. |
| Values |
|
|
Default Solid |
|
top |
|
| group |
| |
| Definition of a group on the report. |
| Contains |
| (
groupExpression?,
groupHeader?,
groupFooter?
) |
| Attributes |
|
| |
| name |
| |
| Name of the group |
Required true |
| isStartNewColumn |
| |
| Flag that signals if the group header should be printed always on a new column. |
| Values |
|
| |
true |
| Group header section is printed always on a new column. |
false |
| Group 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. |
| Values |
|
| |
true |
| Group header section is printed always on a new page. |
false |
| Group 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. |
| Values |
|
| |
true |
| Group header section is printed always on a new page and the page number is reinitialized. |
false |
| Group 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. |
| Values |
|
| |
true |
| Group header section is reprinted always at the beginning of a new page. |
false |
| Group 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. |
Default 0 |
|
top |
|
| groupExpression |
| |
| Specifies the expression that will be evaluated at runtime to determine the group ruptures. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| groupFooter |
| |
| Contains the definition of the footer section for this group. |
| Contains |
| (
band?
) |
| Attributes |
|
|
top |
|
| groupHeader |
| |
| Contains the definition of the header section for this group. |
| Contains |
| (
band?
) |
| Attributes |
|
|
top |
|
| highExpression |
| |
| High expresion in a <highLowchart>. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| highLowChart |
| |
| Defines a high-low type chart |
| Contains |
| (
chart,
highLowDataset,
highLowPlot
) |
| Attributes |
|
|
top |
|
| highLowDataset |
| |
| Defines a dataset that can be used with a <highLowChart>. |
| Contains |
| (
dataset,
seriesExpression,
dateExpression ,
highExpression,
lowExpression,
closeExpression,
volumeExpression,
itemHyperlink?
) |
| Attributes |
|
|
top |
|
| highLowPlot |
| |
| Plot options for a <highLowChart> |
| Contains |
| (
plot,
timeAxisLabelExpression?,
timeAxisFormat?,
valueAxisLabelExpression?,
valueAxisFormat?
) |
| Attributes |
|
| |
| isShowCloseTicks |
| |
| Show close tick flag |
| Values |
|
|
Default true |
| isShowOpenTicks |
| |
| Show open tick flag |
| Values |
|
|
Default true |
|
top |
|
| highRange |
| |
| Defines the high range in a <thermometerChart>. |
| Contains |
| (
dataRange
) |
| Attributes |
|
|
top |
|
| hyperlinkAnchorExpression |
| |
| Used in hyperlink elements to point to document anchors. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| hyperlinkPageExpression |
| |
| Used in hyperlink elements to point to document pages. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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. |
Required true |
|
top |
|
| hyperlinkParameterExpression |
| |
| Expression that will produce the value for a hyperlink parameter. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
| |
| class |
| |
| Type of the parameter value. |
Default java.lang.String |
|
top |
|
| hyperlinkReferenceExpression |
| |
| Used in hyperlink elements to point to external documents and resources. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| hyperlinkTooltipExpression |
| |
| Used in hyperlink elements to generate a tooltip for the hyperlink. The type of the expression should be java.lang.String. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| image |
| |
| Definition of an image object. |
| Contains |
| (
reportElement,
box?,
graphicElement?,
imageExpression?,
anchorNameExpression?,
hyperlinkReferenceExpression?,
hyperlinkAnchorExpression?,
hyperlinkPageExpression?,
hyperlinkTooltipExpression?,
hyperlinkParameter*
) |
| Attributes |
|
| |
| scaleImage |
| |
| Image displaying type. |
| Values |
|
| |
Clip |
| Only the portion of the image that fits the specified object width and height will be printed. Image is not stretched. |
FillFrame |
| Image will be stretched to adapt to the specified object width and height. |
RetainShape |
| Image will adapt to the specified object width or height keeping its original shape. |
|
Default RetainShape |
| hAlign |
| |
| Horizontal image alignment. |
| Values |
|
|
Default Left |
| vAlign |
| |
| Vertical image alignment. |
| Values |
|
|
Default Top |
| isUsingCache |
| |
| If true, tells the report engine to cache the images that are loaded from the same location. |
| Values |
|
|
| isLazy |
| |
| Gives control over when the images are retrieved from their specified location. |
| Values |
|
| |
true |
| The image is loaded from the specified location only when the document is viewed or exported to other formats. |
false |
| The 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. |
| Values |
|
| |
Error |
| An exception is raised when loading the image. |
Blank |
| The exception is ignored and the image displays as blank. |
Icon |
| The 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. |
| Values |
|
| |
Now |
| The image expression is evaluated when filling the current band (section). |
Report |
| The image expression is evaluated when reaching the end of the report. |
Page |
| The image expression is evaluated when reaching the end of the current page. |
Column |
| The image expression is evaluated when reaching the end of the current column. |
Group |
| The image expression is evaluated when the group specified by the evaluationGroup attribute changes. |
Band |
| The image expression is evaluated after the parent band has finished rendering all the other elements. |
Auto |
| Evaluation time used when report elements having expressions that combine values evaluated at different times are required (e.g. percentage out of a total).
Variables will be evaluated at a time corresponding to their reset type.
Fields are evaluated "now", i.e. at the time the band the element lies on gets filled.
NB: avoid using this evaluation type when other types suffice as it can lead to performance loss.
|
|
Default Now |
| evaluationGroup |
| |
| Used to specify the group at which to evaluate the image expression value, when evaluationTime is "Group". |
| hyperlinkType |
| |
|
Indicates the type of the hyperlink element.
The type can be:
One of the built-in types:
None
The current element doesn't represent a hyperlink.
Reference
The current hyperlink points to an external resource specified by the corresponding <hyperlinkReferenceExpression> element, usually an URL.
LocalAnchor
The current hyperlink points to a local anchor specified by the corresponding <hyperlinkAnchorExpression> element.
LocalPage
The current hyperlink points to a 1 based page index within the current document specified by the corresponding <hyperlinkPageExpression> element.
RemoteAnchor
The current hyperlink points to an anchor specified by the <hyperlinkAnchorExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
RemotePage
The current hyperlink points to a 1 based page index specified by the <hyperlinkPageExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
A custom (arbitrary) type.
|
Default None |
| hyperlinkTarget |
| |
| Indicates the target of the hyperlink. |
| Values |
|
| |
Self |
| Loads the hyperlink destination document into the window in which the link was clicked. |
Blank |
| Loads the hyperlink destination document into a new blank window. |
|
Default Self |
| 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.
|
Default 0 |
|
top |
|
| imageExpression |
| |
| Definition of the expression that will be used to determine the image to be displayed. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
| |
| class |
| |
| Class of the image source. |
| Values |
|
| |
java.lang.String |
| Image location. First, the report engine tries to see whether the String represents an URL. If not, it tries to find the file on disk and finally, if the String does not represent a path file, it searches in the CLASSPATH to find the image as a resource. |
java.io.File |
| Image loaded by opening an java.io.InputStream from this java.io.File object. |
java.net.URL |
| Image loaded by opening an java.io.InputStream from this java.net.URL object. |
java.io.InputStream |
| Image loaded from an java.io.InputStream object. |
java.awt.Image |
| Image loaded from a java.awt.Image object. |
net.sf.jasperreports.engine.JRRenderable |
| The image will be drawn directly on the target graphic context by a serializable instance of this interface. |
|
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. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| value |
| |
| Class name or package to import. |
Required true |
|
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.
|
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| initialValueExpression |
| |
| Definition of the expression that will be used to calculate the initial value of the variable, before any calculations are made. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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?,
hyperlinkAnchorExpression?,
hyperlinkPageExpression?,
hyperlinkTooltipExpression?,
hyperlinkParameter*
) |
| Attributes |
|
| |
| hyperlinkType |
| |
|
Indicates the type of the hyperlink element.
The type can be:
One of the built-in types:
None
The current element doesn't represent a hyperlink.
Reference
The current hyperlink points to an external resource specified by the corresponding <hyperlinkReferenceExpression> element, usually an URL.
LocalAnchor
The current hyperlink points to a local anchor specified by the corresponding <hyperlinkAnchorExpression> element.
LocalPage
The current hyperlink points to a 1 based page index within the current document specified by the corresponding <hyperlinkPageExpression> element.
RemoteAnchor
The current hyperlink points to an anchor specified by the <hyperlinkAnchorExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
RemotePage
The current hyperlink points to a 1 based page index specified by the <hyperlinkPageExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
A custom (arbitrary) type.
|
Default None |
| hyperlinkTarget |
| |
| Indicates the target of the hyperlink. |
| Values |
|
| |
Self |
| Loads the hyperlink destination document into the window in which the link was clicked. |
Blank |
| Loads the hyperlink destination document into a new blank window. |
|
Default Self |
|
top |
|
| jasperReport |
| |
| Root element representing the definition of a report. |
| Contains |
| (
property*,
import*,
reportFont*,
style*,
subDataset*,
parameter*,
queryString?,
field*,
sortField*,
variable*,
filterExpression?,
group*,
background?,
title?,
pageHeader?,
columnHeader?,
detail?,
columnFooter?,
pageFooter?,
lastPageFooter?,
summary?,
noData?
) |
| Attributes |
|
| |
| name |
| |
| Name of the report. |
Required true |
| language |
| |
| Specifies the language used for the report expressions. |
Default java |
| columnCount |
| |
| Number of columns on the report. |
Default 1 |
| printOrder |
| |
| Columns filling order. |
| Values |
|
| |
Vertical |
| Columns on the report are filled vertically. |
Horizontal |
| Columns on the report are filled horizontally. |
|
Default Vertical |
| pageWidth |
| |
| Page width. |
Default 595 |
| pageHeight |
| |
| Page height. |
Default 842 |
| orientation |
| |
| Page printing orientation. |
| Values |
|
|
Default Portrait |
| whenNoDataType |
| |
| Allows users to customize the behavior of the reporting engine when there are now rows in the data source. |
| Values |
|
| |
NoPages |
| The generated document contains zero pages. |
BlankPage |
| The generated document contains one blank page. |
AllSectionsNoDetail |
| All the report sections except the detail section will get printed. |
NoDataSection |
| The generated document contains the noData section. |
|
Default NoPages |
| columnWidth |
| |
| Column width. |
Default 555 |
| columnSpacing |
| |
| Space between columns. |
Default 0 |
| leftMargin |
| |
| Left margin. |
Default 20 |
| rightMargin |
| |
| Right margin. |
Default 20 |
| topMargin |
| |
| Top margin. |
Default 30 |
| bottomMargin |
| |
| Bottom margin. |
Default 30 |
| isTitleNewPage |
| |
| Flag used to specify if the title section should be printed on a separate initial page. |
| Values |
|
| |
true |
| Title section will be printed on a separate initial page. |
false |
| Title 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. |
| Values |
|
| |
true |
| Summary section will be printed on a separate last page. |
false |
| Summary section will be printed on the last page of the report, along with the other sections, if there is enough space. |
|
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. |
| Values |
|
| |
true |
| The column footer section is printed immediately after the last detail or group footer printed on the current column. |
false |
| The 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. |
Default net.sf.jasperreports.engine.JRDefaultScriptlet |
| resourceBundle |
| |
| The base name of the report associated resource bundle. |
| whenResourceMissingType |
| |
| Allows customizing the way the engine deals with missing resources in the resource bundle. |
| Values |
|
| |
Null |
| Null is returned for the missing resource. |
Empty |
| An empty string is returned for the missing resource. |
Key |
| The key is returned for the missing resources. |
Error |
| An 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.
|
| Values |
|
| |
false |
| The report will be paginated according to the pageHeight attribute. |
true |
| The report will be generated on one long page. The specified page heigt will still be used for report design. |
|
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. |
Default net.sf.jasperreports.engine.util.DefaultFormatFactory |
|
top |
|
| keyExpression |
| |
| Defines a key in a <pieDataset> |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| labelExpression |
| |
| Defines a label in a <pieDataset>. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
top |
|
| leftPen |
| |
| Groups the properties of the pen used to draw lines or borders. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| lineWidth |
| |
| The line width of the pen. |
Required false |
| lineStyle |
| |
| The line style of the pen. |
| Values |
|
| |
Solid |
| Solid line. |
Dashed |
| Dashed line. |
Dotted |
| Dotted line. |
Double |
| Double line. |
|
Default Solid |
| 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. |
Required false |
|
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. |
| Values |
|
| |
TopDown |
| The diagonal that starts in the top-left corner of the rectangle will be drawn. |
BottomUp |
| The 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
) |
| Attributes |
|
|
top |
|
| linePlot |
| |
| Defines plot options for a <line chart> |
| Contains |
| (
plot,
categoryAxisLabelExpression?,
categoryAxisFormat?,
valueAxisLabelExpression?,
valueAxisFormat?
) |
| Attributes |
|
| |
| isShowLines |
| |
| Show lines flag |
| Values |
|
|
Default true |
| isShowShapes |
| |
| Show shapes flag |
| Values |
|
|
Default true |
|
top |
|
| lowExpression |
| |
| Low expression in a <highLowChart> |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| lowRange |
| |
| Defines the low range in a <thermometerChart>. |
| Contains |
| (
dataRange
) |
| Attributes |
|
|
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. |
Required true |
| class |
| |
| The measure values class. |
Required true |
| calculation |
| |
| The calculation type to be performed on the measure values. |
| Values |
|
| |
Nothing |
| No calculations are performed. |
Count |
| The measure stores the number of the not null values. |
DistinctCount |
| The measure stores the number of distinct not null values. |
Sum |
| The measure stores the sum of the not null values. Numeric measures only. |
Average |
| The measure stores the average of the not null values. Numeric measures only. |
Lowest |
| The measure stores the lowest value. |
Highest |
| The measure stores the highest value. |
StandardDeviation |
| The measure stores the standard deviation of the not null values. Numeric measures only. |
Variance |
| The measure stores the variance of the not null values. Numeric measures only. |
First |
| The measure 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 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. |
| 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.
|
| Values |
|
| |
None |
| The value will not be calculated as a percentage |
GrandTotal |
| The 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.
|
|
top |
|
| measureExpression |
| |
| Crosstab measure expression. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| mediumRange |
| |
| Defines the medium range in a <thermometerChart>. |
| Contains |
| (
dataRange
) |
| Attributes |
|
|
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
) |
| Attributes |
|
|
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. |
Required false |
| color |
| |
| The color used to shade the region in the meter. If not set the region will have no
visual indicator. |
Required false |
| alpha |
| |
| The alpha (transparency) of the shading for the region. The values range from 0.0
(completely transparent) to 1.0 (completely opaque). |
Default 1.0 |
|
top |
|
| meterPlot |
| |
| Plot options for a meterChart. |
| Contains |
| (
plot,
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.
|
| Values |
|
| |
chord |
| A 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. |
circle |
| The unused portion of the circle that describes the meter is shaded with the background color. |
pie |
| The unused portion of the circle that describes the meter is not shaded at all. |
|
Default pie |
| angle |
| |
| The extent of the meter in degrees. Use 180 for a semicircle. |
Default 180 |
| units |
| |
| An optional string that describes the unit that the meter is displaying. This string will
be appended to the value. |
Required false |
| 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. |
Default 10 |
| meterColor |
| |
| The color of meter. If meterIntervals are defined they may
mask this color. |
Required false |
| needleColor |
| |
| The color used to draw the needle in the meter. |
Required false |
| tickColor |
| |
| The color of the meter ticks, if any. |
Required false |
|
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
) |
| Attributes |
|
|
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+
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
top |
|
| openExpression |
| |
| Open expression for a <candlestickChart> |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
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. |
Required true |
| class |
| |
| Class of the parameter values. |
Required true |
| isForPrompting |
| |
| Optional flag that might be used by the parent application to prompt the user for the parameter value. |
| Values |
|
|
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. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| parameterValueExpression |
| |
| Crosstab parameter value expression. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| pen |
| |
| Groups the properties of the pen used to draw lines or borders. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| lineWidth |
| |
| The line width of the pen. |
Required false |
| lineStyle |
| |
| The line style of the pen. |
| Values |
|
| |
Solid |
| Solid line. |
Dashed |
| Dashed line. |
Dotted |
| Dotted line. |
Double |
| Double line. |
|
Default Solid |
| 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. |
Required false |
|
top |
|
| pie3DChart |
| |
| Defines a pie chart with 3D effect |
| Contains |
| (
chart,
pieDataset,
pie3DPlot
) |
| Attributes |
|
|
top |
|
| pie3DPlot |
| |
| Defines plot options for a <pie3DChart> |
| Contains |
| (
plot
) |
| Attributes |
|
| |
| depthFactor |
| |
| Depth factor for a pie chart plot |
Default 0.2 |
| isCircular |
| |
| Indicates whether the pie chart is circular, or stretched into an elliptical shape |
| Values |
|
|
Default false |
|
top |
|
| pieChart |
| |
| Defines a pie type chart |
| Contains |
| (
chart,
pieDataset,
piePlot
) |
| Attributes |
|
|
top |
|
| pieDataset |
| |
| Defines a dataset to be used with <pieChart> |
| Contains |
| (
dataset,
keyExpression,
valueExpression,
labelExpression?,
sectionHyperlink?
) |
| Attributes |
|
|
top |
|
| piePlot |
| |
| Plot options for a <pieChart> |
| Contains |
| (
plot
) |
| Attributes |
|
| |
| isCircular |
| |
| Indicates whether the pie chart is circular, or stretched into an elliptical shape |
| Values |
|
|
Default true |
|
top |
|
| plot |
| |
| Defines generic plot options for charts |
| Contains |
| (
seriesColor*
) |
| Attributes |
|
| |
| backcolor |
| |
| Background color of the chart |
| orientation |
| |
| Orientation of the chart |
| Values |
|
|
Default Vertical |
| backgroundAlpha |
| |
| Alpha (transparency) parameter for the background |
Default 1 |
| foregroundAlpha |
| |
| Alpha (transparency) parameter for the foreground |
Default 1 |
| labelRotation |
| |
| 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. |
Default 1 |
|
top |
|
| printWhenExpression |
| |
| Definition of a Boolean expression that will determine if the element or the band should be printed or not. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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). |
| Contains |
| EMPTY |
| Attributes |
|
| |
| name |
| |
| Name of the object property. |
Required true |
| value |
| |
| Value of the object property. |
|
top |
|
| queryString |
| |
| Contains the SQL query that will be used to retrieve the data needed to fill the report. |
| Contains |
| (
#PCDATA
) |
| 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>
|
Default sql |
|
top |
|
| rectangle |
| |
| Definition of a rectangle object. |
| Contains |
| (
reportElement,
graphicElement?
) |
| Attributes |
|
| |
| radius |
| |
| The radius of the arc corner. |
Default 0 |
|
top |
|
| reportElement |
| |
| Element used to specify the common properties of an object on the report. |
| Contains |
| (
property*,
printWhenExpression?
) |
| Attributes |
|
| |
| 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. |
| style |
| |
| Name of the report level style to use as base style (see <style> element). |
| positionType |
| |
| Specifies the object position when the report section is affected by stretch. |
| Values |
|
| |
Float |
| The element moves relative to the size of the surrounding elements. |
FixRelativeToTop |
| The element maintains its position relative to the top of the band. |
FixRelativeToBottom |
| The 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. |
| Values |
|
| |
NoStretch |
| The graphic element won't stretch vertically as the band stretches to display field data. |
RelativeToTallestObject |
| The graphic element will stretch to accommodate the tallest object in its the group. See the <elementGroup> element, to see how to group elements in bands. |
RelativeToBandHeight |
| The 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. |
| Values |
|
| |
true |
| Dynamic elements will print even if their values repeat. Static elements will appear every time the band that contains them is started. |
false |
| Suppresses 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. |
| Values |
|
|
| x |
| |
| Specifies the x coordinate for the object within the band. |
Required true |
| y |
| |
| Specifies the y coordinate for the object within the band. |
Required true |
| width |
| |
| Width of the object. |
Required true |
| height |
| |
| Height of the object. |
Required true |
| isRemoveLineWhenBlank |
| |
| Collapses the band if the element is not printing and no other element is occupying the same horizontal space. |
| Values |
|
|
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. |
| Values |
|
|
Default false |
| isPrintWhenDetailOverflows |
| |
| The element will be printed when the band overflows to a new page or a new column. |
| Values |
|
|
Default false |
| printWhenGroupChanges |
| |
| The element will be printed when the specified group changes. |
| 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. |
Default #000000 |
| 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. |
Default #FFFFFF |
|
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. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| name |
| |
| Name of the report font definition. |
Required true |
| isDefault |
| |
| The default report font is used as base font for all the font definitions that do not explicitly reference a report font definition. |
| Values |
|
|
Default false |
| fontName |
| |
| Name of the font. |
Default sansserif |
| size |
| |
| Size of the font. |
Default 10 |
| isBold |
| |
| |
| Values |
|
|
Default false |
| isItalic |
| |
| |
| Values |
|
|
Default false |
| isUnderline |
| |
| |
| Values |
|
|
Default false |
| isStrikeThrough |
| |
| |
| Values |
|
|
Default false |
| pdfFontName |
| |
| Name of the PDF font. |
Default Helvetica |
| pdfEncoding |
| |
| Encoding type to use with the PDF font. |
Default CP1252 |
| isPdfEmbedded |
| |
| Specifies if the PDF font should be embedded in the document. |
| Values |
|
|
Default false |
|
top |
|
| rightPen |
| |
| Groups the properties of the pen used to draw lines or borders. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| lineWidth |
| |
| The line width of the pen. |
Required false |
| lineStyle |
| |
| The line style of the pen. |
| Values |
|
| |
Solid |
| Solid line. |
Dashed |
| Dashed line. |
Dotted |
| Dotted line. |
Double |
| Double line. |
|
Default Solid |
| 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. |
Required false |
|
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. |
Required true |
| width |
| |
| The width of the row group header. |
Required true |
| 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.
|
| Values |
|
| |
Start |
| The total row will be displayed before the group rows. |
End |
| The total row will be displayed after the group rows. |
None |
| The 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.
|
| Values |
|
| |
Top |
| The contents will be rendered at the top of the header |
Middle |
| The contents will be rendered on the center of the header |
Bottom |
| The contents will be rendered at the bottom of the header |
Stretch |
| The contents will be proportionally stretched to the new header height |
|
Default Top |
|
top |
|
| returnValue |
| |
| Maps a subreport variable to a master report variable in order to allow returning values from subreport to the master report. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| subreportVariable |
| |
| Name of the subreport variable whose value will be returned to the master report. |
Required true |
| toVariable |
| |
| Name of the master report variable to which the value is returned. This should be a variable with calculation="System" |
Required true |
| calculation |
| |
| Calculation to perform on the master report variable when returning the value from the subreport. |
| Values |
|
| |
Nothing |
| No calculations are performed. |
Count |
| Variable stores the number of the not null values returned from the subreport. |
DistinctCount |
| Variable stores the number of distinct not null values returned from the subreport. |
Sum |
| Variable stores the sum of the not null values returned from the subreport. Numeric variables only. |
Average |
| Variable stores the average of the not null values returned from the subreport. Numeric variables only. |
Lowest |
| Variable stores the lowest value returned from the subreport. |
Highest |
| Variable stores the highest value returned from the subreport. |
StandardDeviation |
| Variable stores the standard deviation of the not null values returned from the subreport. Numeric variables only. |
Variance |
| Variable stores the variance of the not null values returned from the subreport. Numeric variables only. |
First |
| Variable 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. |
|
top |
|
| scatterChart |
| |
| Defines a scatter chart |
| Contains |
| (
chart,
xyDataset,
scatterPlot
) |
| Attributes |
|
|
top |
|
| scatterPlot |
| |
| Specifies the plot options for a <scatterChart> |
| Contains |
| (
plot,
xAxisLabelExpression?,
xAxisFormat?,
yAxisLabelExpression?,
yAxisFormat?
) |
| Attributes |
|
| |
| isShowLines |
| |
| Show lines flag |
| Values |
|
|
Default true |
| isShowShapes |
| |
| Show shapes flag |
| Values |
|
|
Default true |
|
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?,
hyperlinkAnchorExpression?,
hyperlinkPageExpression?,
hyperlinkTooltipExpression?,
hyperlinkParameter*
) |
| Attributes |
|
| |
| hyperlinkType |
| |
|
Indicates the type of the hyperlink element.
The type can be:
One of the built-in types:
None
The current element doesn't represent a hyperlink.
Reference
The current hyperlink points to an external resource specified by the corresponding <hyperlinkReferenceExpression> element, usually an URL.
LocalAnchor
The current hyperlink points to a local anchor specified by the corresponding <hyperlinkAnchorExpression> element.
LocalPage
The current hyperlink points to a 1 based page index within the current document specified by the corresponding <hyperlinkPageExpression> element.
RemoteAnchor
The current hyperlink points to an anchor specified by the <hyperlinkAnchorExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
RemotePage
The current hyperlink points to a 1 based page index specified by the <hyperlinkPageExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
A custom (arbitrary) type.
|
Default None |
| hyperlinkTarget |
| |
| Indicates the target of the hyperlink. |
| Values |
|
| |
Self |
| Loads the hyperlink destination document into the window in which the link was clicked. |
Blank |
| Loads the hyperlink destination document into a new blank window. |
|
Default Self |
|
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. |
| Contains |
| (
EMPTY
) |
| 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.
|
Required true |
| color |
| |
| The color to use for the series |
Required true |
|
top |
|
| seriesExpression |
| |
| Defines a series expression in a dataset |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| sortField |
| |
| Introduces a field to use for sorting the data source. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| name |
| |
| Name of the report field to use for sorting. |
Required true |
| order |
| |
| The sort order for the field. |
| Values |
|
|
Default Ascending |
|
top |
|
| stackedBar3DChart |
| |
| Defines a stacked bar chart with 3D effect |
| Contains |
| (
chart,
categoryDataset,
bar3DPlot
) |
| Attributes |
|
|
top |
|
| stackedBarChart |
| |
| Defines a stacked bar chart |
| Contains |
| (
chart,
categoryDataset,
barPlot
) |
| Attributes |
|
|
top |
|
| stackedAreaChart |
| |
| Defines a stacked area chart |
| Contains |
| (
chart,
categoryDataset,
areaPlot
) |
| Attributes |
|
|
top |
|
| staticText |
| |
| Definition of a static text object. |
| Contains |
| (
reportElement,
box?,
textElement?,
text?
) |
| Attributes |
|
|
top |
|
| style |
| |
| Definition of a report style. |
| Contains |
| (
pen*,
box*,
conditionalStyle*,
) |
| Attributes |
|
| |
| name |
| |
| Name of the report style definition. |
| isDefault |
| |
| The default report style is used as base style for all the elements that do not explicitly reference a report style definition. |
| Values |
|
|
Default false |
| style |
| |
| Parent style reference. |
| mode |
| |
| |
| forecolor |
| |
| |
| backcolor |
| |
| |
| pen |
| Deprecated. Replaced by tag <pen>. |
| |
| fill |
| |
| |
| radius |
| |
| |
| scaleImage |
| |
| |
| hAlign |
| |
| |
| vAlign |
| |
| |
| border |
| Deprecated. Replaced by tag <box>. |
| |
| borderColor |
| Deprecated. Replaced by tag <box>. |
| |
| padding |
| Deprecated. Replaced by tag <box>. |
| |
| topBorder |
| Deprecated. Replaced by tag <box>. |
| |
| topBorderColor |
| Deprecated. Replaced by tag <box>. |
| |
| topPadding |
| Deprecated. Replaced by tag <box>. |
| |
| leftBorder |
| Deprecated. Replaced by tag <box>. |
| |
| leftBorderColor |
| Deprecated. Replaced by tag <box>. |
| |
| leftPadding |
| Deprecated. Replaced by tag <box>. |
| |
| bottomBorder |
| Deprecated. Replaced by tag <box>. |
| |
| bottomBorderColor |
| Deprecated. Replaced by tag <box>. |
| |
| bottomPadding |
| Deprecated. Replaced by tag <box>. |
| |
| rightBorder |
| Deprecated. Replaced by tag <box>. |
| |
| rightBorderColor |
| Deprecated. Replaced by tag <box>. |
| |
| rightPadding |
| Deprecated. Replaced by tag <box>. |
| |
| rotation |
| |
| |
| lineSpacing |
| |
| |
| isStyledText |
| |
| |
| fontName |
| |
| |
| fontSize |
| |
| |
| isBold |
| |
| |
| isItalic |
| |
| |
| isUnderline |
| |
| |
| isStrikeThrough |
| |
| |
|
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*,
parameter*,
queryString?,
field*,
sortField*,
variable*,
filterExpression?,
group*
) |
| Attributes |
|
| |
| name |
| |
| Name of the dataset. |
Required true |
| 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. |
| resourceBundle |
| |
| The base name of the dataset associated resource bundle. |
| whenResourceMissingType |
| |
| Allows customizing the way the engine deals with missing resources in the resource bundle. |
| Values |
|
| |
Null |
| Null is returned for the missing resource. |
Empty |
| An empty string is returned for the missing resource. |
Key |
| The key is returned for the missing resources. |
Error |
| An exception is thrown when the resource with the specified key is missing. |
|
Default Null |
|
top |
|
| subtitleExpression |
| |
| Defines the expression for the chart subtitle |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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. |
| Values |
|
|
|
top |
|
| subreportExpression |
| |
| Definition of the expression that will be used to determine the report object that will be loaded as a subreport. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
| |
| class |
| |
| Class of the image source. |
| Values |
|
| |
java.lang.String |
| Subreport location. First, the report engine tries to see whether the String represents an URL. If not, it tries to find the file on disk and finally, if the String does not represent a path file, it searches in the CLASSPATH to find the report definition as a resource. |
java.io.File |
| Subreport loaded by opening an java.io.InputStream from this java.io.File object. |
java.net.URL |
| Subreport loaded by opening an java.io.InputStream from this java.net.URL object. |
java.io.InputStream |
| Subreport loaded from an java.io.InputStream object. |
net.sf.jasperreports.engine.JasperReport |
| Subreport supplied directly as a net.sf.jasperreports.engine.JasperReport object. |
|
Default java.lang.String |
|
top |
|
| subreportParameter |
| |
| Definition of a subreport parameter. |
| Contains |
| (
subreportParameterExpression?
) |
| Attributes |
|
| |
| name |
| |
| The name of the parameter that will be passed when filling the subreport. |
Required true |
|
top |
|
| subreportParameterExpression |
| |
| Definition of the expression associated with the subreport parameter. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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?
) |
| Attributes |
|
|
top |
|
| text |
| |
| Specifies the text to print for a static text object. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| textElement |
| |
| Element used to specify the common properties of a text object on the report (<staticText> or <textField>). |
| Contains |
| (
font?
) |
| Attributes |
|
| |
| textAlignment |
| |
| Type of alignment for the text object. |
| Values |
|
| |
Left |
| Text is aligned to the left. |
Center |
| Text is centered. |
Right |
| Text is aligned to the right. |
Justified |
| Text is justified. |
|
Default Left |
| verticalAlignment |
| |
| Type of vertical alignment for the text object. |
| Values |
|
| |
Top |
| Text is aligned to the top. |
Middle |
| Text is vertically centered. |
Bottom |
| Text is aligned to the bottom. |
|
Default Top |
| rotation |
| |
| Type of rotation for the text object. |
| Values |
|
| |
None |
| Text runs horizontally from left to right and from top to bottom. |
Left |
| Text runs vertically from bottom to top and from left to right. |
Right |
| Text runs vertically from top to bottom and from right to left. |
UpsideDown |
| Text is rotated with 180 degrees. |
|
Default None |
| lineSpacing |
| |
| Type of line spacing for the text object. |
| Values |
|
| |
Single |
| Normal line spacing |
1_1_2 |
| Medium line spacing. |
Double |
| Double line spacing |
|
Default Single |
| isStyledText |
| |
| 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. |
| Values |
|
| |
true |
| The text element contains text formatted using nested <style> tags. |
false |
| The text element has a pure text content, without style information. |
|
Default false |
|
top |
|
| textField |
| |
| Definition of a text field object. |
| Contains |
| (
reportElement,
box?,
textElement?,
textFieldExpression?,
anchorNameExpression?,
hyperlinkReferenceExpression?,
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. |
| Values |
|
|
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. |
| Values |
|
| |
Now |
| Text field expression is evaluated when filling the current band (section). |
Report |
| Text field expression is evaluated when reaching the end of the report. |
Page |
| Text field expression is evaluated when reaching the end of the current page. |
Column |
| Text field expression is evaluated when reaching the end of the current column. |
Group |
| Text field expression is evaluated when the group specified by the evaluationGroup attribute changes. |
Band |
| Text field expression is evaluated after the parent band has finished rendering all the other elements. |
Auto |
| Evaluation time used when report elements having expressions that combine values evaluated at different times are required (e.g. percentage out of a total).
Variables will be evaluated at a time corresponding to their reset type.
Fields are evaluated "now", i.e. at the time the band the element lies on gets filled.
NB: avoid using this evaluation type when other types suffice as it can lead to performance loss.
|
|
Default Now |
| evaluationGroup |
| |
| Used to specify the group at which to evaluate the text field value, when evaluationTime is "Group". |
| pattern |
| |
| Pattern to use when formatting the output of the text field expression. |
| isBlankWhenNull |
| |
| Specifies that the text field should display a blank character instead of "null" when the text field expression evaluates to null. |
| Values |
|
|
| hyperlinkType |
| |
|
Indicates the type of the hyperlink element.
The type can be:
One of the built-in types:
None
The current element doesn't represent a hyperlink.
Reference
The current hyperlink points to an external resource specified by the corresponding <hyperlinkReferenceExpression> element, usually an URL.
LocalAnchor
The current hyperlink points to a local anchor specified by the corresponding <hyperlinkAnchorExpression> element.
LocalPage
The current hyperlink points to a 1 based page index within the current document specified by the corresponding <hyperlinkPageExpression> element.
RemoteAnchor
The current hyperlink points to an anchor specified by the <hyperlinkAnchorExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
RemotePage
The current hyperlink points to a 1 based page index specified by the <hyperlinkPageExpression> element, within an external document indicated by the corresponding <hyperlinkReferenceExpression> element.
A custom (arbitrary) type.
|
Default None |
| hyperlinkTarget |
| |
| Indicates the target of the hyperlink. |
| Values |
|
| |
Self |
| Loads the hyperlink destination document into the window in which the link was clicked. |
Blank |
| Loads the hyperlink destination document into a new blank window. |
|
Default Self |
| 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.
|
Default 0 |
|
top |
|
| textFieldExpression |
| |
| Defines the expression to use for this textField. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
| |
| class |
| |
| Class for the text field values. |
| Values |
|
| |
java.lang.Boolean |
| |
java.lang.Byte |
| |
java.util.Date |
| |
java.sql.Timestamp |
| |
java.sql.Time |
| |
java.lang.Double |
| |
java.lang.Float |
| |
java.lang.Integer |
| |
java.lang.Long |
| |
java.lang.Short |
| |
java.math.BigDecimal |
| |
java.lang.Number |
| |
java.lang.String |
| |
|
Default java.lang.String |
|
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
) |
| Attributes |
|
|
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.
|
| Values |
|
| |
none |
| The textual value is not displayed. |
left |
| The text value is displayed to the left of the thermometer outline. |
right |
| The text value is displayed to the left of the thermometer outline. |
bulb |
| The 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.
|
| Values |
|
| |
true |
| Value lines are drawn. |
false |
| Value 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. |
Required false |
|
top |
|
| tickLabelFont |
| |
| Specifies the font to use when drawing the label for each tick
mark on an axis in a chart. |
| Contains |
| (
font?
) |
| Attributes |
|
|
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
) |
| Attributes |
|
|
top |
|
| timeAxisLabelExpression |
| |
| Defines the expression used for the time axis label |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| timePeriodDataset |
| |
| Defines a time period dataset |
| Contains |
| (
dataset,
timePeriodSeries +
) |
| Attributes |
|
|
top |
|
| timePeriodExpression |
| |
| Defines the expression used for a time period |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| timePeriodSeries |
| |
| Defines a time period series for a <timePeriodDataset> |
| Contains |
| (
seriesExpression,
startDateExpression,
endDateExpression,
valueExpression,
labelExpression,
itemHyperlink?
) |
| Attributes |
|
|
top |
|
| timeSeries |
| |
| Defines a time series for <timeSeriesDataset>. |
| Contains |
| (
seriesExpression,
timePeriodExpression,
valueExpression,
labelExpression?,
itemHyperlink?
) |
| Attributes |
|
|
top |
|
| timeSeriesChart |
| |
| Defines a time series chart |
| Contains |
| (
chart,
timeSeriesDataset,
timeSeriesPlot
) |
| Attributes |
|
|
top |
|
| timeSeriesDataset |
| |
| Defines a time series dataset |
| Contains |
| (
dataset,
timeSeries +
) |
| Attributes |
|
| |
| timePeriod |
| |
| Time period for the dataset |
| 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?
) |
| Attributes |
|
| |
| isShowLines |
| |
| Show lines flag |
| Values |
|
|
Default true |
| isShowShapes |
| |
| Show shapes flag |
| Values |
|
|
Default true |
|
top |
|
| title |
| |
| Definition of the title section for this report. The title section appears only once at the beginning of the report. |
| Contains |
| (
band?
) |
| Attributes |
|
|
top |
|
| titleExpression |
| |
| Title expression of the chart |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| topPen |
| |
| Groups the properties of the pen used to draw lines or borders. |
| Contains |
| EMPTY |
| Attributes |
|
| |
| lineWidth |
| |
| The line width of the pen. |
Required false |
| lineStyle |
| |
| The line style of the pen. |
| Values |
|
| |
Solid |
| Solid line. |
Dashed |
| Dashed line. |
Dotted |
| Dotted line. |
Double |
| Double line. |
|
Default Solid |
| 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. |
Required false |
|
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
) |
| Attributes |
|
|
top |
|
| valueAxisLabelExpression |
| |
| Defines the expression for the value axis of the chart |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| valueDataset |
| |
| Defines a dataset that contains a single value. |
| Contains |
| (
dataset?,
valueExpression
) |
| Attributes |
|
|
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. |
Default Dependent on the chart type |
Required false |
| 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. |
Required false |
|
top |
|
| valueExpression |
| |
| Defines the expression for the value of a point in a chart. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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. |
Required true |
| class |
| |
| Class of the variable values. |
Default java.lang.String |
| resetType |
| |
| Reset level for variables that perform calculations. |
| Values |
|
| |
None |
| Variable is never initialized using the initial value expression and only holds the values obtained by evaluating its main expression. |
Report |
| Variable is initialized only once, at the beginning of the report. |
Page |
| Variable is initialized at the beginning of each page. |
Column |
| Variable is initialized at the beginning of each column. |
Group |
| Variable 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". |
| incrementType |
| |
| Increment level for variables that perform calculations. |
| Values |
|
| |
None |
| Variable is incremented with every record in the data source. |
Report |
| Variable is incremented only once, at the end of the report. |
Page |
| Variable is incremented at the end of each page. |
Column |
| Variable is incremented at the end of each column. |
Group |
| Variable 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". |
| calculation |
| |
| Calculation to perform on the variable expression when filling the report. |
| Values |
|
| |
Nothing |
| No calculations are performed. |
Count |
| Variable stores the number of the not null values encountered for the variable expression. |
DistinctCount |
| Variable stores the number of distinct not null values encountered for the variable expression. |
Sum |
| Variable stores the sum of the not null values encountered for the variable expression. Numeric variables only. |
Average |
| Variable stores the average of the not null values encountered for the variable expression. Numeric variables only. |
Lowest |
| Variable stores the lowest value encountered for the variable expression. |
Highest |
| Variable stores the highest value encountered for the variable expression. |
StandardDeviation |
| Variable stores the standard deviation of the not null values encountered for the variable expression. Numeric variables only. |
Variance |
| Variable stores the variance of the not null values encountered for the variable expression. Numeric variables only. |
System |
| Variable stores a system (custom) calculated value. |
First |
| Variable 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. |
|
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. |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| volumeExpression |
| |
| Defines the volumeExpression for a <highLowDataset> |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
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
) |
| Attributes |
|
|
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
) |
| Attributes |
|
|
top |
|
| xAxisLabelExpression |
| |
| Defines the expression for the label of the X axis of the chart |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| xValueExpression |
| |
| Defines the expression for the value of the X axis of the chart |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| xyAreaChart |
| |
| Defines a area chart that uses an <xyDataset> |
| Contains |
| (
chart,
xyDataset,
areaPlot
) |
| Attributes |
|
|
top |
|
| xyBarChart |
| |
| Defines a bar chart that uses an <xyDataset> |
| Contains |
| (
chart,
timePeriodDataset |
timeSeriesDataset |
xyDataset,
barPlot
) |
| Attributes |
|
|
top |
|
| xyDataset |
| |
| Defines an XY type dataset |
| Contains |
| (
dataset,
categorySeries+ |
xySeries+
) |
| Attributes |
|
|
top |
|
| xyLineChart |
| |
| Defines a line chart that uses an <xyzDataset> |
| Contains |
| (
chart,
xyDataset,
linePlot,
) |
| Attributes |
|
|
top |
|
| xySeries |
| |
| Defines a series used in an <xyDataset> |
| Contains |
| (
seriesExpression,
xValueExpression,
yValueExpression,
labelExpression,
itemHyperlink?
) |
| Attributes |
|
|
top |
|
| xyzDataset |
| |
| Defines a dataaset used for <bubbleChart> |
| Contains |
| (
dataset,
xyzSeries
) |
| Attributes |
|
|
top |
|
| xyzSeries |
| |
| Defines a series in an <xyzDataset> |
| Contains |
| (
seriesExpression,
xValueExpression,
yValueExpression,
itemHyperlink?
) |
| Attributes |
|
|
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
) |
| Attributes |
|
|
top |
|
| yAxisLabelExpression |
| |
| Defines the expression for the Y axis label of the chart |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| yValueExpression |
| |
| Defines the value for the Y axis |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|
top |
|
| zValueExpression |
| |
| Expression that defines the value for the Z axis in an <xyzSeries> |
| Contains |
| (
#PCDATA
) |
| Attributes |
|
|