|
|
|
|
|
measure | top |
| 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.
|
|
CONTAINS (
measureExpression
) |
|
ATTRIBUTES |
|
| name |
| Measure name. |
| REQUIRED |
|
| class |
| The measure values class. |
| REQUIRED |
|
| calculation |
| The calculation type to be performed on the measure values. |
| Nothing |
| No calculations are performed. |
| Count |
| The measure stores the number of the 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 .
|
| 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.
|
|
measureExpression | top |
| Crosstab measure expression. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
openExpression | top |
| Open expression for a <candlestickChart> |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
pageFooter | top |
| 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 |
|
pageHeader | top |
| 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 |
|
parameter | top |
| 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 |
|
parameterDescription | top |
| 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 |
|
parameterValueExpression | top |
| Crosstab parameter value expression. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
parametersMapExpression | top |
| 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 |
|
pie3DChart | top |
| Defines a pie chart with 3D effect |
|
CONTAINS (
chart,
pieDataset,
pie3DPlot
) |
|
ATTRIBUTES |
|
pie3DPlot | top |
| Defines plot options for a <pie3DChart> |
|
CONTAINS (
plot
) |
|
ATTRIBUTES |
|
| depthFactor |
| Depth factor for a pie chart plot |
| DEFAULT 0.2 |
|
pieChart | top |
| Defines a pie type chart |
|
CONTAINS (
chart,
pieDataset,
piePlot
) |
|
ATTRIBUTES |
|
pieDataset | top |
| Defines a dataset to be used with <pieChart> |
|
CONTAINS (
dataset,
keyExpression,
valueExpression,
labelExpression?
) |
|
ATTRIBUTES |
|
piePlot | top |
| Plot options for a <pieChart> |
|
CONTAINS (
plot
) |
|
ATTRIBUTES |
|
plot | top |
| 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 |
|
printWhenExpression | top |
| Definition of a Boolean expression that will determine if the element or the band should be printed or not. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
property | top |
| 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. |
|
queryString | top |
| Contains the SQL query that will be used to retrieve the data needed to fill the report. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
rectangle | top |
| Definition of a rectangle object. |
|
CONTAINS (
reportElement,
graphicElement?
) |
|
ATTRIBUTES |
| radius |
| The radius of the arc corner. |
| DEFAULT 0 |
|
reportElement | top |
| 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. |
| 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. |
| 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 |
|
reportFont | top |
| 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 |
|
rowGroup | top |
| 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 |
|
| width |
| The width of the row group header. |
| REQUIRED |
|
| totalPosition |
| The position of the total row for this group.
A group can have a total row summing the values for all the entries in the group.
E.g. if there is a Year group having Month as a subgroup, the total row for the Year group would sum the values for all the years and the total row for the Month group would sum the values for all the months of an year.
|
| 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.
|
| 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 |
|
returnValue | top |
| 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. |
| 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. |
|
scatterChart | top |
| Defines a scatter chart |
|
CONTAINS (
chart,
xyDataset,
scatterPlot
) |
|
ATTRIBUTES |
|
scatterPlot | top |
| 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 |
|
seriesExpression | top |
| Defines a series expression in a dataset |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
stackedBar3DChart | top |
| Defines a stacked bar chart with 3D effect |
|
CONTAINS (
chart,
categoryDataset,
bar3DPlot
) |
|
ATTRIBUTES |
|
stackedBarChart | top |
| Defines a stacked bar chart |
|
CONTAINS (
chart,
categoryDataset,
barPlot
) |
|
ATTRIBUTES |
|
staticText | top |
| Definition of a static text object. |
|
CONTAINS (
reportElement,
box?,
textElement?,
text?
) |
|
ATTRIBUTES |
|
style | top |
| Definition of a report style. |
|
CONTAINS EMPTY |
|
ATTRIBUTES |
| name |
| Name of the report style definition. |
| REQUIRED |
| isDefault |
| The default report style is used as base style for all the elements that do not explicitly reference a report style definition. |
| true |
| false |
| DEFAULT false |
| style |
| Parent style reference. |
| mode |
| forecolor |
| backcolor |
| pen |
| fill |
| radius |
| scaleImage |
| hAlign |
| vAlign |
| border |
| borderColor |
| padding |
| topBorder |
| topBorderColor |
| topPadding |
| leftBorder |
| leftBorderColor |
| leftPadding |
| bottomBorder |
| bottomBorderColor |
| bottomPadding |
| rightBorder |
| rightBorderColor |
| rightPadding |
| rotation |
| lineSpacing |
| isStyledText |
| fontName |
| fontSize |
| isBold |
| isItalic |
| isUnderline |
| isStrikeThrough |
|
subDataset | top |
| 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 (
parameter*,
queryString?,
field*,
variable*,
group*
) |
|
ATTRIBUTES |
| name |
| Name of the dataset. |
| REQUIRED |
| scriptletClass |
| Indicates which class implements the scriptlets functionality for this dataset. The specified class must be a subclass of JRAbstractScriptlet class. If omitted, an instance of JRDefaultScriptlet will be created. |
| 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. |
| 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 |
|
subtitleExpression | top |
| Defines the expression for the chart subtitle |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
subreport | top |
| 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 |
|
subreportExpression | top |
| 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 |
|
subreportParameter | top |
| Definition of a subreport parameter. |
|
CONTAINS (
subreportParameterExpression?
) |
|
ATTRIBUTES |
| name |
| The name of the parameter that will be passed when filling the subreport. |
| REQUIRED |
|
subreportParameterExpression | top |
| Definition of the expression associated with the subreport parameter. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
summary | top |
| Definition of the summary section for this report. The summary section is printed only once at the end of the report. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|