|
|
|
|
|
text | top |
| Specifies the text to print for a static text object. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
textElement | top |
| 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. |
| 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. |
| 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. |
| 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. |
| DEFAULT None |
| lineSpacing |
| Type of line spacing for the text object. |
| 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 . |
| 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 |
|
textField | top |
| Definition of a text field object. |
|
CONTAINS (
reportElement,
box?,
textElement?,
textFieldExpression?,
anchorNameExpression?,
hyperlinkReferenceExpression?,
hyperlinkAnchorExpression?,
hyperlinkPageExpression?
) |
|
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. |
| true |
| false |
| DEFAULT false |
| evaluationTime |
| Text to be printed is supplied by the text field associated expression. This expression can be evaluated at a specified moment. This could be useful, for example, when we want to have on the first page the total number of pages. The total number of pages is known only after filling the entire report, so we can specify that the text filed that will represent the total number of pages placed at the beginning of the report should be evaluated only when reaching the end of the report. |
| 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. |
| 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 . |
| true |
| false |
| 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 |
|
textFieldExpression | top |
| Defines the expression to use for this textField. |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
| class |
| Class for the text field 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 |
|
timeAxisLabelExpression | top |
| Defines the expression used for the time axis label |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
timePeriodDataset | top |
| Defines a time period dataset |
|
CONTAINS (
dataset,
timePeriodSeries +
) |
|
ATTRIBUTES |
|
timePeriodExpression | top |
| Defines the expression used for a time period |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
timePeriodSeries | top | |
| Defines a time period series for a <timePeriodDataset> |
|
CONTAINS (
seriesExpression,
startDateExpression,
endDateExpression,
valueExpression,
labelExpression
) |
|
ATTRIBUTES |
|
timeSeries | top | |
| Defines a time series for <timeSeriesDataset> . |
|
CONTAINS (
seriesExpression,
timePeriodExpression,
valueExpression,
labelExpression ?
) |
|
ATTRIBUTES |
|
timeSeriesChart | top | |
| Defines a time series chart |
|
CONTAINS (
chart,
timeSeriesDataset,
timeSeriesPlot
) |
|
ATTRIBUTES |
|
timeSeriesDataset | top | |
| Defines a time series dataset |
|
CONTAINS (
dataset,
timeSeries +
) |
|
ATTRIBUTES |
|
| timePeriod |
| Time period for the dataset |
| Year |
| Quarter |
| Month |
| Week |
| Day |
| Hour |
| Minute |
| Second |
| Milisecond |
| DEFAULT Day |
|
timeSeriesPlot | top |
| Defines plot options for a <timeSeriesChart> |
|
CONTAINS (
plot,
timeAxisLabelExpression,
valueAxisLabelExpression
) |
|
ATTRIBUTES |
|
| isShowLines |
| Show lines flag |
| true |
| false |
| DEFAULT true |
| isShowShapes |
| Show shapes flag |
| true |
| false |
| DEFAULT true |
|
title | top |
| Definition of the title section for this report. The title section appears only once at the beginning of the report. |
|
CONTAINS (
band?
) |
|
ATTRIBUTES |
|
titleExpression | top |
| Title expression of the chart |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
valueAxisLabelExpression | top |
| Defines the expression for the value axis of the chart |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
variable | top |
| 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 |
| class |
| Class of the variable values. |
| DEFAULT java.lang.String |
| resetType |
| Reset level for variables that perform calculations. |
| 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. |
| 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. |
| Nothing |
| No calculations are performed. |
| Count |
| Variable stores the number of the 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. |
| 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. |
|
variableExpression | top |
| 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 |
|
volumeExpression | top |
| Defines the volumeExpression for a <highLowDataset> |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
xAxisLabelExpression | top |
| Defines the expression for the label of the X axis of the chart |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
xValueExpression | top |
| Defines the expression for the value of the X axis of the chart |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
xyAreaChart | top | |
| Defines a area chart that uses an <xyDataset> |
|
CONTAINS (
chart,
xyDataset,
areaPlot
) |
|
ATTRIBUTES |
|
xyBarChart | top | |
| Defines a bar chart that uses an <xyDataset> |
|
CONTAINS (
chart,
timePeriodDataset |
timeSeriesDataset |
xyDataset,
barPlot
) |
|
ATTRIBUTES |
|
xyDataset | top | |
| Defines an XY type dataset |
|
CONTAINS (
dataset,
categorySeries+ |
xySeries+
) |
|
ATTRIBUTES |
|
xyLineChart | top | |
| Defines a line chart that uses an <xyzDataset> |
|
CONTAINS (
chart,
xyDataset,
linePlot,
) |
|
ATTRIBUTES |
|
xySeries | top | |
| Defines a series used in an <xyDataset> |
|
CONTAINS (
seriesExpression,
xValueExpression,
yValueExpression,
labelExpression
) |
|
ATTRIBUTES |
|
xyzDataset | top | |
| Defines a dataaset used for <bubbleChart> |
|
CONTAINS (
dataset,
xyzSeries
) |
|
ATTRIBUTES |
|
xyzSeries | top | |
| Defines a series in an <xyzDataset> |
|
CONTAINS (
seriesExpression,
xValueExpression,
yValueExpression
) |
|
ATTRIBUTES |
|
yAxisLabelExpression | top |
| Defines the expression for the Y axis label of the chart |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
yValueExpression | top |
| Defines the value for the Y axis |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|
zValueExpression | top |
| Expression that defines the value for the Z axis in an <xyzSeries> |
|
CONTAINS (
#PCDATA
) |
|
ATTRIBUTES |
|