quick reference
 version 1.0.3
 
 

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

openExpression
pageFooter
pageHeader
parameter
parameterDescription
parametersMapExpression
pie3DChart
pie3DPlot
pieChart
pieDataset
piePlot
plot
printWhenExpression
property
queryString
rectangle
reportElement
reportFont
returnValue
scatterChart
scatterPlot
seriesExpression
stackedBar3DChart
stackedBarChart
staticText
subtitleExpression
subreport
subreportExpression
subreportParameter
subreportParameterExpression
summary

         
 openExpressiontop 
 Open expression for a <candlestickChart>
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 pageFootertop 
 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
 
 pageHeadertop 
 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
 
 parametertop 
 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 ( parameterDescription?, defaultValueExpression? )
 
 ATTRIBUTES
 name
 Name of the parameter.
 REQUIRED
 class
 Class of the parameter values.
 REQUIRED
 isForPrompting
 Optional flag that might be used by the parent application to prompt the user for the parameter value.
 true
 false
 DEFAULT     true
 
 parameterDescriptiontop 
 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
 
 parametersMapExpressiontop 
 Allows bulk passing the parameters to the subreport into a java.lang.Map object. There are cases when we want to pass to the subreport 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
 
 pie3DCharttop 
 Defines a pie chart with 3D effect
 
 CONTAINS ( chart, pieDataset, pie3DPlot )
 
 ATTRIBUTES
 
 pie3DPlottop 
 Defines plot options for a <pie3DChart>
 
 CONTAINS ( plot )
 
 ATTRIBUTES
 
 depthFactor
 Depth factor for a pie chart plot
 DEFAULT     0.2
 
 pieCharttop 
 Defines a pie type chart
 
 CONTAINS ( chart, pieDataset, piePlot )
 
 ATTRIBUTES
 
 pieDatasettop 
 Defines a dataset to be used with <pieChart>
 
 CONTAINS ( dataset, keyExpression, valueExpression, labelExpression? )
 
 ATTRIBUTES
 
 piePlottop 
 Plot options for a <pieChart>
 
 CONTAINS ( plot )
 
 ATTRIBUTES
 
 plottop 
 Defines generic plot options for charts
 
 CONTAINS ( EMPTY )
 
 ATTRIBUTES
 
 backcolor
 Background color of the chart
 orientation
 Orientation of the chart
 Horizontal
 Vertical
 DEFAULT     Vertical
 backgroundAlpha
 Alpha (transparency) parameter for the background
 DEFAULT     1
 foregroundAlpha
 Alpha (transparency) parameter for the foreground
 DEFAULT     1
 
 printWhenExpressiontop 
 Definition of a Boolean expression that will determine if the element or the band should be printed or not.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 propertytop 
 Allows the creation of a name-value pair property for the report.
 
 CONTAINS EMPTY 
 
 ATTRIBUTES
 name
 Name of the report property.
 REQUIRED
 value
 Value of the report property.
 
 queryStringtop 
 Contains the SQL query that will be used to retrieve the data needed to fill the report.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 rectangletop 
 Definition of a rectangle object.
 
 CONTAINS ( reportElement, graphicElement? )
 
 ATTRIBUTES
 radius
 The radius of the arc corner.
 DEFAULT     0
 
 reportElementtop 
 Element used to specify the common properties of an object on the report.
 
 CONTAINS ( 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.
 positionType
 Specifies the object position when the report section is affected by stretch.
 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.
 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.
 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.
 Opaque
 Transparent
 x
 Specifies the x coordinate for the object within the band.
 REQUIRED
 y
 Specifies the y coordinate for the object within the band.
 REQUIRED
 width
 Width of the object.
 REQUIRED
 height
 Height of the object.
 REQUIRED
 isRemoveLineWhenBlank
 Collapses the band if the element is not printing and no other element is occupying the same horizontal space.
 true
 false
 DEFAULT     false
 isPrintInFirstWholeBand
 The element gets printed in the first band of a new page or column that is not an overflow from a previous page or column.
 true
 false
 DEFAULT     false
 isPrintWhenDetailOverflows
 The element will be printed when the band overflows to a new page or a new column.
 true
 false
 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
 
 reportFonttop 
 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
 isDefault
 The default report font is used as base font for all the font definitions that do not explicitly reference a report font definition.
 true
 false
 DEFAULT     false
 fontName
 Name of the font.
 DEFAULT     sansserif
 size
 Size of the font.
 DEFAULT     10
 isBold
 true
 false
 DEFAULT     false
 isItalic
 true
 false
 DEFAULT     false
 isUnderline
 true
 false
 DEFAULT     false
 isStrikeThrough
 true
 false
 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.
 true
 false
 DEFAULT     false
 
 returnValuetop 
 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
 toVariable
 Name of the master report variable to which the value is returned. This should be a variable with calculation="System"
 REQUIRED
 calculation
 Calculation to perform on the master report variable when returning the value from the subreport.
 Nothing
 No calculations are performed.
 Count
 Variable stores the number of the 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.
 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.
 
 scatterCharttop 
 Defines a scatter chart
 
 CONTAINS ( chart, xyDataset, scatterPlot )
 
 ATTRIBUTES
 
 scatterPlottop 
 Specifies the plot options for a <scatterChart>
 
 CONTAINS ( plot, xAxisLabelExpression?, yAxisLabelExpression? )
 
 ATTRIBUTES
 
 isShowLines
 Show lines flag
 true
 false
 DEFAULT     true
 isShowShapes
 Show shapes flag
 true
 false
 DEFAULT     true
 
 seriesExpressiontop 
 Defines a series expression in a dataset
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 stackedBar3DCharttop 
 Defines a stacked bar chart with 3D effect
 
 CONTAINS ( chart, categoryDataset, bar3DPlot )
 
 ATTRIBUTES
 
 stackedBarCharttop 
 Defines a stacked bar chart
 
 CONTAINS ( chart, categoryDataset, barPlot )
 
 ATTRIBUTES
 
 staticTexttop 
 Definition of a static text object.
 
 CONTAINS ( reportElement, box?, textElement?, text? )
 
 ATTRIBUTES
 
 subtitleExpressiontop 
 Defines the expression for the chart subtitle
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 subreporttop 
 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.
 true
 false
 DEFAULT     true
 
 subreportExpressiontop 
 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.
 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
 
 subreportParametertop 
 Definition of a subreport parameter.
 
 CONTAINS ( subreportParameterExpression? )
 
 ATTRIBUTES
 name
 The name of the parameter that will be passed when filling the subreport.
 REQUIRED
 
 subreportParameterExpressiontop 
 Definition of the expression associated with the subreport parameter.
 
 CONTAINS ( #PCDATA )
 
 ATTRIBUTES
 
 summarytop 
 Definition of the summary section for this report. The summary section is printed only once at the end of the report.
 
 CONTAINS ( band? )
 
 ATTRIBUTES
 

© 2005 JasperSoft Corporation www.jaspersoft.com