java.lang.String code of the locale to be used when parsing the CSV data.
java.lang.String value of the time zone id to be used when parsing the CSV data.
false for report parameters and true for
subreport elements, subdataset run and report parts.
true.
true.
list.
Result pagination is implemented by org.hibernate.Query.setFirstResult() and org.hibernate.Query.setMaxResults().
By default, all the rows are retrieved (no result pagination is performed).
list - the query will be run by calling org.hibernate.Query.list()iterate - the query will be run by calling org.hibernate.Query.iterate()scroll - the query will be run by calling org.hibernate.Query.scroll()fieldDescription attribute, but using this custom property is now recommended.
java.sql.ResultSet created by the
java.sql.ResultSet created by the
forwardOnly - the cursor may move only forward.scrollInsensitive - the result set is scrollable but generally not sensitive to changes made by others.scrollSensitive - the result set is scrollable and generally sensitive to changes made by others.java.sql.ResultSet created by the
readOnly - the concurrency mode for a ResultSet object that may NOT be updated.updatable - the concurrency mode for a ResultSet object that may be updated.java.sql.ResultSet created by the
hold - indicates that ResultSet objects should not be closed when the method Connection.commit() is called.close - indicates that ResultSet objects should be closed when the method Connection.commit() is called.ResultSet column
storing character or binary values created by the
Statement created by the
net.sf.jasperreports.jaxen.util.xml.JaxenXPathExecuterFactoryfieldDescription attribute, but using this custom property is now recommended.
net.sf.jasperreports.jdt.JRJdtCompiler is used as report compiler, if available, and net.sf.jasperreports.engine.design.JRJdk13Compiler otherwise.
false.
<property name="net.sf.jasperreports.export.xml.replace.invalid.chars" value=""/>
<property name="net.sf.jasperreports.export.xml.replace.invalid.chars" value="??"/>
<property name="net.sf.jasperreports.export.xml.replace.invalid.chars"/>
false, the report is verified not
to contain elements with negative width values. This is useful when the report is
meant to be exported to grid-based formats such as HTML, XLS or CSV, which might enter
an infinite loop. Having elements with negative widths does not make sense, but allowing
this is a workaround in case older report templates still need to pass validation
at report compile time.
false, elements in the report are verified to have positive X offsets. Otherwise, no check is performed on element X offsets.
false, elements in the report are verified to have positive Y offsets. Otherwise, no check is performed on element Y offsets.
false, the report is verified not
to contain elements that overlap. This is useful when the report is
meant to be exported to grid-based formats such as HTML, XLS or CSV.
Setting this property to false ensures that element overlap
issues are caught at report compile time.
false, the
report is verified not to have any content in the background section as
this content would likely be overlapped by other sections and would not
show in grid-based exporters.
true which means that
no element overlap checks are performed.
true;
setting the property to false does not make the verifier
check for overlaps when the report is not set to be checked for element
overlaps.OpaqueTransparentSolidClipFillFrameRetainShapeRealHeightRealSizeLeftCenterRightJustifiedTopMiddleBottomJustifiedLeftCenterRightTopMiddleBottomNoneLeftRightUpsideDownnonestyledhtmlrtf<patternExpression/>, if present.
isBlankWhenNull feature of the element.
isPdfEmbedded style of the element.
SolidDashedDottedDoubleSolidDashedDottedDoubleSolidDashedDottedDoubleSolidDashedDottedDoubleSolidDashedDottedDoubleSolidDashedDottedDoubleSingle1_1_2DoubleAtLeastFixedProportionalAtLeastFixedProportionaltextAdjust property of text elements which needs to be set to ScaleFont value.
textAdjust property of text elements which needs to be set to CutText value.
named net.sf.jasperreports.text.measurer.factory.{alias} which has the name of the factory class as value.
The net.sf.jasperreports.text.measurer.factory property is set to a defined alias or a full factory class name.
The factory class is used to instantiate text measurers for report text elements, which are then used to compute the text layout attributes.
There are two builtin text measurer implementations: default and
naive.
The default text measurer implementation performs text measuring,
stretching and truncation and is meant to be used when text layout is relevant,
which would be most report executions.
The naive text measurer implementation does not perform any text
measuring, it blindly considers any text to fit in the element boundaries
without any stretching or truncation.
It is therefore unsuitable for exporters that honour element dimensions, like
the PDF and HTML exporters and all other exporters that are meant to be close
to the pixel perfect layout of reports.
It should only be used for reports exported to data-centric outputs that do not
rely on any actual text measurements, such as the CSV, JSON metadata and the
Excel exporters.
For Excel exporters the naive text measurer should be accompanied
by net.sf.jasperreports.export.xls.auto.fit.row=true if cells in
Excel are expected to grow vertically in order to fit their contents, otherwise
texts that would have normally stretched would not be fully visible in Excel
(but the full text would still be present in the cell and accessible when the
cell is selected).
java.io.File#deleteOnExit() should be requested for temporary files created by the virtualizer.
Temporary files will be deleted by explicitly calling cleanup() or from the virtualizer finalize() method.
For most paginated reports, a virtual page corresponds to a report page. But for non-paginated reports and for reports having very large pages, a report page is broken into several virtual pages which are handled individually by the virtualizer.
This property provides the size of a virtual page in print elements. Note that virtual page sizes will actually vary around the configured size since there are cases when fewer elements remain on a report page and cases when the configured size is exceeded due to print frames being included at the end of virtual page.
If set to 0 or negative, report pages will not be broken into several virtual pages.
whenNoDataType attribute of report.
always, rectangle elements will be always generated, otherwise they will be created
only if the subreport element is not transparent or it has properties.
true, conditional style expressions of the style that is
associated with the element are evaluated at the moment the element is
set to evaluate, and the resulting style to the generated print element.
ignoreWidth attribute.
false, then setting this property will have no effect.
false, then setting this property will have no effect.
whenNoDataType attribute of table components.
net.sf.jasperreports.extension.registry.factory. and an arbitrary name suffix
which is used as registry ID when instantiating. The property should have as value the name of a
"net.sf.jasperreports.extension.".
net.sf.jasperreports.extension.chart.theme.spring.beans.resource contains the spring beans resource bundle location
for the spring-based extensions registry class with the "chart.theme" registry ID.
net.sf.jasperreports.properties has been set then the specified properties file is loaded.
Otherwise the jasperreports.properties file is loaded, if found in the classpath.
java.sql.Date in the report.
java.sql.Time in the report.
java.sql.Timestamp in the report.
JRXmlWriter true.
always - the entire text is measured without considering possible line breaksmultiline - the entire text is measured taking into account possible line breaksJRReport object. Properties with matching names will be
excluded from the generated JRXML representation.
net.sf.jasperreports.export.{format}.exclude properties.
Setting this property to true will exclude the element from all export formats except the ones for which
net.sf.jasperreports.export.{format}.exclude is explicitly set to false.
{format} token are
pdf, html, xls, xlsx, rtf, odt, ods, csv
and txt.
The element will be excluded from a specific export format if the property is set to true at element level.
{format} token are
pdf, html, xls, xlsx, rtf, odt, ods, csv
and txt. The {suffix} token can be either the element's key value or an arbitrary string. The value of the property, if
defined, should be the element's key value. If the property has no value, its suffix will be assumed as a value.
<jasperReport ...>
<!-- exclude elements with keys Image1 and Text4 from HTML export -->
<property name="net.sf.jasperreports.export.html.exclude.key.Image1"/>
<property name="net.sf.jasperreports.export.html.exclude.key.Text4"/>
<!-- exclude elements with keys Image5 from PDF export -->
<property name="net.sf.jasperreports.export.pdf.exclude.key.the.image" value="Image5"/>
...
</jasperReport>
{format} token are
pdf, html, xls, xlsx, rtf, odt, csv
and txt. The {suffix} token can be: band, group or
report.
{format} token are
pdf, html, xls, xlsx, rtf, odt, csv
and txt. The {suffix} token can be: band, group or
report.
net.sf.jasperreports.export.filter.factory.
and a suffix indicating the considered filter element.
net.sf.jasperreports.export.filter.factory.origin indicates an element origin filter factory.
net.sf.jasperreports.export. concatenated with an arbitrary name indicating the exporter type and
the property suffix default.filter.factory.
net.sf.jasperreports.export.xls.default.filter.factory.
If this property is not defined for a specific exporter, the generic
exporter factory given by net.sf.jasperreports.export.csv.column.names.' prefix contain a list of
comma-separated names of the columns used in the metadata-based CSV export.
  or ) will be taken into account.
" instead of ", ' instead of ', etc:
<property name="net.sf.jasperreports.export.csv.field.enclosure" value="""/>
<property name="net.sf.jasperreports.export.csv.field.enclosure" value="'"/>
true, any page in the document will be exported without taking into account its margins.
false, the frame content will be integrated into the master/page table.
false, the table rows do not increase in height automatically and the user has to enlarge them manually.
true, the text line before the new paragraph will lose the justified alignment.
false (for backward compatibility reasons).
false.
border-collapse CSS property to be applied
to the table generated for the report. Possible values are:
separatecollapse (default)initialinheritclass attribute of elements when exported to HTML format. The value of this property
will be used as the value for the class attribute of the <td> tag for the element when exported to HTML.
ID attribute of elements when exported to HTML format. The value of this property will be used
as the value for the id attribute of the <td> tag for the element when exported to HTML.
word-wrap: break-word).
false, the rows in the ODS document do not increase in height automatically and the user has to enlarge them manually. Otherwise,
the table rows will adjust their height automatically in order to fit their content in.
false, the table rows in the ODT document do not increase in height automatically and the user has to enlarge them manually.
Otherwise, the table rows will adjust their height automatically in order to fit their content in.
true, export parameters override report hints; this is the default behavior.
slidenum - the current slide number will be displayed in this fielddatetime - the current date/time will be displayed in this field, according to default date/time rendering format of the PPTX viewer applicationdatetime1 - the current date will be displayed using a localized 'MM/dd/yyyy' date formatdatetime2 - the current date will be displayed using a localized 'Day, Month dd, yyyy' date formatdatetime3 - the current date will be displayed using a localized 'dd Month yyyy' date formatdatetime4 - the current date will be displayed using a localized 'Month dd, yyyy' date formatdatetime5 - the current date will be displayed using a localized 'dd-Mon-yy' date formatdatetime6 - the current date will be displayed using a localized 'Month yy' date formatdatetime7 - the current date will be displayed using a localized 'Mon-yy' date formatdatetime8 - the current date/time will be displayed using a localized 'MM/dd/yyyy hh:mm a' date time formatdatetime9 - the current date/time will be displayed using a localized 'MM/dd/yyyy hh:mm:ss a' date time formatdatetime10 - the current time will be displayed using a localized 'HH:mm' timestamp formatdatetime11 - the current time will be displayed using a localized 'HH:mm:ss' timestamp formatdatetime12 - the current time will be displayed using a localized 'hh:mm a' timestamp formatdatetime13 - the current time will be displayed using a localized 'hh:mm:ss a' timestamp formatfalse.
Start - The current cell will be marked as autofilter heading cell, and column data below/to the right of
this cell can be considered as part of the autofilter data range. The starting point of the autofilter data range will be
the next cell below the current cell (ie if the current cell reference is B4, the autofilter range will start with the "B5"
cell reference: "B5:M20").
Start values are found in the same sheet, only the last one will be considered. If the
Start value is present but no End value is found in the sheet, then only the current column will
be considered for the data range.
Start value is set on the same row as the autofilter End value, the data range
will include all data below this heading row, placed between the start column and the end column.End - The current cell will be marked as autofilter ending cell, and column data in this cell and
above/to the left can be considered as part of the autofilter data range. The ending cell in the data range is the
current cell reference (ie if the current cell reference is M20, the autofilter range will end in "M20": "B5:M20").
The heading cell for the current column will be placed in the same column on the row containing the autofilter Start value.
Start value is found in the sheet, the autofilter End value will be considered
as Start value instead.
End values are found in the same sheet, only the last one will be considered.
Start value is set on the same row as the autofilter End value, the data range
will include all data below this heading row, placed between the start column and the end column.truefalsetruefalsetruefalsetruefalse - this is the default value.net.sf.jasperreports.export.xls.column.names.' prefix contain a list of comma-separated
column names used in the metadata-based Excel export.
width attribute.
width attribute.
width attribute.
false), and the cell content is not hidden.
true), but it only has effect if the enclosing sheet is protected.
false).
{arbitrary_name} part) serves as name identifier and should
be in accordance with the following rules (see Rules for Excel defined names):
"A10", "$A$10" or "R2C5" are invalid)"name1", "Name1" and "NAME1" represent the same name"|") sign:
"Sheet_1!$A$10", "Sheet_1!A10", or "'Sheet 1'!$A$10");
the "A10" cell reference is relative, while "$A$10" is absolute"Sheet_1!A10:C20", "Sheet_1!$A$10:$C$20", "'Sheet 1'!$A$10:$C$20")"SUM('Sheet 1'!$A$10:$C$20)")"workbook" literal constant, representing the entire workbook. In case this second part
is missing, the scope associated by default will be the entire workbook.<property name="net.sf.jasperreports.export.xls.defined.names.test_sum" value="SUM(Sheet_1!$A$10:$C$20)|SecondSheet"/>"test_sum", is visible only in a sheet named "SecondSheet" and is associated
with a formula that calculates a sum over the cell range [$A$10:$C$20] belonging to a sheet named "Sheet_1".
<property name="net.sf.jasperreports.export.xls.defined.names.test_range" value="'Sheet 1'!$A$10:$C$20"/>"test_range", is visible in the entire workbook and is associated
with the cell range [$A$10:$C$20] in the sheet named "Sheet 1".
<property name="net.sf.jasperreports.export.xls.defined.names.test_sum_1" value="SUM(Sheet_1!$A$10:$C$20)|Sheet_1"/><property name="net.sf.jasperreports.export.xls.defined.names.test_sum_all" value="Sheet_1!test_sum_1"/>test_sum_1 is visible only in the sheet named Sheet_1.
test_sum_all is visible in the entire workbook and refers to the test_sum_1 name defined for Sheet_1.
test_sum_all) are NOT supported for
the XLS (Excel 2003) export format. They work only in the XLSX (Excel 2007 or newer) exporter. A good practice would be to use only names
visible in the entire workbook when exporting to XLS.
net.sf.jasperreports.export.xls.fit.height property.
net.sf.jasperreports.export.xls.fit.width property.
truefalsenet.sf.jasperreports.export.xls.pattern. prefix are used to store specific Excel
format patterns that correspond to their related Java format pattern. The {arbitrary_pattern} suffix represents
the Java pattern and the property value is the related Excel pattern. When these properties are defined in a JRXML report design,
special characters should be XML-escaped. When they are defined in a properties file, one should also escape special characters.
If some properties are defined in the report, they will override the context properties.
true, local anchors will be excluded from export.
Otherwise they will be exported along with elements they belong to.
MoveSize - images move and size with cellsMoveNoSize - images move but don't size with cellsNoMoveNoSize - images don't move or size with cellstrue instructs the exporter to use he report fill timezone to export date values.
net.sf.jasperreports.export.xls.detect.cell.type is set.
truefalse - this is the default value.Left - the current column is the first unlocked column in the sheet. All columns to the left are 'frozen'.
Right - the current column is the last 'frozen' column in the sheet. All columns to the right are unlocked.
Top - the current row is the first unlocked row in the sheet. All rows above are 'frozen'.
Bottom - the current row is the last 'frozen' row in the sheet. All rows below are unlocked.
null).
null).
net.sf.jasperreports.export.xls.outline.level.2 property means that its value is correlated with
the outline level 2, so the current row belongs to a level 2 row group. Based on Office Open XML specs, allowed values for outline
levels are positive integers from 1 to 7.
null). When such a property occurrence is met, the suffix
indicates the outline level for that row. If multiple properties with the same prefix are defined for the same row, the deepest
outline level is considered for that row. To end an outline row group one has to set the related outline level property with the
End value. This is a special property value instructing the JR engine that the current row group of that level ends
on the current row.
LTRRTL<property name="net.sf.jasperreports.export.xls.sheet.header.left" value="Page &P of &N"/>
<property name="net.sf.jasperreports.export.xls.sheet.header.center" value="Page &P of &N"/>
<property name="net.sf.jasperreports.export.xls.sheet.header.right" value="Page &P of &N"/>
<property name="net.sf.jasperreports.export.xls.sheet.footer.left" value="Page &P of &N"/>
<property name="net.sf.jasperreports.export.xls.sheet.footer.center" value="Page &P of &N"/>
<property name="net.sf.jasperreports.export.xls.sheet.footer.right" value="Page &P of &N"/>
net.sf.jasperreports.export.xls.sheet.names. prefix, followed by an
arbitrary suffix. Each property can hold a single sheet name or several names
separated by the slash ("/") character. Values are collected in the
order in which the properties appear in the JRXML template, so one has to be careful with the
order when editing a JRXML. The property suffixes are not important, but the order of the properties matters.
<property name="net.sf.jasperreports.export.xls.sheet.names.sheet1" value="First sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.second.sheet.name" value="Second sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.3" value="Third sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.all" value="First
sheet/Second sheet/Third sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.first" value="First
sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.others"
value="Second sheet/Third sheet" />
false, text wrapping is forbidden, otherwise it is allowed.
false, it forces the engine to check if the font used as value for the fontName attribute inside
the report template is available either through the JasperReports font extension mechanism or as a JVM accesible font,
and raise a java.math.BigDecimal division operations.
Important note: this property is only effective when Java 1.5 or newer is used. See <property name="net.sf.jasperreports.components.table.version" value="4.0.0" />
ignore - page breaks are ignored in non paginated reports.apply - page breaks are honoured in non paginated reports.Early - Evaluate the parameter default value expression before parameter contributors.Late - Evaluate the parameter default value expression after parameter contributors.Early - Evaluate the property expression before parameter contributors.Late - Evaluate the property expression after parameter contributors.Report - Evaluate the property expression at the end of the report.REPORT_LOCALE parameter value.
REPORT_TIME_ZONE parameter value.
java.sql.Date values.
Locale specific values can be configured by appending _<locale code> to the property name.
The property can be set at global/JasperReports context level.
java.sql.Time values.
Locale specific values can be configured by appending _<locale code> to the property name.
The property can be set at global/JasperReports context level.
java.util.Date values other than java.sql.Date and java.sql.Time.
Locale specific values can be configured by appending _<locale code> to the property name.
The property can be set at global/JasperReports context level.
java.math.BigInteger.
Locale specific values can be configured by appending _<locale code> to the property name.
The property can be set at global/JasperReports context level.
Locale specific values can be configured by appending _<locale code> to the property name.
The property can be set at global/JasperReports context level.
The property can be set at report and global/JasperReports context levels. The property value can be NoBorders, in which case frames that span two pages do not have the bottom border of the first fragment and the top border of the second fragment drawn, and DrawBorders, in which case both fragments have borders drawn on all sides.
null value
false
true to restore the pre 6.6.0 functionality.
false.
true to revert to the pre 6.13.0 behaviour.
* stands for any class/package name or part of a class/package name, e.g.
net.sf.jasperreports.* means any class in the net.sf.jasperreports package (but not in subpackages)net.sf.jasperreports.*Enum means any class in the net.sf.jasperreports package that ends in Enum** stands for any fully qualified class name or part of a fully qualified class name, e.g.
net.sf.jasperreports.** means any class in the net.sf.jasperreports package or in a subpackagenet.sf.jasperreports.**Enum means any class that ends in Enum in the net.sf.jasperreports package or in a subpackage** means any class (note that for performance reasons instead of whitelisting all classes it's better to unset the net.sf.jasperreports.report.class.filter.enabled flag)*, which means that all parameters are to be included in classes,
or a list of comma separated parameter names.
*, which means that all fields are to be included in classes,
or a list of comma separated field names.
*, which means that all variables are to be included in classes,
or a list of comma separated variable names.
true by default.
net.sf.jasperreports.print.part are transferred.
true by default.
Setting the flag modifies the structure of the generated report with respect to
style attributes and should not be used when JasperPrint objects
are meant to undergo postprocessing related to element styles.
Enabling the property also results in altered XML exporter output and should not
be used when original XML exporter output is required.
data-eluuid attributes of td elements.
true, JasperReports creates temporary files named jr-font*
for fonts from extensions.
With this option there are cases in which the temporary files cannot be removed because Java/AWT keeps them open.
false (which is the default), Java/AWT creates and manages it own
temporary font files, usually named +~JF*.