quick reference
 version 1.1.1
 
 

 
     
  A..D   E..L   M..S   T..Z

anchorNameExpression
areaChart
areaPlot
background
band
bar3DChart
bar3DPlot
barChart
barPlot
box
bubbleChart
bubblePlot
bucket
bucketExpression
candlestickChart
candlestickPlot
categoryAxisLabelExpression
categoryDataset
categorySeries
cellContents
chart
chartSubtitle
chartTitle
closeExpression
columnFooter
columnHeader
columnGroup
comparatorExpression
connectionExpression
crosstab
crosstabCell
crosstabColumnHeader
crosstabDataset
crosstabParameter
crosstabRowHeader
crosstabTotalColumnHeader
crosstabTotalRowHeader
dataset
datasetParameter
datasetParameterExpression
datasetRun
dataSourceExpression
dateExpression
detail
defaultValueExpression

         
 anchorNameExpressiontop 
 If specified, it will supply the name of the local anchor that will mark to the corresponding element.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 areaCharttop 
 Defines an area chart
 
 CONTAINS ( chart, categoryDataset, areaPlot )
 
 ATTRIBUTES
 
 areaPlottop 
 Defines rendering options for an <areaChart>
 
 CONTAINS ( plot, categoryAxisLabelExpression?, valueAxisLabelExpression? )
 
 ATTRIBUTES
 
 backgroundtop 
 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
 
 bandtop 
 Generic definition of a report section.
 
 CONTAINS ( printWhenExpression?, ( line | rectangle | ellipse | image | staticText | textField | subreport | pieChart | pie3DChart | barChart | bar3DChart | xyBarChart | stackedBarChart | stackedBar3DChart | lineChart | xyLineChart | areaChart | xyAreaChart | scatterChart | bubbleChart | timeSeriesChart | highLowChart | candlestickChart | 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.
 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
 
 bar3DCharttop 
 Defines a bar chart with 3D effect
 
 CONTAINS ( chart, categoryDataset, bar3DPlot )
 
 ATTRIBUTES
 
 bar3DPlottop 
 Defines plot options for a bar chart with 3D effect
 
 CONTAINS ( plot, categoryAxisLabelExpression?, valueAxisLabelExpression? )
 
 ATTRIBUTES
 
 isShowLabels
 Show labels flag
 true
 false
 DEFAULT     false
 xOffset
 Offset on the x axis
 yOffset
 Offset on the y axis
 
 barCharttop 
 Defines a bar chart. Dataset used with this chart is <categoryDataset>
 
 CONTAINS ( chart, categoryDataset, barPlot )
 
 ATTRIBUTES
 
 barPlottop 
 Plot options for a <barChart>
 
 CONTAINS ( plot, category?, valueAxisLabelExpression? )
 
 ATTRIBUTES
 
 isShowLabels
 Show labels flag
 true
 false
 DEFAULT     false
 isShowTickMarks
 Show tick marks on the value axis
 true
 false
 DEFAULT     true
 isShowTickLabels
 Show tick labels on the value axis
 true
 false
 DEFAULT     true
 
 boxtop 
 Element used to specify the common properties of a graphic object on the report (line, rectangle, ellipse or image).
 
 CONTAINS EMPTY 
 
 ATTRIBUTES
 border, topBorder, leftBorder, bottomBorder, rightBorder
 Type of the border to draw around the element.
 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
 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
 
 bubbleCharttop 
 Creates a bubble chart
 
 CONTAINS ( chart, xyzDataset, bubblePlot )
 
 ATTRIBUTES
 
 bubblePlottop 
 Plot options for a <bubbleChart>
 
 CONTAINS ( plot, xAxisLabelExpression, yAxisLabelExpression )
 
 ATTRIBUTES
 
 scaleType
 Scale options for the bubble chart items
 BothAxes
 DomainAxis
 RangeAxis
 DEFAULT     RangeAxis
 
 buckettop 
 Crosstab group bucketing information.
 
 CONTAINS ( bucketExpression, comparatorExpression? )
 
 ATTRIBUTES
 
 order
 The bucket order type.
 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
 
 bucketExpressiontop 
 Crosstab group bucketing expression.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 class
 The bucket values class.
 REQUIRED
 
 candlestickCharttop 
 Creates a candlestick chart
 
 CONTAINS ( chart, highLowDataset, candlestickPlot )
 
 ATTRIBUTES
 
 candlestickPlottop 
 Plot options for a <candlestickChart>
 
 CONTAINS ( plot, timeAxisLabelExpression?, valueAxisLabelExpression )
 
 ATTRIBUTES
 
 isShowVolume
 Flag that enables showing volume values for a <candlestickChart>
 true
 false
 DEFAULT     true
 categoryAxisLabelExpressiontop 
 Expression that will be displayed on category axis
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 categoryDatasettop 
 Creates a dataset with one or more series and values associated with categories
 
 CONTAINS ( dataset, categorySeries + )
 
 ATTRIBUTES
 
 categorySeriestop 
 Defines a series that will be mapped on the category axis
 
 CONTAINS ( seriesExpression, categoryExpression, valueExpression, labelExpression? )
 
 ATTRIBUTES
 
 cellContentstop 
 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 crosstab has opaque mode. The default cell background color is the crosstab element background color.

 
 charttop 
 Defines a chart report element
 
 CONTAINS ( reportElement, box?, chartTitle?, chartSubtitle? )
 
 ATTRIBUTES
 isShowLegend
 Show legend flag
 true
 false
 DEFAULT     true
 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.
 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.
 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.
 DEFAULT     None
 hyperlinkTarget
 Indicates the target of the hyperlink.
 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.

 
 chartSubtitletop 
 Subtitle of the chart
 
 CONTAINS ( font?, subtitleExpression? )
 
 ATTRIBUTES
 color
 Color of the subtitle text
 
 chartTitletop 
 Title text of the chart
 
 CONTAINS ( font?, titleExpression? )
 
 ATTRIBUTES
 position
 Position of the title
 Top
 Bottom
 Left
 Right
 DEFAULT     Top
 color
 Color of the title text
 
 closeExpressiontop 
 Expression for the close value for <candlestickChart>
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 columnFootertop 
 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
 
 columnHeadertop 
 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
 
 columnGrouptop 
 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
 
 height
 The height of the column group header.
 REQUIRED
 
 totalPosition
 The position of the total column for this group.

A group can have a total column summing the values for all the entries in the group. E.g. if there is a Year group having Month as a subgroup, the total column for the Year group would sum the values for all the years and the total column for the Month group would sum the values for all the months of an year.

 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.

 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
 
 comparatorExpressiontop 
 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
 
 connectionExpressiontop 
 If present, it is used to pass the java.sql.Connection object to the subreport filling or subdataset iteration routines.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 crosstabtop 
 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*, rowGroup*, columnGroup*, measure*, crosstabCell*, whenNoDataCell? )
 
 ATTRIBUTES
 
 isRepeatColumnHeaders
 Flag that indicates whether the column headers will be reprinted after a page break.
 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.
 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
 
 crosstabCelltop 
 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.
 
 crosstabColumnHeadertop 
 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? )
 
 crosstabDatasettop 
 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.

 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
 
 crosstabParametertop 
 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
 class
 Class of the parameter values.
 REQUIRED
 
 crosstabRowHeadertop 
 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? )
 
 crosstabTotalColumnHeadertop 
 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? )
 
 crosstabTotalRowHeadertop 
 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? )
 
 datasettop 
 Dataset definition for a chart or crosstab.
 
 CONTAINS ( datasetRun? )
 
 ATTRIBUTES
 
 resetType
 Reset type for the dataset
 None
 Report
 Page
 Column
 Group
 DEFAULT     Report
 resetGroup
 Reset group name
 incrementType
 incrementType description
 None
 Report
 Page
 Column
 Group
 DEFAULT     Report
 incrementGroup
 Increment group of the dataset
 
 datasetParametertop 
 Definition of a subdataset parameter.
 
 CONTAINS ( datasetParameterExpression? )
 
 ATTRIBUTES
 name
 The name of the parameter that will be passed when iterating the subdataset.
 REQUIRED
 
 datasetParameterExpressiontop 
 Definition of the expression associated with the subdataset parameter.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 datasetRuntop 
 Subdataset instantiation information for a chart/crosstab dataset.
 
 CONTAINS ( parametersMapExpression?, datasetParameter*, ( connectionExpression | dataSourceExpression )? )
 
 ATTRIBUTES
 
 subDataset
 The name of the subdataset to instantiate.
 REQUIRED
 
 dataSourceExpressiontop 
 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
 
 dateExpressiontop 
 Represents a date expression used in <time series chart>
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 detailtop 
 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
 
 defaultValueExpressiontop 
 Specifies the parameter default value to use when not supplied by the parent application at runtime.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 


© 2005 JasperSoft Corporation www.jaspersoft.com