JasperReports Ultimate Guide - Sample Reference - Schema Reference - Configuration Reference - API (Javadoc)

JasperReports - Configuration Reference (version 5.6.1)


This document lists all the configuration properties available for the JasperReports library.



Data Source / Query Executer
net.sf.jasperreports.csv.column.names.{arbitrary_name}
net.sf.jasperreports.csv.date.pattern
net.sf.jasperreports.csv.encoding
net.sf.jasperreports.csv.field.delimiter
net.sf.jasperreports.csv.locale.code
net.sf.jasperreports.csv.number.pattern
net.sf.jasperreports.csv.record.delimiter
net.sf.jasperreports.csv.source
net.sf.jasperreports.csv.timezone.id
net.sf.jasperreports.ejbql.query.hint.{hint}
net.sf.jasperreports.ejbql.query.page.size
net.sf.jasperreports.hql.clear.cache
net.sf.jasperreports.hql.field.mapping.descriptions
net.sf.jasperreports.hql.query.list.page.size
net.sf.jasperreports.hql.query.run.type
net.sf.jasperreports.jdbc.cached.rowset
net.sf.jasperreports.jdbc.concurrency
net.sf.jasperreports.jdbc.fetch.size
net.sf.jasperreports.jdbc.holdability
net.sf.jasperreports.jdbc.max.field.size
net.sf.jasperreports.jdbc.result.set.type
net.sf.jasperreports.query.chunk.token.separators
net.sf.jasperreports.query.executer.factory.{language}
net.sf.jasperreports.xls.source
net.sf.jasperreports.xml.source
net.sf.jasperreports.xpath.executer.factory

Report Compilation
net.sf.jasperreports.compiler.{language}
net.sf.jasperreports.compiler.classpath
net.sf.jasperreports.compiler.keep.java.file
net.sf.jasperreports.compiler.temp.dir
net.sf.jasperreports.compiler.xml.validation
net.sf.jasperreports.compiler.xml.parser.cache.schemas
net.sf.jasperreports.compiler.xml.parser.factory

Report Design
net.sf.jasperreports.allow.element.negative.width
net.sf.jasperreports.allow.element.negative.y
net.sf.jasperreports.allow.element.overlap
net.sf.jasperreports.style.{style_property_suffix}

Report Filling
net.sf.jasperreports.band.split.type
net.sf.jasperreports.chart.render.type
net.sf.jasperreports.chart.renderer.factory.{render_type}
net.sf.jasperreports.chart.theme
net.sf.jasperreports.default.first.line.indent
net.sf.jasperreports.default.font.name
net.sf.jasperreports.default.font.size
net.sf.jasperreports.default.left.indent
net.sf.jasperreports.default.line.spacing.size
net.sf.jasperreports.default.right.indent
net.sf.jasperreports.default.spacing.after
net.sf.jasperreports.default.spacing.before
net.sf.jasperreports.default.tab.stop.width
net.sf.jasperreports.evaluator.class.reference.fix.enabled
net.sf.jasperreports.image.encoder
net.sf.jasperreports.image.reader
net.sf.jasperreports.markup.processor.factory.{markup}
net.sf.jasperreports.page.break.no.pagination
net.sf.jasperreports.print.keep.full.text
net.sf.jasperreports.text.truncate.at.char
net.sf.jasperreports.text.truncate.suffix
net.sf.jasperreports.text.measurer.factory
net.sf.jasperreports.text.save.line.breaks
net.sf.jasperreports.style.evaluation.time.enabled
net.sf.jasperreports.subreport.runner.factory
net.sf.jasperreports.virtualizer.files.delete.on.exit
net.sf.jasperreports.virtual.page.element.size
net.sf.jasperreports.default.locale
net.sf.jasperreports.default.timezone

Governors
net.sf.jasperreports.governor.max.pages.enabled
net.sf.jasperreports.governor.max.pages
net.sf.jasperreports.governor.timeout.enabled
net.sf.jasperreports.governor.timeout

Crosstabs
net.sf.jasperreports.crosstab.bucket.measure.limit
net.sf.jasperreports.crosstab.cell.type
net.sf.jasperreports.crosstab.cell.row.span
net.sf.jasperreports.crosstab.cell.column.span
net.sf.jasperreports.crosstab.ignore.width

Map Component
net.sf.jasperreports.components.map.key
net.sf.jasperreports.components.map.version
net.sf.jasperreports.components.map.client.id
net.sf.jasperreports.components.map.signature

Table Component
net.sf.jasperreports.components.sort.up.arrow.char
net.sf.jasperreports.components.sort.down.arrow.char
net.sf.jasperreports.components.filter.char
net.sf.jasperreports.components.table.interactive
net.sf.jasperreports.components.table.column.field
net.sf.jasperreports.components.table.column.variable
net.sf.jasperreports.components.table.column.sortable
net.sf.jasperreports.components.table.column.filterable
net.sf.jasperreports.components.table.column.conditionally.formattable

Chart Themes
net.sf.jasperreports.chart.dial.value.display.visible
net.sf.jasperreports.chart.dial.label
net.sf.jasperreports.chart.domain.axis.integer.unit
net.sf.jasperreports.chart.domain.axis.tick.count
net.sf.jasperreports.chart.domain.axis.tick.interval
net.sf.jasperreports.chart.range.axis.integer.unit
net.sf.jasperreports.chart.range.axis.tick.count
net.sf.jasperreports.chart.range.axis.tick.interval

Report Export
net.sf.jasperreports.default.pdf.font.name
net.sf.jasperreports.default.pdf.encoding
net.sf.jasperreports.default.pdf.embedded
net.sf.jasperreports.export.{format}.ignore.hyperlink
net.sf.jasperreports.export.{format}.exclude.origin.{suffix}.{arbitrary_name}
net.sf.jasperreports.export.{format}.exclude.origin.keep.first.{suffix}.{arbitrary_name}
net.sf.jasperreports.export.filter.factory.{filter_element}
net.sf.jasperreports.export.default.filter.factory
net.sf.jasperreports.export.{arbitrary_name}.default.filter.factory
net.sf.jasperreports.export.character.encoding
net.sf.jasperreports.export.csv.column.name
net.sf.jasperreports.export.csv.column.names.{suffix}
net.sf.jasperreports.export.csv.data
net.sf.jasperreports.export.csv.field.delimiter
net.sf.jasperreports.export.csv.record.delimiter
net.sf.jasperreports.export.csv.repeat.value
net.sf.jasperreports.export.csv.write.header
net.sf.jasperreports.export.docx.flexible.row.height
net.sf.jasperreports.export.docx.frames.as.nested.tables
net.sf.jasperreports.export.docx.hidden.text
net.sf.jasperreports.export.flash.element.allow.script.access
net.sf.jasperreports.export.graphics2d.min.job.size
net.sf.jasperreports.export.ignore.page.margins
net.sf.jasperreports.export.html.accessible
net.sf.jasperreports.export.html.between.pages
net.sf.jasperreports.export.html.class
net.sf.jasperreports.export.html.header
net.sf.jasperreports.export.html.flush.output
net.sf.jasperreports.export.html.footer
net.sf.jasperreports.export.html.frames.as.nested.tables
net.sf.jasperreports.export.html.id
net.sf.jasperreports.export.html.remove.emtpy.space.between.rows
net.sf.jasperreports.export.html.size.unit
net.sf.jasperreports.export.html.using.images.to.align
net.sf.jasperreports.export.html.white.page.background
net.sf.jasperreports.export.html.wrap.break.word
net.sf.jasperreports.export.jxl.use.temp.file
net.sf.jasperreports.export.jxl.cell.complex.format
net.sf.jasperreports.export.ods.flexible.row.height
net.sf.jasperreports.export.odt.flexible.row.height
net.sf.jasperreports.export.parameters.override.report.hints
net.sf.jasperreports.export.pdf.128.bit.key
net.sf.jasperreports.export.pdf.collapse.missing.bookmark.levels
net.sf.jasperreports.export.pdf.compressed
net.sf.jasperreports.export.pdf.create.batch.mode.bookmarks
net.sf.jasperreports.export.pdf.display.metadata.title
net.sf.jasperreports.export.pdf.encrypted
net.sf.jasperreports.export.pdf.font.{arbitrary_name}
net.sf.jasperreports.export.pdf.fontdir.{arbitrary_name}
net.sf.jasperreports.export.pdf.force.linebreak.policy
net.sf.jasperreports.export.pdf.force.svg.shapes
net.sf.jasperreports.export.pdf.javascript
net.sf.jasperreports.export.pdf.metadata.author
net.sf.jasperreports.export.pdf.metadata.creator
net.sf.jasperreports.export.pdf.metadata.keywords
net.sf.jasperreports.export.pdf.metadata.subject
net.sf.jasperreports.export.pdf.metadata.title
net.sf.jasperreports.export.pdf.owner.password
net.sf.jasperreports.export.pdf.permissions.allowed
net.sf.jasperreports.export.pdf.permissions.denied
net.sf.jasperreports.export.pdf.print.scaling
net.sf.jasperreports.export.pdf.size.page.to.content
net.sf.jasperreports.export.pdf.tagged
net.sf.jasperreports.export.pdf.tag.table
net.sf.jasperreports.export.pdf.tag.tr
net.sf.jasperreports.export.pdf.tag.th
net.sf.jasperreports.export.pdf.tag.td
net.sf.jasperreports.export.pdf.tag.h1
net.sf.jasperreports.export.pdf.tag.h2
net.sf.jasperreports.export.pdf.tag.h3
net.sf.jasperreports.export.pdf.tag.colspan
net.sf.jasperreports.export.pdf.tag.rowspan
net.sf.jasperreports.export.pdf.tag.language
net.sf.jasperreports.export.pdf.user.password
net.sf.jasperreports.export.pdf.version
net.sf.jasperreports.export.text.character.height
net.sf.jasperreports.export.text.character.width
net.sf.jasperreports.export.text.line.separator
net.sf.jasperreports.export.text.page.height
net.sf.jasperreports.export.text.page.separator
net.sf.jasperreports.export.text.page.width
net.sf.jasperreports.export.xls.auto.filter
net.sf.jasperreports.export.xls.auto.fit.column
net.sf.jasperreports.export.xls.auto.fit.row
net.sf.jasperreports.export.xls.break.after.row
net.sf.jasperreports.export.xls.break.before.row
net.sf.jasperreports.export.xls.cell.hidden
net.sf.jasperreports.export.xls.cell.locked
net.sf.jasperreports.export.xls.collapse.row.span
net.sf.jasperreports.export.xls.column.name
net.sf.jasperreports.export.xls.column.names.{suffix}
net.sf.jasperreports.export.xls.column.width
net.sf.jasperreports.export.xls.column.width.ratio
net.sf.jasperreports.export.xls.create.custom.palette
net.sf.jasperreports.export.xls.data
net.sf.jasperreports.export.xls.detect.cell.type
net.sf.jasperreports.export.xls.fit.height
net.sf.jasperreports.export.xls.fit.width
net.sf.jasperreports.export.xls.first.page.number
net.sf.jasperreports.export.xls.font.size.fix.enabled
net.sf.jasperreports.export.xls.formula
net.sf.jasperreports.export.xls.freeze.column
net.sf.jasperreports.export.xls.freeze.column.edge
net.sf.jasperreports.export.xls.freeze.row
net.sf.jasperreports.export.xls.freeze.row.edge
net.sf.jasperreports.export.xls.ignore.anchors
net.sf.jasperreports.export.xls.ignore.cell.background
net.sf.jasperreports.export.xls.ignore.cell.border
net.sf.jasperreports.export.xls.ignore.graphics
net.sf.jasperreports.export.xls.image.anchor.type
net.sf.jasperreports.export.xls.image.border.fix.enabled
net.sf.jasperreports.export.xls.max.rows.per.sheet
net.sf.jasperreports.export.xls.one.page.per.sheet
net.sf.jasperreports.export.xls.page.scale
net.sf.jasperreports.export.xls.password
net.sf.jasperreports.export.xls.pattern
net.sf.jasperreports.export.xls.remove.empty.space.between.columns
net.sf.jasperreports.export.xls.remove.empty.space.between.rows
net.sf.jasperreports.export.xls.repeat.value
net.sf.jasperreports.export.xls.row.outline.level.{arbitrary_level}
net.sf.jasperreports.export.xls.sheet.direction
net.sf.jasperreports.export.xls.sheet.footer.center
net.sf.jasperreports.export.xls.sheet.footer.left
net.sf.jasperreports.export.xls.sheet.footer.right
net.sf.jasperreports.export.xls.sheet.header.center
net.sf.jasperreports.export.xls.sheet.header.left
net.sf.jasperreports.export.xls.sheet.header.right
net.sf.jasperreports.export.xls.sheet.name
net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name}
net.sf.jasperreports.export.xls.show.gridlines
net.sf.jasperreports.export.xls.use.timezone
net.sf.jasperreports.export.xls.white.page.background
net.sf.jasperreports.export.xls.workbook.template
net.sf.jasperreports.export.xls.workbook.template.keep.sheets
net.sf.jasperreports.export.xls.wrap.text
net.sf.jasperreports.export.xls.write.header
net.sf.jasperreports.export.xlsx.macro.template
net.sf.jasperreports.export.xml.end.page.index
net.sf.jasperreports.export.xml.page.count
net.sf.jasperreports.export.xml.parser.factory
net.sf.jasperreports.export.xml.replace.invalid.chars
net.sf.jasperreports.export.xml.start.page.index
net.sf.jasperreports.export.xml.validation

JasperReports Extensions
net.sf.jasperreports.extension.{registry_id}.{property_suffix}
net.sf.jasperreports.extension.registry.factory.{arbitrary_name}
net.sf.jasperreports.extensions.registry.class

JasperReports Repository
net.sf.jasperreports.file.repository.resolve.absolute.path
net.sf.jasperreports.file.repository.root

Other
net.sf.jasperreports.awt.check.available.printers
net.sf.jasperreports.awt.ignore.missing.font
net.sf.jasperreports.awt.superscript.fix.enabled
net.sf.jasperreports.big.decimal.minimum.precision
net.sf.jasperreports.components.{built_in_component_name}.version
net.sf.jasperreports.file.buffer.os.memory.threshold
net.sf.jasperreports.image.dpi
net.sf.jasperreports.jdk.glyph.fix.text.measurer.attempts
net.sf.jasperreports.jdk.glyph.fix.text.measurer.sleep
net.sf.jasperreports.jdk.glyph.fix.text.measurer.catch.empty.stacktrace
net.sf.jasperreports.properties
net.sf.jasperreports.report.version
net.sf.jasperreports.viewer.render.buffer.max.size






top

net.sf.jasperreports.allow.element.negative.width
A property that determines whether elements having negative width values are allowed.
If this value is set to 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.

APIPROPERTY_ALLOW_ELEMENT_NEGATIVE_WIDTH
Defaultfalse
ScopeGlobal | Report
Since3.7.1

top

net.sf.jasperreports.allow.element.negative.y
Property that determines whether elements positioned at negative Y offsets on bands, frames and other element containers are allowed in a report.
Elements placed at negative Y offsets can cause unexpected problems in grid-based exporters where they can overlap elements from previous bands/element containers.
If the property is set to false, elements in the report are verified to have positive Y offsets. Otherwise, no check is performed on element Y offsets.

APIPROPERTY_ALLOW_ELEMENT_NEGATIVE_Y
Defaulttrue
ScopeGlobal | Report | Element
Since3.7.3

top

net.sf.jasperreports.allow.element.overlap
A property that determines whether elements are allowed to overlap.
If this value is set to 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.
Additionally, when this property is set to false 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.
By default, the property is set to true which means that no element overlap checks are performed.
The property can be set at the following levels:
  • At global level (in jasperreports.properties) to provide a default value.
  • At report level, to indicate whether element overlap checks are to be performed for the report. If not set, the global property value is used.
  • At report element level to specify that the particular element is allowed to overlap or be overlapped by other elements, when the report or global property determines report element overlap verification. The element level property is only effective when set to 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.

Note that print when expressions or export filters cannot be taken into consideration while checking for overlapping elements as this check is performed at report compilation time. If a report contains two elements that overlap but have print when expressions that guarantee that only one of them will be printed, or if export filters are in place to exclude one of the elements, one of them should be explicitly marked to allow element overlap when the report is configured to check for overlaps.

APIPROPERTY_ALLOW_ELEMENT_OVERLAP
Defaulttrue
ScopeGlobal | Report
Since3.5.0

top

net.sf.jasperreports.awt.check.available.printers
Property whose value is used to check the availability of printers accepting jobs.

APIPROPERTY_CHECK_AVAILABLE_PRINTERS
Defaulttrue
ScopeGlobal | Report
Since3.7.3

top

net.sf.jasperreports.awt.ignore.missing.font
When set to 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 JRFontNotFoundException exception, if this font is not available.

APIPROPERTY_AWT_IGNORE_MISSING_FONT
Defaultfalse
ScopeGlobal | Report
Since3.6.1

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.awt.superscript.fix.enabled

APIPROPERTY_AWT_SUPERSCRIPT_FIX_ENABLED
DefaultN/A
ScopeGlobal
Since3.1.3

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.band.split.type
Specifies the default split type for bands. See the splitType attribute of the report band.

APIPROPERTY_SPLIT_TYPE
DefaultStretch
ScopeGlobal | Report
Since3.5.2

top

net.sf.jasperreports.big.decimal.minimum.precision
An integer property that provides the minimum precision to be used for java.math.BigDecimal division operations. Important note: this property is only effective when Java 1.5 or newer is used. See BigDecimalUtils for details.

APIPROPERTY_MINIMUM_PRECISION
Default16
ScopeGlobal
Since3.5.4

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.chart.dial.label
Property containing the label text attached to the measured value in a meter or thermometer chart.

APIPROPERTY_DIAL_LABEL
DefaultN/A
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.dial.value.display.visible
Property specifying whether the measured value should be rendered visible on a meter or thermometer chart's display zone.

APIPROPERTY_DIAL_VALUE_DISPLAY_VISIBLE
Defaultfalse
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.domain.axis.integer.unit
Flag property enabling the JFreeCharts engine to use integer tick units on a domain value axis. If set to true, it will take precedence over the net.sf.jasperreports.chart.domain.axis.tick.interval and net.sf.jasperreports.chart.domain.axis.tick.count properties.

APIPROPERTY_DOMAIN_AXIS_INTEGER_UNIT
DefaultN/A
ScopeElement
Since4.6.0

top

net.sf.jasperreports.chart.domain.axis.tick.count
Property specifying the number of ticks on a domain value axis. If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis.

APIPROPERTY_DOMAIN_AXIS_TICK_COUNT
DefaultN/A
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.domain.axis.tick.interval
Property specifying the interval between 2 consecutive ticks on a domain value axis. If the net.sf.jasperreports.chart.domain.axis.tick.count property is set, this interval will be neglected.
If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis.
By default it is not set.

APIPROPERTY_DOMAIN_AXIS_TICK_INTERVAL
DefaultN/A
ScopeElement
Since3.1.4

top

net.sf.jasperreports.chart.range.axis.integer.unit
Flag property enabling the JFreeCharts engine to use integer tick units on a range value axis. If set to true, it will take precedence over the net.sf.jasperreports.chart.range.axis.tick.interval and net.sf.jasperreports.chart.range.axis.tick.count properties.

APIPROPERTY_RANGE_AXIS_INTEGER_UNIT
DefaultN/A
ScopeElement
Since4.6.0

top

net.sf.jasperreports.chart.range.axis.tick.count
Property specifying the number of ticks on a range value axis. If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis.
By default it is not set.

APIPROPERTY_RANGE_AXIS_TICK_COUNT
DefaultN/A
ScopeElement
Since3.5.0

top

net.sf.jasperreports.chart.range.axis.tick.interval
Property specifying the interval between 2 consecutive ticks on a range value axis. If the net.sf.jasperreports.chart.range.axis.tick.count property is set, this interval will be neglected.
If it is not set, the JFreeCharts engine will use its own defaults to instantiate the axis.
By default it is not set.

APIPROPERTY_RANGE_AXIS_TICK_INTERVAL
DefaultN/A
ScopeElement
Since3.1.4

top

net.sf.jasperreports.chart.render.type
Specifies the default render type for charts. See the renderType attribute of the chart elements.

APIPROPERTY_CHART_RENDER_TYPE
Defaultdraw
ScopeGlobal | Report
Since2.0.5

top

net.sf.jasperreports.chart.renderer.factory.{render_type}
Prefix for properties that map chart renderers.
Properties having this prefix indicate the JRRenderable implementation to be used when rendering a chart element having a rendering type specified in the property suffix.

APIPROPERTY_CHART_RENDER_TYPE
DefaultN/A
ScopeGlobal
Since2.0.5

top

net.sf.jasperreports.chart.theme
Property used to specify the chart theme name.

APIPROPERTY_CHART_THEME
Defaultdefault
ScopeGlobal | Report
Since3.1.0

top

net.sf.jasperreports.compiler.{language}
Prefix for properties that map report compilers to expression languages.
Properties having this prefix indicate the JRCompiler implementation to be used when compiling report designs that rely on the expression language specified as property suffix.

APICOMPILER_PREFIX
Defaultnet.sf.jasperreports.engine.design.JRJdtCompiler, if available; net.sf.jasperreports.engine.design.JRJdk13Compiler otherwise. Java is considered the default expression language.
ScopeGlobal
Since2.0.1

top

net.sf.jasperreports.compiler.classpath
Property specifying the classpath used by the report compiler during the compilation process.

APICOMPILER_CLASSPATH
DefaultSystem.getProperty("java.class.path")
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.compiler.keep.java.file
Property specifying whether the temporary source file created by the report compiler should be kept or deleted after the report compilation process ended.

APICOMPILER_KEEP_JAVA_FILE
Defaultfalse
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.compiler.temp.dir
Property specifying the temporary working directory to be used by the report compiler.

APICOMPILER_TEMP_DIR
DefaultSystem.getProperty("user.dir")
ScopeGlobal
Since1.0.0

top

net.sf.jasperreports.compiler.xml.parser.cache.schemas
Property that determines whether XML schemas/grammars are to be cached so that they are not read/initialized each time a report is compiled.
Currently, setting this property is only effective when a Xerces XML parser is used (either a stock one from Apache or one embedded into a SUN JDK).

APIPROPERTY_CACHE_SCHEMAS
Defaulttrue
ScopeGlobal
Since3.1.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.compiler.xml.parser.factory
Property that gives a parser factory class which should be used for parsing JRXMLs.
By default, this property is set to use JRReportSaxParserFactory as report parser factory.

APIPROPERTY_REPORT_PARSER_FACTORY
Defaultnet.sf.jasperreports.engine.xml.JRReportSaxParserFactory
ScopeGlobal
Since3.1.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.compiler.xml.validation
Property that forces the XML validation of the report template file before compiling.

APICOMPILER_XML_VALIDATION
Defaulttrue
ScopeGlobal
Since1.0.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.components.{built_in_component_name}.version
Properties having this prefix specify the version for the associated built-in component in a given report. Built-in components are those who are shipped as part of the JasperReports Library JAR.
For instance, for the table component shipped with JR distribution, the version is given with a property as follows:

<property name="net.sf.jasperreports.components.table.version" value="4.0.0" />

If not specified, the component version is considered to be the one specified by the net.sf.jasperreports.report.version.

APIPROPERTY_COMPONENT_VERSION_PREFIX
DefaultN/A
ScopeGlobal | Report | Element
Since4.8.0

top

net.sf.jasperreports.components.filter.char
Property that specifies the character to be used on the column header when the tables's column has a filtered applied

APIPROPERTY_FILTER_CHAR
Default\u2606
ScopeGlobal
Since4.6.0

top

net.sf.jasperreports.components.map.client.id
Property that specifies the client ID for Google Maps API for Business. If set, it takes precedence over the API key property.
Usually works along with the signature property for signed URLs.

APIPROPERTY_CLIENT_ID
DefaultN/A
ScopeGlobal | Report
Since5.3

top

net.sf.jasperreports.components.map.key
Property that specifies the Google Maps API key. Using an API key enables additional features:
  • better Maps APIs usage monitoring in your application
  • purchasing additional quota if the usage limits are exceeded
  • allows Google contact you about your application, if necessary
Note: The API key must not be included in Google Maps API for Business requests. Business customers should send their client ID instead.

APIPROPERTY_KEY
DefaultN/A
ScopeGlobal | Report
Since5.3

top

net.sf.jasperreports.components.map.signature
Property that specifies the encrypted client signature for signed request URLs. For complete information see the official Authentication and Authorization documentation for Maps Image APIs and Web Services APIs.

APIPROPERTY_SIGNATURE
DefaultN/A
ScopeGlobal | Report
Since5.3

top

net.sf.jasperreports.components.map.version
Property that indicates which version of the Google Maps API to be loaded. The version property may be set as:
  • experimental version - specified by including the .exp suffix: <property name="net.sf.jasperreports.components.map.version" value="3.exp">
  • release version - specified either with the release major number (<property name="net.sf.jasperreports.components.map.version" value="3">) or with the release version number (<property name="net.sf.jasperreports.components.map.version" value="3.12">)
  • numbered version - specified with the version number (<property name="net.sf.jasperreports.components.map.version" value="3.11">)
If not specified, the experimental version is loaded by default.

APIPROPERTY_VERSION
DefaultN/A
ScopeGlobal | Report
Since5.3

top

net.sf.jasperreports.components.sort.down.arrow.char
Property that specifies the character to be used on the column header when the tables's column is sorted descending

APIPROPERTY_DOWN_ARROW_CHAR
Default\u25BC
ScopeGlobal
Since4.6.0

top

net.sf.jasperreports.components.sort.up.arrow.char
Property that specifies the character to be used on the column header when the tables's column is sorted ascending

APIPROPERTY_UP_ARROW_CHAR
Default\u25B2
ScopeGlobal
Since4.6.0

top

net.sf.jasperreports.components.table.column.conditionally.formattable
Property that enables/disables conditional formatting

APIPROPERTY_COLUMN_CONDITIONALLY_FORMATTABLE
Defaulttrue
ScopeColumn
Since5.0.1

top

net.sf.jasperreports.components.table.column.field
Property that specifies the field to be used for sorting and/or filtering

APIPROPERTY_COLUMN_FIELD
DefaultN/A
ScopeColumn
Since5.0.1

top

net.sf.jasperreports.components.table.column.filterable
Property that enables/disables filtering

APIPROPERTY_COLUMN_FILTERABLE
Defaulttrue
ScopeColumn
Since5.0.1

top

net.sf.jasperreports.components.table.column.sortable
Property that enables/disables sorting

APIPROPERTY_COLUMN_SORTABLE
Defaulttrue
ScopeColumn
Since5.0.1

top

net.sf.jasperreports.components.table.column.variable
Property that specifies the variable to be used for sorting and/or filtering

APIPROPERTY_COLUMN_VARIABLE
DefaultN/A
ScopeColumn
Since5.0.1

top

net.sf.jasperreports.components.table.interactive
Property that enables/disables the interactivity in the table component

APIPROPERTY_INTERACTIVE_TABLE
Defaulttrue
ScopeGlobal | Report | Component | Column
Since4.7.1

top

net.sf.jasperreports.crosstab.bucket.measure.limit
Property that limits the number of buckets in a crosstab, to avoid out of memory errors.

APIPROPERTY_BUCKET_MEASURE_LIMIT
Default0
ScopeGlobal
Since1.3.4

top

net.sf.jasperreports.crosstab.cell.column.span
Property that provides the crosstab column span of a print frame. (FIXME not a user defined property)

APIPROPERTY_COLUMN_SPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.crosstab.cell.row.span
Property that provides the crosstab row span of a print frame. (FIXME not a user defined property)

APIPROPERTY_ROW_SPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.crosstab.cell.type
Property that provides the type of the cell that generated a print frame. (FIXME not a user defined property)
The property value is one of

APIPROPERTY_TYPE
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.crosstab.ignore.width
Property that provides the default value for the crosstab ignoreWidth attribute.

APIPROPERTY_IGNORE_WIDTH
Defaultfalse
ScopeGlobal | Report
Since3.5.3

top

net.sf.jasperreports.csv.column.names.{arbitrary_name}
Property having this prefix hold the comma separated names of the columns to be extracted from the CSV source.

APICSV_COLUMN_NAMES
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.date.pattern
Property holding the value of the date format pattern to be used when parsing the CSV data.

APICSV_DATE_PATTERN
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.encoding

APICSV_ENCODING
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.field.delimiter

APICSV_FIELD_DELIMITER
Default,
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.locale.code

APICSV_LOCALE_CODE
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.number.pattern
Property holding the value of the number format pattern to be used when parsing the CSV data.

APICSV_NUMBER_PATTERN
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.record.delimiter

APICSV_RECORD_DELIMITER
Default\n
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.source

APICSV_SOURCE
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.csv.timezone.id

APICSV_TIMEZONE_ID
DefaultN/A
ScopeGlobal | Dataset
Since4.0.0

top

net.sf.jasperreports.default.first.line.indent
Specifies the default value (in pixels) for the first line indent, if no explicit information is provided in a JR paragraph.
By default the first line in JR paragraphs has no indentation.

APIDEFAULT_FIRST_LINE_INDENT
Default0
ScopeGlobal
Since4.0.2

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.font.name
Specifies the default font name when no default font is explicitly given in a report.

APIDEFAULT_FONT_NAME
DefaultSansSerif
ScopeGlobal
Since1.3.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.font.size
Specifies the default font size when no default font size is explicitly given in a report.

APIDEFAULT_FONT_SIZE
Default10
ScopeGlobal
Since1.3.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.left.indent
Specifies the default value (in pixels) for the left indent, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no left indentation.

APIDEFAULT_LEFT_INDENT
Default0
ScopeGlobal
Since4.0.2

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.line.spacing.size
Specifies the default value for the text line spacing size, if no explicit information is provided in a JR paragraph.
This value is used in combination with the size-dependent line spacings in LineSpacingEnum:

APIDEFAULT_LINE_SPACING_SIZE
Default1
ScopeGlobal
Since4.0.2

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.locale
The default locale used to fill reports. The property is overridden by the REPORT_LOCALE parameter value.

APIPROPERTY_DEFAULT_LOCALE
Defaultsystem locale
ScopeGlobal | Report
Since5.2.0

top

net.sf.jasperreports.default.pdf.embedded
Property indicating the default PDF font embedding behavior, if not specified in the report template or at export time.

APIDEFAULT_PDF_EMBEDDED
Defaultfalse
ScopeGlobal
Since1.3.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.pdf.encoding
Property indicating the default PDF encoding, if not specified in the report template or at export time.

APIDEFAULT_PDF_ENCODING
DefaultCp1252
ScopeGlobal
Since1.3.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.pdf.font.name
Property indicating the default PDF font, if not specified in the report template or at export time.

APIDEFAULT_PDF_FONT_NAME
DefaultHelvetica
ScopeGlobal
Since1.3.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.right.indent
Specifies the default value (in pixels) for the right indent, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no right indentation.

APIDEFAULT_RIGHT_INDENT
Default0
ScopeGlobal
Since4.0.2

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.spacing.after
Specifies the default value (in pixels) for the spacing after lines, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no spacing after lines.

APIDEFAULT_SPACING_AFTER
Default0
ScopeGlobal
Since4.0.2

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.spacing.before
Specifies the default value (in pixels) for the spacing before lines, if no explicit information is provided in a JR paragraph.
By default JR paragraphs provide no spacing before lines.

APIDEFAULT_SPACING_BEFORE
Default0
ScopeGlobal
Since4.0.2

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.tab.stop.width
Specifies the default value (in pixels) for the tab stop width, if no explicit information is provided in a paragraph.
By default JR paragraphs provide 40 pixels wide tab stops.

APIDEFAULT_TAB_STOP_WIDTH
Default40
ScopeGlobal
Since4.0.2

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.default.timezone
The default time zone used to fill reports. The property is overridden by the REPORT_TIME_ZONE parameter value.

APIPROPERTY_DEFAULT_TIMEZONE
Defaultsystem time zone
ScopeGlobal | Report
Since5.2.0

top

net.sf.jasperreports.ejbql.query.hint.{hint}
Properties with this prefix introduce JPA implementation specific EJBQL query hints to be used by the JRJpaQueryExecuter. The suffix is the name of the hint, as documented by the specific JPA implementation.

APIPROPERTY_JPA_QUERY_HINT_PREFIX
DefaultN/A
ScopeDataset
Since1.2.3

top

net.sf.jasperreports.ejbql.query.page.size
Property specifying the number of result rows to be retrieved at once. Result pagination is implemented by javax.persistence.Query.setFirstResult() and javax.persistence.Query.setMaxResults().
By default, all the rows are retrieved (no result pagination is performed).

APIPROPERTY_JPA_QUERY_PAGE_SIZE
Default0
ScopeGlobal | Dataset
Since1.2.3

top

net.sf.jasperreports.evaluator.class.reference.fix.enabled
Property that indicates whether a legacy fix for a JVM issue related to evaluator classes generated by JasperReports is enabled. The fix is enabled by default.
Due to the fix, the garbage collector might not be able to collect a classloader that loaded JasperReports classes. This would be inconvenient in scenarios in which JasperReports classes are repeatedly loaded by different classloaders, e.g. when JasperReports is part of the classpath of a web application which is often reloaded. In such scenarios, set this property to false.

APIPROPERTY_EVALUATOR_CLASS_REFERENCE_FIX_ENABLED
Defaulttrue
ScopeGlobal
Since3.0.0

top

net.sf.jasperreports.export.{arbitrary_name}.default.filter.factory
Property that gives the default filter factory for a specific exporter. Contains the property prefix net.sf.jasperreports.export. concatenated with an arbitrary name indicating the exporter type and the property suffix default.filter.factory.
For instance, the default filter factory for XLS exporters is net.sf.jasperreports.export.xls.default.filter.factory. If this property is not defined for a specific exporter, the generic exporter factory given by PROPERTY_DEFAULT_FILTER_FACTORY is used.

APIPROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY
DefaultPROPERTY_DEFAULT_FILTER_FACTORY 's default value.
ScopeGlobal
Since3.0.1

top

net.sf.jasperreports.export.{format}.exclude.origin.{suffix}.{arbitrary_name}
Properties with this syntax are used by the exporters to create default exporter filter instances that filter out content based on element origin information. Possible values for the {format} token are pdf, html, xls, rtf, odt, csv and txt. The {suffix} token can be band, group or report.
See this FAQ for more details about filtering out content while exporting.

APIN/A
DefaultN/A
ScopeGlobal | Report
Since

top

net.sf.jasperreports.export.{format}.exclude.origin.keep.first.{suffix}.{arbitrary_name}
Properties with this syntax are used by the exporters to create default exporter filter instances that filter out content based on element origin information. Possible values for the {format} token are pdf, html, xls, rtf, odt, csv and txt. The {suffix} token can be band, group or report.
See this FAQ for more details about filtering out content while exporting.

APIN/A
DefaultN/A
ScopeGlobal | Report
Since

top

net.sf.jasperreports.export.{format}.ignore.hyperlink
Properties with this syntax are used by the exporters to determine if a certain hyperlink should be activated or not. These flags can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name.

APIN/A
DefaultN/A
ScopeGlobal | Report | Hyperlink
Since

top

net.sf.jasperreports.export.character.encoding
Property whose value is used as as default for the getEncoding() export output setting. Stores the character encoding for exported reports.

APIPROPERTY_CHARACTER_ENCODING
DefaultUTF-8
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.csv.column.name
Property specifying the name of the CSV exported column the element belongs to. It must be one of the column names in the net.sf.jasperreports.export.csv.column.names.{suffix}, if provided.

APIPROPERTY_COLUMN_NAME
DefaultN/A
ScopeElement
Since4.0.0

top

net.sf.jasperreports.export.csv.column.names.{suffix}
Properties having this prefix contain comma-separated names of the columns that will be exported to CSV.
Column names in this property are used as default list for the getColumnNames() CSV metadata export output setting.

APIPROPERTY_COLUMN_NAMES_PREFIX
DefaultN/A
ScopeReport
Since4.0.0

top

net.sf.jasperreports.export.csv.data
Property that specifies a custom value to be associated with the column specified by the PROPERTY_COLUMN_NAME.
The property itself defaults to the text value of the report element this property is assigned to.

APIPROPERTY_DATA
DefaultN/A
ScopeElement
Since4.0.0

top

net.sf.jasperreports.export.csv.field.delimiter
Property that contains the character or sequence of characters used to delimit two fields on the same record. Its value is used as default for the getFieldDelimiter() CSV export configuration setting.

APIPROPERTY_FIELD_DELIMITER
Default,
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.csv.record.delimiter
Property that contains the character or sequence of characters used to delimit two records.
Its value is used as default for the getRecordDelimiter() CSV export configuration setting.

APIPROPERTY_RECORD_DELIMITER
Default\n
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.csv.repeat.value
Property that specifies whether the value associated with PROPERTY_COLUMN_NAME should be repeated or not when it is missing.

APIPROPERTY_REPEAT_VALUE
Defaultfalse
ScopeElement
Since4.0.0

top

net.sf.jasperreports.export.csv.write.header
Property that specifies whether the export header (the column names) should be written or not.
Its value is used as default for the isWriteHeader() CSV metadata export configuration setting.

APIPROPERTY_WRITE_HEADER
Defaultfalse
ScopeGlobal | Report
Since4.0.0

top

net.sf.jasperreports.export.default.filter.factory
A property that gives the generic default filter factory class name.

APIPROPERTY_DEFAULT_FILTER_FACTORY
Defaultnet.sf.jasperreports.engine.export.DefaultExporterFilterFactory
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.docx.flexible.row.height
This property indicates whether table rows can grow if more text is added into cells.
Its value is used as default for the isFlexibleRowHeight() DOCX export configuration setting.
If set to false, the table rows do not increase in height automatically and the user has to enlarge them manually.

APIPROPERTY_FLEXIBLE_ROW_HEIGHT
Defaultfalse
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.docx.frames.as.nested.tables
This property specifies whether JRPrintFrame frames are to be exported as nested tables.
Its value is used as default for the isFramesAsNestedTables() DOCX export configuration setting.
If set to false, the frame content will be integrated into the master/page table.

APIPROPERTY_FRAMES_AS_NESTED_TABLES
Defaulttrue
ScopeGlobal | Report | Element
Since3.5.3

top

net.sf.jasperreports.export.docx.hidden.text
This property is used to mark text elements as being hidden either for printing or on-screen display.

APIPROPERTY_HIDDEN_TEXT
Defaultfalse
ScopeElement
Since3.7.6

top

net.sf.jasperreports.export.filter.factory.{filter_element}
A set of properties that are used to register filter factories. They all contain the fixed prefix net.sf.jasperreports.export.filter.factory. and a suffix indicating the considered filter element.
For example: net.sf.jasperreports.export.filter.factory.origin indicates an element origin filter factory.

APIPROPERTY_EXPORTER_FILTER_FACTORY_PREFIX
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.flash.element.allow.script.access
Property that determines the value of the allowScriptAccess parameter for Flash elements.

APIPROPERTY_ALLOW_SCRIPT_ACCESS
DefaultsameDomain
ScopeGlobal | Report | Element
Since4.1.3

top

net.sf.jasperreports.export.graphics2d.min.job.size
Flag property that controls the use of an AWT rendering fix which causes the printer job size to be reduced when the exporter draws onto a printer graphic context.
Its value is used as default for the isMinimizePrinterJobSize() Graphics2D export configuration setting.

APIMINIMIZE_PRINTER_JOB_SIZE
Defaulttrue
ScopeGlobal | Report
Since1.2.8

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.export.html.accessible
Configuration property that determines the exporter to produce accessible HTML.
Its value is used as default for the isAccessibleHtml() HTML export configuration setting.

APIPROPERTY_ACCESSIBLE
Defaultfalse
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.html.between.pages
Configuration property that provides the HTML code that will be inserted between pages of the generated report.
Its value is used as default for the getBetweenPagesHtml() HTML export configuration setting.

APIPROPERTY_BETWEEN_PAGES_HTML
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.html.class
Property used to specify the value of the CSS class attribute of elements when exported to HTML and XHTML formats. 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 and/or the class attribute of the <span> or <div> tag for the element, when exported to XHTML/CSS.

APIPROPERTY_HTML_CLASS
DefaultN/A
ScopeElement
Since4.0.1

top

net.sf.jasperreports.export.html.flush.output
A boolean property that determines whether the HTML exporter should flush the output stream after writing the HTML content to it.

APIPROPERTY_FLUSH_OUTPUT
Defaulttrue
ScopeGlobal | Report
Since3.7.1

top

net.sf.jasperreports.export.html.footer
Configuration property that provides the HTML code that will be inserted after the generated report content.
Its value is used as default for the getHtmlFooter() HTML export configuration setting.

APIPROPERTY_HTML_FOOTER
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.html.frames.as.nested.tables
This property specifies whether JRPrintFrame frames are to be exported as nested HTML tables.
Its value is used as default for the isFramesAsNestedTables() HTML export configuration setting.
If set to false, the frame content will be integrated into the master/page HTML table.

APIPROPERTY_FRAMES_AS_NESTED_TABLES
Defaulttrue
ScopeGlobal | Report | Element
Since2.0.1

top

net.sf.jasperreports.export.html.header
Configuration property that provides the HTML code that will be inserted before the generated report content.
Its value is used as default for the getHtmlHeader() HTML export configuration setting.

APIPROPERTY_HTML_HEADER
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.html.id
Property used to specify the value of the ID attribute of elements when exported to HTML and XHTML formats. 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 and/or the id attribute of the <span> or <div> tag for the element, when exported to XHTML/CSS.

APIPROPERTY_HTML_ID
DefaultN/A
ScopeElement
Since3.7.0

top

net.sf.jasperreports.export.html.remove.emtpy.space.between.rows
Flag property that specifies whether the blank lines that sometimes appear between rows as spacers should be removed.
Its value is used as default for the isRemoveEmptySpaceBetweenRows() HTML export configuration setting.

APIPROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.size.unit
Property that specifies the unit to use when measuring lengths or font size. This can be one of the supported size units from the CSS specifications like "px" for pixels or "pt" for points. The default value is "px", meaning that lengths and font sizes are specified in pixels.
Its value is used as default for the getSizeUnit() HTML export configuration setting.

APIPROPERTY_SIZE_UNIT
Defaultpx
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.using.images.to.align
Property that specifies whether the export engine should use small transparent spacer images for aligning content.

APIPROPERTY_USING_IMAGES_TO_ALIGN
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.white.page.background
Property that indicates whether the report background should be turned to white. If not set, the default background will appear, depending on the selected CSS styles.
Its value is used as default for the isWhitePageBackground() HTML export configuration setting.

APIPROPERTY_WHITE_PAGE_BACKGROUND
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.html.wrap.break.word
Property that specifies whether the export engine should force text wrapping by breaking words (CSS word-wrap: break-word).
Its value is used as default for the isWrapBreakWord() HTML export configuration setting.
Note that this CSS property is not currently supported by all browsers. An alternative approach for forcing word breaks in HTML is to save the line breaks at fill time via the net.sf.jasperreports.text.save.line.breaks property.

APIPROPERTY_WRAP_BREAK_WORD
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.ignore.page.margins
This flag property specifies whether page margins should be ignored when the report is exported using a grid-based exporter.
Its value is used as default for the Excel and HTML isIgnorePageMargins() export configuration setting.
If the property is true, any page in the document will be exported without taking into account its margins.

APIPROPERTY_IGNORE_PAGE_MARGINS
Defaultfalse
ScopeGlobal | Report
Since2.0.5

top

net.sf.jasperreports.export.jxl.cell.complex.format
Boolean property specifying whether the cell format pattern is user-defined. When set to true, the exporter will assume that the specified pattern is well defined. If the pattern is invalid, it won't be taken into account by the Excel file viewer.

APIPROPERTY_COMPLEX_FORMAT
Defaultfalse
ScopeGlobal | Report | Element
Since3.7.6

top

net.sf.jasperreports.export.jxl.use.temp.file
Boolean property enabling the JExcelApiExporter to use temporary files when creating large documents.

APIPROPERTY_USE_TEMP_FILE
Defaultfalse
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.ods.flexible.row.height
This property indicates whether table rows in ODS documents can grow if more text is added into cells.
Its value is used as default for the isFlexibleRowHeight() ODS export configuration setting.
If set to 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.

APIPROPERTY_ODS_FLEXIBLE_ROW_HEIGHT
Defaultfalse
ScopeGlobal | Report
Since5.0.4

top

net.sf.jasperreports.export.odt.flexible.row.height
This property table rows in ODT documents can grow if more text is added into cells.
Its value is used as default for the isFlexibleRowHeight() ODT export configuration setting.
If set to 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.

APIPROPERTY_ODT_FLEXIBLE_ROW_HEIGHT
Defaultfalse
ScopeGlobal | Report
Since5.0.4

top

net.sf.jasperreports.export.parameters.override.report.hints
Property that establishes the priority of export parameters against report hints.
Its value is used as default for the isOverrideHints() export configuration setting.
If the property is true, export parameters override report hints; this is the default behavior.

APIPROPERTY_EXPORT_PARAMETERS_OVERRIDE_REPORT_HINTS
Defaulttrue
ScopeGlobal
Since

top

net.sf.jasperreports.export.pdf.128.bit.key
Property that specifies whether the encryption key is 128 bits.
Its value is used as default for the is128BitKey() PDF export configuration setting.

APIPROPERTY_128_BIT_KEY
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.collapse.missing.bookmark.levels
Property that determines if missing bookmark levels are collapsed, or if empty bookmarks are created for the missing levels.

The property dictates what happens when a filled report contains an anchor having a bookmark level that is not the immediate successor of its parent (e.g. an anchor with bookmark level 3 follows immediately after a bookmark of level 1). If the property is not set, an empty bookmark is created for the missing level(s) in order to preserve the original level of the bookmark. When the property is set, the level of the bookmark will be collapsed and the bookmark will be created as a direct descendant of its nearest parent.


APIPROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS
Defaultfalse
ScopeGlobal | Report
Since3.7.3

top

net.sf.jasperreports.export.pdf.compressed
Property that specifies whether the PDF document should be compressed.
Its value is used as default for the isCompressed() PDF export configuration setting.

APIPROPERTY_COMPRESSED
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.create.batch.mode.bookmarks
Property that specifies whether the PDF document should contain an outline section.
Its value is used as default for the isCreatingBatchModeBookmarks() PDF export configuration setting.

APIPROPERTY_CREATE_BATCH_MODE_BOOKMARKS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.display.metadata.title
Property that specifies whether the document title should be displayed in the title bar instead of the file name. Should be set to true for accessible documents that provide a document title.
Its value is used as default for the isDisplayMetadataTitle() PDF export configuration setting.

APIPROPERTY_DISPLAY_METADATA_TITLE
Defaultfalse
ScopeGlobal | Report
Since5.6.2

top

net.sf.jasperreports.export.pdf.encrypted
Property that specifies whether the final PDF document should be encrypted.
Its value is used as default for the isEncrypted() PDF export configuration setting.

APIPROPERTY_ENCRYPTED
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.font.{arbitrary_name}
Prefix of properties that specify font files for the PDF exporter.

APIPDF_FONT_FILES_PREFIX
DefaultN/A
ScopeGlobal
Since1.0.0

NOTE: By default, properties with this prefix are not read from the report context. This FAQ shows the additional steps to follow in order to set them on and get them from the report context.

top

net.sf.jasperreports.export.pdf.fontdir.{arbitrary_name}
Prefix of properties that specify font directories for the PDF exporter.

APIPDF_FONT_DIRS_PREFIX
DefaultN/A
ScopeGlobal
Since1.0.0

NOTE: By default, properties with this prefix are not read from the report context. This FAQ shows the additional steps to follow in order to set them on and get them from the report context.

top

net.sf.jasperreports.export.pdf.force.linebreak.policy
Property that specifies whether the PDF exporter should use a SplitCharacter implementation to ensure that PDF text wrap behavior is the same as in AWT.
Its value is used as default for the isForceLineBreakPolicy() PDF export configuration setting.

APIPROPERTY_FORCE_LINEBREAK_POLICY
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.force.svg.shapes
Property that specifies whether the rendering of SVG images using shapes on the PDF Graphics2D context should be forced.
Its value is used as default for the isForceSvgShapes() PDF export configuration setting.

APIPROPERTY_FORCE_SVG_SHAPES
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.javascript
Property that contains the user defined JavaScript piece of code to be inserted into the generated PDF document.
Its value is used as default for the getPdfJavaScript() PDF export configuration setting.

APIPROPERTY_PDF_JAVASCRIPT
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.metadata.author
Property that contains the author information to use for the generated PDF metadata.
Its value is used as default for the getMetadataAutor() PDF export configuration setting.

APIPROPERTY_METADATA_AUTHOR
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.pdf.metadata.creator
Property that contains the creator information to use for the generated PDF metadata.
Its value is used as default for the getMetadataCreator() PDF export configuration setting.

APIPROPERTY_METADATA_CREATOR
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.pdf.metadata.keywords
Property that contains the keywords to use for the generated PDF metadata.
Its value is used as default for the getMetadataKeywords() PDF export configuration setting.

APIPROPERTY_METADATA_KEYWORDS
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.pdf.metadata.subject
Property that contains the subject information to use for the generated PDF metadata.
Its value is used as default for the getMetadataSubject() PDF export configuration setting.

APIPROPERTY_METADATA_SUBJECT
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.pdf.metadata.title
Property that contains the title information to use for the generated PDF metadata.
Its value is used as default for the getMetadataTitle() PDF export configuration setting.

APIPROPERTY_METADATA_TITLE
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.pdf.owner.password
Property that contains the password belonging to the owner of the document, if it is encrypted. If the owner password is not specified, but the PDF is encrypted, then the password will be a random string.
Its value is used as default for the getOwnerPassword() PDF export configuration setting.

APIPROPERTY_OWNER_PASSWORD
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.permissions.allowed
Property that contains the allowed user permissions of the PDF document, if it is encrypted. Allowed values are one or many the permission names enumerated in PdfPermissionsEnum class, separated by a pipe (|) sign:
  • ALL - all user permissions are allowed
  • ASSEMBLY - assembly permission allowed
  • COPY - copy permission allowed
  • DEGRADED_PRINTING - degraded printing permission allowed
  • FILL_IN - fill in forms permission allowed
  • MODIFY_ANNOTATIONS - modify annotation permission allowed
  • MODIFY_CONTENTS - modify contents permission allowed
  • PRINTING - print permission allowed
  • SCREENREADERS - screen readers permission allowed

Its value is used as default for the getAllowedPermissionsHint() PDF export configuration setting. By default no user permissions are allowed at all.

APIPROPERTY_PERMISSIONS_ALLOWED
DefaultN/A
ScopeGlobal | Report
Since5.6.0

top

net.sf.jasperreports.export.pdf.permissions.denied
Property that contains the denied user permissions of the PDF document, if it is encrypted. This property works in conjunction with the net.sf.jasperreports.export.pdf.permissions.allowed. If present, denied permissions will be excluded from the allowed values. This property may contain one or many permission names enumerated in PdfPermissionsEnum class, separated by a pipe (|) sign:
  • ALL - all user permissions are denied
  • ASSEMBLY - assembly permission denied
  • COPY - copy permission denied
  • DEGRADED_PRINTING - degraded printing permission denied
  • FILL_IN - fill in forms permission denied
  • MODIFY_ANNOTATIONS - modify annotation permission denied
  • MODIFY_CONTENTS - modify contents permission denied
  • PRINTING - print permission denied
  • SCREENREADERS - screen readers permission denied

Its value is used as default for the getDeniedPermissionsHint() PDF export configuration setting. By default there are no user permissions allowed for the document.

APIPROPERTY_PERMISSIONS_DENIED
DefaultN/A
ScopeGlobal | Report
Since5.6.0

top

net.sf.jasperreports.export.pdf.print.scaling
Property that specifies the print scaling preference in the PDF print dialog.
Its value is used as default for the getPrintScaling() PDF export configuration setting.
Possible values are default and none.

APIPRINT_SCALING
Defaultdefault
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.pdf.size.page.to.content
Property which specifies if the size of each page should be increased to accommodate its content.

APIPROPERTY_SIZE_PAGE_TO_CONTENT
Defaultfalse
ScopeGlobal | Report
Since4.7.0

top

net.sf.jasperreports.export.pdf.tag.colspan

APIPROPERTY_TAG_COLSPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.h1

APIPROPERTY_TAG_H1
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.h2

APIPROPERTY_TAG_H2
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.h3

APIPROPERTY_TAG_H3
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.language
Property that specifies the language that the exporter should put in the language tag of the generated PDF.
Its value is used as default for the getTagLanguage() PDF export configuration setting.

APIPROPERTY_TAG_LANGUAGE
DefaultN/A
ScopeGlobal | Report
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.rowspan

APIPROPERTY_TAG_ROWSPAN
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.table

APIPROPERTY_TAG_TABLE
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.td

APIPROPERTY_TAG_TD
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.th

APIPROPERTY_TAG_TH
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tag.tr

APIPROPERTY_TAG_TR
DefaultN/A
ScopeElement
Since3.1.2

top

net.sf.jasperreports.export.pdf.tagged
Property that specifies whether the exporter should put structure tags in the generated PDF.
Its value is used as default for the isTagged() PDF export configuration setting.

APIPROPERTY_PDF_TAGGED
Defaultfalse
ScopeGlobal | Report
Since3.1.2

top

net.sf.jasperreports.export.pdf.user.password
Property that contains the user password needed to open the document, if it is encrypted.
Its value is used as default for the getUserPassword() PDF export configuration setting.

APIPROPERTY_USER_PASSWORD
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.pdf.version
Property that contains a Character instance representing the version of the generated PDF.
Its value is used as default for the getPdfVersion() PDF export configuration setting.

APIPROPERTY_PDF_VERSION
DefaultN/A
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.text.character.height
Property whose floating point value is representing the pixel/character vertical ratio.
Its value is used as default for the getCharHeight() Text export configuration setting.

APIPROPERTY_CHARACTER_HEIGHT
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.text.character.width
Property whose floating point value is representing the pixel/character horizontal ratio.
Its value is used as default for the getCharWidth() Text export configuration setting.

APIPROPERTY_CHARACTER_WIDTH
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.text.line.separator
Property whose value represents the separator between two lines of text in the exported report.
Its value is used as default for the getLineSeparator() Text export configuration setting.

APIPROPERTY_LINE_SEPARATOR
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.text.page.height
Property whose integer value representing the page height in characters.
Its value is used as default for the getPageHeightInChars() Text export configuration setting.

APIPROPERTY_PAGE_HEIGHT
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.text.page.separator
Property whose value represents text that will be inserted between pages of the generated report.
Its value is used as default for the getPageSeparator() Text export configuration setting.

APIPROPERTY_PAGE_SEPARATOR
DefaultN/A
ScopeGlobal | Report
Since5.5.2

top

net.sf.jasperreports.export.text.page.width
Property whose integer value is representing the page width in characters.
Its value is used as default for the getPageWidthInChars() Text export configuration setting.

APIPROPERTY_PAGE_WIDTH
DefaultN/A
ScopeGlobal | Report
Since3.6.1

top

net.sf.jasperreports.export.xls.auto.filter
This element-level property is used to indicate the boundaries of the autofilter data range in the current sheet. Allowed values are:
  • 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").
    If multiple autofilter 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.
    If the autofilter 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.
    Caution: If no autofilter Start value is found in the sheet, the autofilter End value will be considered as Start value instead.
    If multiple autofilter End values are found in the same sheet, only the last one will be considered.
    If the autofilter 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.

APIPROPERTY_AUTO_FILTER
DefaultN/A
ScopeElement
Since4.1.3

top

net.sf.jasperreports.export.xls.auto.fit.column
Flag property that indicates whether Excel should autofit the current column width.
Allowed values are:
  • true
  • false

APIPROPERTY_AUTO_FIT_COLUMN
Defaultfalse
ScopeElement
Since4.5.1

top

net.sf.jasperreports.export.xls.auto.fit.row
Flag property that indicates whether Excel should autofit the current row height.
Allowed values are:
  • true
  • false

APIPROPERTY_AUTO_FIT_ROW
Defaultfalse
ScopeElement
Since4.5.1

top

net.sf.jasperreports.export.xls.break.after.row
Custom element property specifying if a sheet will break after the row displaying that element. It is very useful especially when displaying each report's group on a separate sheet is intended.

APIPROPERTY_BREAK_AFTER_ROW
Defaultfalse
ScopeElement
Since3.0.0

top

net.sf.jasperreports.export.xls.break.before.row
Custom element property specifying if a sheet will break before the row displaying that element. It is very useful especially when displaying each report's group on a separate sheet is intended.

APIPROPERTY_BREAK_BEFORE_ROW
Defaultfalse
ScopeElement
Since3.0.0

top

net.sf.jasperreports.export.xls.cell.hidden
Property that specifies if the cell content is hidden or exposed in the formula bar of a protected sheet.
Its value is used as default for the isCellHidden() Excel export configuration setting.
By default the property is not set (false), and the cell content is not hidden.
This property has effect only if the enclosing sheet is protected.

APIPROPERTY_CELL_HIDDEN
Defaultfalse
ScopeGlobal | Report | Element
Since3.7.5

top

net.sf.jasperreports.export.xls.cell.locked
Property that specifies if the cell content is locked (read-only) within a protected sheet.
Its value is used as default for the isCellLocked() Excel export configuration setting.
By default the property is considered (true), but it only has effect if the enclosing sheet is protected.

APIPROPERTY_CELL_LOCKED
Defaulttrue
ScopeGlobal | Report | Element
Since3.7.5

top

net.sf.jasperreports.export.xls.collapse.row.span
Property that specifies whether row spans should be collapsed and merging cells across rows should be inhibited.
Its value is used as default for the isCollapseRowSpan() Excel export configuration setting.

APIPROPERTY_COLLAPSE_ROW_SPAN
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.column.name
Represents the name for the column that should appear in the metadata-based Excel export. It must be one of the column names stored in net.sf.jasperreports.export.xls.column.names.{suffix}, if provided.

APIPROPERTY_COLUMN_NAME
DefaultN/A
ScopeElement
Since4.0.2

top

net.sf.jasperreports.export.xls.column.names.{suffix}
Properties having this prefix contain comma-separated column names used in the metadata-based Excel export.
Column names in these properties are used as default list of values for the getColumnNames() Excel metadata export configuration setting.
The order of the columns is important and for accurate results they should be in the same order as the original columns.

APIPROPERTY_COLUMN_NAMES_PREFIX
DefaultN/A
ScopeReport
Since4.0.2

top

net.sf.jasperreports.export.xls.column.width
Element-level property used to adjust the column width to values suitable for Excel output, taking into account that column widths are measured in Excel in Normal style default character width units. The pixel-to-character width translation depends on the default normal style character width, so it cannot be always accurately fitted. In this case, one can adjust the current column width by setting this property with an integer value measured in pixels. The JR engine will perform the pixel-to-character width mapping using this value instead of the element's width attribute.
If defined, this property will override the PROPERTY_COLUMN_WIDTH_RATIO value for the current column

APIPROPERTY_COLUMN_WIDTH
DefaultN/A
ScopeElement
Since4.1.3

top

net.sf.jasperreports.export.xls.column.width.ratio
Property used to adjust all column widths in a document or sheet with the same width ratio, in order to get column width values suitable for Excel output. Usually column widths are measured by Excel in Normal style default character width units, while the JR engine uses pixels as default size units. When exporting the report to the Excel output format, the pixel-to-character width translation depends on the normal style default character width provided by the Excel instance, so it cannot be always accurately fitted. In this case, one can alter the generated column widths by setting this property with a float value representing the adjustment ratio. The property can be set:
  • globally - then all the columns in all documents exported to the Excel output format will be adjusted with the same width ratio
  • at report level - then all the columns in the document will be adjusted with the same width ratio
  • at element level - then all the columns in the current sheet will be adjusted with the same width ratio
Global settings are overriden by report level settings and report level settings are overriden by element level settings. If present, a PROPERTY_COLUMN_WIDTH property will override the PROPERTY_COLUMN_WIDTH_RATIO value for that column only.

APIPROPERTY_COLUMN_WIDTH_RATIO
DefaultN/A
ScopeGlobal | Report | Element
Since4.1.3

top

net.sf.jasperreports.export.xls.create.custom.palette
Flag property specifying whether the standard color palette should be customized so that the XLS result uses the original report colors.
Its value is used as default for the isCreateCustomPalette() Excel export configuration setting.
The colors used in the result XLS are determined in the following manner:
  1. If this flag is not set, the nearest color from the standard XLS palette is chosen for a report color.
  2. If the flag is set, the nearest not yet modified color from the palette is chosen and modified to exactly match the report color. If all the colors from the palette are modified (the palette has a fixed size), the nearest color from the palette is chosen for further report colors.
This property is by default not set (false).

APIPROPERTY_CREATE_CUSTOM_PALETTE
Defaultfalse
ScopeGlobal | Report
Since2.0.0

top

net.sf.jasperreports.export.xls.data
Property that specifies the value to be placed in the cell associated with the PROPERTY_COLUMN_NAME in the metadata-based Excel export.
By default this value is represented by the value stored in the report element this property is assigned to.

APIPROPERTY_DATA
DefaultN/A
ScopeElement
Since4.0.2

top

net.sf.jasperreports.export.xls.detect.cell.type
Property that specifies whether the exporter should take into consideration the type of the original text field expressions and set the cell types and values accordingly.
Its value is used as default for the isDetectCellType() Excel export configuration setting.

APIPROPERTY_DETECT_CELL_TYPE
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.first.page.number
Property that specifies the first page number in the page setup dialog.
Its value is used as default for the getFirstPageNumber() Excel export configuration setting.
When the property is set at Element level, it can be used to set the first page number for the current sheet.
Global settings are overriden by report level settings; report level settings are overriden by element (sheet) level settings.

APIPROPERTY_FIRST_PAGE_NUMBER
DefaultN/A
ScopeGlobal | Report | Element
Since4.6.0

top

net.sf.jasperreports.export.xls.fit.height
Property used at print time to indicate the number of pages height to fit the sheet in.
Its value is used as default for the getFitHeight() Excel export configuration setting.
Print pages for a given sheet in Excel are generated according to 'Paper size' settings in the Print menu, with no respect to the initial pagination of the report. In this case differences between a JasperReport print page and a page in Excel may occur.
Usually the content of a given sheet is considered to be printed into a single page. But when a sheet contains too many rows, including all of them in a single page may lead to an unreadable printed document. In this case the sheet must be split into multiple print pages. In JasperReports this number of pages can be set with the net.sf.jasperreports.export.xls.fit.height property.
Note: When this property is set to a value (for instance, n), Excel will estimate if n pages are enough to cover the entire sheet height, keeping font settings and row heights unchanged. If the number of pages is too small, font and row height adjustments will be performed in order to make room for the entire content. The printed document will come out with smaller fonts and thinner rows than those exposed in the related sheet.
See also the net.sf.jasperreports.export.xls.fit.width property.

APIPROPERTY_FIT_HEIGHT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.fit.width
Property used at print time to indicate the number of pages width to fit the sheet in.
Its value is used as default for the getFitWidth() Excel export configuration setting.
Print pages for a given sheet in Excel are generated according to 'Paper size' settings in the Print menu, with no respect to the initial pagination of the report. In this case differences between a JasperReport print page and a page in Excel may occur.
In most common cases the content of a given sheet is supposed to be printed into a single page. But problems may occur when a sheet contains too many rows and/or columns and the printed page becomes unreadable. If too many columns are involved, we can split the sheet width into multiple print pages, in order to make the content readable. In JasperReports this number of pages can be set with the net.sf.jasperreports.export.xls.fit.width property.
Note: When this property is set to a value (for instance, n), Excel will estimate if n pages are enough to cover the entire sheet width, keeping font settings and column widths unchanged. If the number of pages is too small, font and column width adjustments will be performed in order to include the entire content into available pages. The printed document will come out with smaller fonts and thinner columns than those exposed in the related sheet.
See also the net.sf.jasperreports.export.xls.fit.height property.

APIPROPERTY_FIT_WIDTH
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.font.size.fix.enabled
Flag property that indicates whether the font size should be decreased so that texts fit into the specified cell height.
Its value is used as default for the isFontSizeFixEnabled() Excel export configuration setting.

APIPROPERTY_FONT_SIZE_FIX_ENABLED
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.formula
Property that stores the formula which has to be applied to a given cell in an Excel sheet.

APIPROPERTY_CELL_FORMULA
DefaultN/A
ScopeText Element
Since3.0.0

top

net.sf.jasperreports.export.xls.freeze.column
Indicates the name of the first unlocked column in document's sheets. All columns to the left of this one will be 'frozen'. Allowed values are letters or letter combinations representing valid column names in Excel, such as A, B, AB, AC, etc. The property should be used when all sheets in the document have the same freeze column name.
The property is available for:

APIPROPERTY_FREEZE_COLUMN
DefaultN/A
ScopeGlobal | Report
Since4.1.1

top

net.sf.jasperreports.export.xls.freeze.column.edge
Property that indicates the vertical edge of the freeze pane, relative to the current cell. If set, it overrides the PROPERTY_FREEZE_COLUMN value.
Allowed values are:
  • 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.
The property is available for:

APIPROPERTY_FREEZE_COLUMN_EDGE
DefaultN/A
ScopeReport Element
Since4.1.1

top

net.sf.jasperreports.export.xls.freeze.row
Specifies the index of the first unlocked row in document's sheets. All rows above this will be 'frozen'. Allowed values are represented by positive integers in the 1..65536 range. Negative values are not considered. The property should be used when all sheets in the document have the same freeze row index.
The property is available for:

APIPROPERTY_FREEZE_ROW
DefaultN/A
ScopeGlobal | Report
Since4.1.1

top

net.sf.jasperreports.export.xls.freeze.row.edge
Property that indicates the horizontal edge of the freeze pane, relative to the current cell. If set, it overrides the PROPERTY_FREEZE_ROW value.
Allowed values are:
  • 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.
The property is available for:

APIPROPERTY_FREEZE_ROW_EDGE
DefaultN/A
ScopeReport Element
Since4.1.1

top

net.sf.jasperreports.export.xls.ignore.anchors
Flag property that indicates whether local anchors should be ignored when elements are exported to Excel.
Its value is used as default for the isIgnoreAnchors() Excel export configuration setting.
If set to true, local anchors will be excluded from export. Otherwise they will be exported along with elements they belong to.

APIPROPERTY_IGNORE_ANCHORS
Defaultfalse
ScopeGlobal | Report
Since4.6.0

top

net.sf.jasperreports.export.xls.ignore.cell.background
Property that specifies whether cell background color should be ignored.
Its value is used as default for the isIgnoreCellBackground() Excel export configuration setting.

APIPROPERTY_IGNORE_CELL_BACKGROUND
Defaultfalse
ScopeGlobal | Report
Since3.6.2

top

net.sf.jasperreports.export.xls.ignore.cell.border
Property that specifies whether cell borders should be ignored.
Its value is used as default for the isIgnoreCellBorder() Excel export configuration setting.

APIPROPERTY_IGNORE_CELL_BORDER
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.ignore.graphics
Property that specifies whether graphic elements should be ignored and only text elements will be exported.
Its value is used as default for the isIgnoreGraphics() Excel export configuration setting.

APIPROPERTY_IGNORE_GRAPHICS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.image.anchor.type
Property that specifies the image anchor type. Possible values are:
  • MoveSize - images move and size with cells
  • MoveNoSize - images move but don't size with cells
  • NoMoveNoSize - images don't move or size with cells
Global settings are overriden by report level settings; report level settings are overriden by element level settings.
Its value is used as default for the getImageAnchorType() Excel export configuration setting.

APIPROPERTY_IMAGE_ANCHOR_TYPE
DefaultMoveNoSize
ScopeGlobal | Report | Element
Since5.0.4

top

net.sf.jasperreports.export.xls.image.border.fix.enabled
Flag property that specifies whether the minimum image padding will be forced to 1 pixel, to avoid situations where the image hides the cell border.
Its value is used as default for the isImageBorderFixEnabled() Excel export configuration setting.

APIPROPERTY_IMAGE_BORDER_FIX_ENABLED
Defaultfalse
ScopeGlobal | Report
Since3.0.0

top

net.sf.jasperreports.export.xls.max.rows.per.sheet
Property that specifies the maximum number of rows allowed to be exported to the same sheet. Negative values or zero means that no limit has been set.
Its value is used as default for the getMaxRowsPerSheet() Excel export configuration setting.

APIPROPERTY_MAXIMUM_ROWS_PER_SHEET
Default0
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.one.page.per.sheet
Property that specifies whether each report page should be written in a different XLS sheet.
Its value is used as default for the isOnePagePerSheet() Excel export configuration setting.

APIPROPERTY_ONE_PAGE_PER_SHEET
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.page.scale
Property used to adjust the page content to a given percent of the normal size in the print preview pane.
Its value is used as default for the getPageScale() Excel export configuration setting.
Allowed values are positive integers from 10 to 400, representing percents of the normal size.
When the property is set at Element level, it can be used to set the page scale per sheet
Global settings are overriden by report level settings; report level settings are overriden by element (sheet) level settings.
The property overrides the PROPERTY_FIT_WIDTH and PROPERTY_FIT_HEIGHT values.
This property is by default not set (null).

APIPROPERTY_PAGE_SCALE
DefaultN/A
ScopeGlobal | Report | Element
Since4.6.0

top

net.sf.jasperreports.export.xls.password
Property that contains a String value representing the password in case of password protected sheets in documents.
Its value is used as default for the getPassword() Excel export configuration setting.
This property is by default not set (null).

APIPROPERTY_PASSWORD
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.xls.pattern
Property whose value is an Excel compatible pattern, to be used as replacement for the text field pattern when exporting to XLS formats.

APIPROPERTY_CELL_PATTERN
DefaultN/A
ScopeText Element
Since4.1.1

top

net.sf.jasperreports.export.xls.remove.empty.space.between.columns
Property that specifies whether the empty spacer columns should be removed or not.
Its value is used as default for the isRemoveEmptySpaceBetweenColumns() Excel export configuration setting.

APIPROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.remove.empty.space.between.rows
Property that specifies whether the empty spacer rows should be removed or not.
Its value is used as default for the isRemoveEmptySpaceBetweenRows() Excel export configuration setting.

APIPROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Defaultfalse
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.repeat.value
Property that specifies whether the value associated with PROPERTY_COLUMN_NAME should be repeated or not when it is missing. This property is available for the metadata-based Excel export.

APIPROPERTY_REPEAT_VALUE
Defaultfalse
ScopeElement
Since4.0.2

top

net.sf.jasperreports.export.xls.row.outline.level.{arbitrary_level}
Property prefix used to indicate the current outline row level, and when necessary, the ending row of the current outline row group with the given level. The suffix of these properties is associated with the outline level, while the property value indicates if the current row group should continue or should end. The most recommended practice is to use the outline level itself as property suffix, although this is not mandatory. The suffix may take any other string value, but one has to keep in mind that suffixes are used as sorted row levels descriptors. For instance, because "aaa" < "bbb", the outline level associated with the "aaa" suffix will be smaller than the level associated with the "bbb" suffix. A completely intuitive representation of the row levels uses the row level as property suffix.
In such a case, the 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.
The value of this property could be any expression (including 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.

APIPROPERTY_ROW_OUTLINE_LEVEL_PREFIX
DefaultN/A
ScopeElement
Since4.1.3

top

net.sf.jasperreports.export.xls.sheet.direction
This property indicates if the sheet is left-to-right or right-to-left oriented. Possible values are:
  • LTR
  • RTL
Its value is used as default for the getSheetDirection() Excel export configuration setting.

APIPROPERTY_SHEET_DIRECTION
DefaultLTR
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.footer.center
Custom property storing the text content of the sheet footer's center.
Its value is used as default for the getSheetFooterCenter() Excel export configuration setting.

APIPROPERTY_SHEET_FOOTER_CENTER
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.footer.left
Custom property storing the text content of the left side of the sheet footer.
Its value is used as default for the getSheetFooterLeft() Excel export configuration setting.

APIPROPERTY_SHEET_FOOTER_LEFT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.footer.right
Custom property storing the text content of the right side of the sheet footer.
Its value is used as default for the getSheetFooterRight() Excel export configuration setting.

APIPROPERTY_SHEET_FOOTER_RIGHT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.header.center
Custom property storing the text content of the sheet header's center.
Its value is used as default for the getSheetHeaderCenter() Excel export configuration setting.

APIPROPERTY_SHEET_HEADER_CENTER
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.header.left
Custom property storing the text content of the left side of the sheet header.
Its value is used as default for the getSheetHeaderLeft() Excel export configuration setting.

APIPROPERTY_SHEET_HEADER_LEFT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.header.right
Custom property storing the text content of the right side of the sheet header.
Its value is used as default for the getSheetHeaderRight() Excel export configuration setting.

APIPROPERTY_SHEET_HEADER_RIGHT
DefaultN/A
ScopeGlobal | Report
Since3.7.5

top

net.sf.jasperreports.export.xls.sheet.name
Property used to set the name of the sheet containing a given element. Its value overrides the report-level settings for the sheet name.
If several elements in the sheet contain this property, the engine will consider the value of the last exported element's property.

APIPROPERTY_SHEET_NAME
DefaultN/A
ScopeElement
Since4.1.3

top

net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name}
A set of report custom properties (exporter hints) added in order to hold user defined sheet names. This is very useful when indicating sheet names in the jrxml template is required.
Sheet names in these properties are used as default for the getSheetNames() Excel export configuration setting.
These properties should start with the net.sf.jasperreports.export.xls.sheet.names. prefix, and should end with an arbitrary suffix. Any of them can hold one or many sheet names, separated by the slash ("/") separator. Values are collected in the same order as they are enumerated in the jrxml template, so one have to be careful with that order when editing a jrxml. The ending suffix is not important, but the order is very.
For instance, if a given report has 3 resulting sheets, there are multiple possibilities to define the sheet names within the jrxml template:

  1. To have a single property for each sheet name:

    <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" />


    Then, the 3 resulting sheets will be named as follows:

    First sheet
    Second sheet
    Third sheet

  2. To have a single property containing all sheet names, separated by the "/" separator:

    <property name="net.sf.jasperreports.export.xls.sheet.names.all" value="First sheet/Second sheet/Third sheet" />

    Then, the 3 resulting sheets will be named as follows:

    First sheet
    Second sheet
    Third sheet
    The order is very important, as shown above.

  3. To have any combination of 1) and 2):

    <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" />


    Then, the 3 resulting sheets will be named as follows:

    First sheet
    Second sheet
    Third sheet

Finally, if the user sets less sheet names (let's say x) than the number of sheets, the exporter will use the custom user sheet names for the first x sheets in the document, and the remaining sheets will be named by default as "Page y", where y is the current page number.
These properties are by default not set.

APIPROPERTY_SHEET_NAMES_PREFIX
DefaultN/A
ScopeReport
Since3.5.2

top

net.sf.jasperreports.export.xls.show.gridlines
Flag property that specifies if the gridlines in a given sheet are shown.
Its value is used as default for the isShowGridLines() Excel export configuration setting.
If multiple elements in a sheet provide this property, the last read value will be considered. Global settings are overriden by report level settings; report level settings are overriden by element (sheet) level settings.

APIPROPERTY_SHOW_GRIDLINES
Defaulttrue
ScopeGlobal | Report | Element
Since4.8.0

top

net.sf.jasperreports.export.xls.use.timezone
Property that determines whether date values are to be translated to the timezone that was used to fill the report.
Its value is used as default for the isUseTimeZone() Excel export configuration setting.
By default, date values are exported to Excel using the default timezone of the system. Setting this property to true instructs the exporter to use he report fill timezone to export date values.
The property only has effect when net.sf.jasperreports.export.xls.detect.cell.type is set.

APIPROPERTY_USE_TIMEZONE
Defaultfalse
ScopeGlobal | Report | Element
Since4.5.0

top

net.sf.jasperreports.export.xls.white.page.background
Property that specifies whether the page background should be white or the default XLS background color.
Its value is used as default for the isWhitePageBackground() Excel export configuration setting.

APIPROPERTY_WHITE_PAGE_BACKGROUND
Defaulttrue
ScopeGlobal | Report
Since2.0.1

top

net.sf.jasperreports.export.xls.workbook.template
Property used to store the location of an existing workbook template.
Its value is used as default for the getWorkbookTemplate() Excel export configuration setting.
The content of an existing workbook document or template can be embedded into exported document if the template location is known. In this case the content of the template will be exported first and the content of the exported report will be appended to this one. Macros and other settings in the existing template will be also preserved in the generated document. Templates can be loaded from Excel template files (*.xlt) as well as from valid Excel documents (*.xls).
This property is used in Excel exporters based either on Apache POI APIs (JRXlsExporter) or on JExcelApi library (JExcelApiExporter). There's no similar property for the JRXlsxExporter.

APIPROPERTY_WORKBOOK_TEMPLATE
DefaultN/A
ScopeGlobal | Report
Since4.5.1

top

net.sf.jasperreports.export.xls.workbook.template.keep.sheets
Flag property that specifies whether to keep the sheets of the existing template into generated document.
Its value is used as default for the isKeepWorkbookTemplateSheets() Excel export configuration setting. Sometimes is important to embed in a generated document only macros and/or other global settings from an existing template, but without keeping the own sheets of the template document. If set to false, this property prevent the template sheets to be exported.
This property is used in conjunction with PROPERTY_WORKBOOK_TEMPLATE.
Allowed values are:
  • true
  • false - this is the default value.

APIPROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS
Defaultfalse
ScopeGlobal | Report
Since4.5.1

top

net.sf.jasperreports.export.xls.wrap.text
Custom element property specifying if text wrapping is allowed in a given cell.
Its value is used as default for the isWrapText() Excel export configuration setting.
If set to false, text wrapping is forbidden, otherwise it is allowed.

APIPROPERTY_WRAP_TEXT
Defaulttrue
ScopeGlobal | Report | Element
Since3.7.3

top

net.sf.jasperreports.export.xls.write.header
Property that specifies whether the export header (the column names) should be written or not, in the metadata-based Excel export.
Its value is used as default for the isWriteHeader() Excel metadata export configuration setting.

APIPROPERTY_WRITE_HEADER
Defaultfalse
ScopeElement
Since4.0.2

top

net.sf.jasperreports.export.xlsx.macro.template
Property used to store the location of an existing Excel 2007 workbook template containing a macro object. When exporting into Excel 2007 format, the macro object will be copied into the generated document if the template location is valid. Macros can be loaded from Excel 2007 macro-enabled template files (*.xltm) as well as from valid Excel macro-enabled documents (*.xlsm).
The value of this property is used as default for the getMacroTemplate() Excel 2007 export configuration setting.

APIPROPERTY_MACRO_TEMPLATE
DefaultN/A
ScopeGlobal | Report
Since4.5.1

top

net.sf.jasperreports.export.xml.end.page.index

APIPROPERTY_END_PAGE_INDEX
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.xml.page.count

APIPROPERTY_PAGE_COUNT
DefaultN/A
ScopeGlobal | Report
Since3.0.0

top

net.sf.jasperreports.export.xml.parser.factory
Property that gives a parser factory class which should be used for parsing XML exports.
By default, this property is set to use PrintSaxParserFactory as report parser factory.

APIPROPERTY_PRINT_PARSER_FACTORY
Defaultnet.sf.jasperreports.engine.xml.PrintSaxParserFactory
ScopeGlobal
Since4.1.3

top

net.sf.jasperreports.export.xml.replace.invalid.chars
Stores the text sequence used to replace invalid XML characters.
By default, this property is set to replace invalid chars with question marks. Depending on particular needs, the following settings are available:
  • to completely remove invalid XML chars from the processed text, set an empty string as property value:
    <property name="net.sf.jasperreports.export.xml.replace.invalid.chars" value=""/>
  • to replace invalid XML chars with a custom char or text sequence, set the text sequence as property value. For instance:
    <property name="net.sf.jasperreports.export.xml.replace.invalid.chars" value="^^"/>
  • to preserve invalid chars in the processed text, either set the property with no value, or remove the property from the JasperReports context. Below is the property with no value set:
    <property name="net.sf.jasperreports.export.xml.replace.invalid.chars"/>

APIPROPERTY_REPLACE_INVALID_CHARS
Default?
ScopeGlobal | Report
Since4.7.1

top

net.sf.jasperreports.export.xml.start.page.index

APIPROPERTY_START_PAGE_INDEX
DefaultN/A
ScopeGlobal | Report
Since3.0.1

top

net.sf.jasperreports.export.xml.validation
Property that forces the XML validation, when a document exported to XML format is loaded.

APIEXPORT_XML_VALIDATION
Defaulttrue
ScopeGlobal | Report
Since1.0.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.extension.{registry_id}.{property_suffix}
Property that can be used to provide a registry-specific property, by appending the registry ID and then a fixed property suffix to the fixed property prefix net.sf.jasperreports.extension..
For example:
the 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.

APIPROPERTY_REGISTRY_PREFIX
DefaultN/A
ScopeGlobal
Since3.1.0

top

net.sf.jasperreports.extension.registry.factory.{arbitrary_name}
Properties used to indicate extensions registry factories.
Such factories are used by the default components registry class to instantiate sub extensions registries. Each such property contains the fixed property prefix 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 ExtensionsRegistryFactory implementation.

APIPROPERTY_REGISTRY_FACTORY_PREFIX
DefaultN/A
ScopeGlobal
Since3.1.0

top

net.sf.jasperreports.extensions.registry.class
A property that provides the default ExtensionsRegistry implementation class.
This property is only read at initialization time, therefore changing the property value at a later time will have no effect.

APIPROPERTY_EXTENSIONS_REGISTRY_CLASS
Defaultnet.sf.jasperreports.extensions.DefaultExtensionsRegistry
ScopeGlobal
Since3.1.0

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.file.buffer.os.memory.threshold
Property specifying the maximum in-memory buffer length that triggers the creation of a temporary file on disk to store further content sent to a FileBufferedOutputStream instance.
Note: While the Global level setting is available for all document exporters, the Report level setting is processed for the XLSX output format only. To avoid memory leaks when exporting reports with a large number of sheets to XLSX format, just set this property to 0 at report level.

APIPROPERTY_MEMORY_THRESHOLD
Default262144
ScopeGlobal | Report
Since1.3.4

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.file.repository.resolve.absolute.path
Flag property that indicates whether the absolute path to be used instead, when resources are not found in the file repository.

APIPROPERTY_FILE_REPOSITORY_RESOLVE_ABSOLUTE_PATH
Defaultfalse
ScopeGlobal
Since4.1.1

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.file.repository.root
Specifies the file repository root location.

APIPROPERTY_FILE_REPOSITORY_ROOT
DefaultN/A
ScopeGlobal
Since4.1.1

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.governor.max.pages
If the governor that checks if a report exceeds a specified limit of pages is turned on, this property will indicate the maximum number of pages allowed to be ran, in order to prevent a memory overflow error. If the number of pages in the report becomes greater than this value, the report execution will be stopped.

APIPROPERTY_MAX_PAGES
DefaultN/A
ScopeGlobal | Report
Since3.1.4

top

net.sf.jasperreports.governor.max.pages.enabled
A flag indicating whether the governor that checks if a report exceeds a specified limit of pages is turned on. With this property enabled, the JR engine will stop the report execution if the number of pages becomes greater than a custom given value.

APIPROPERTY_MAX_PAGES_ENABLED
Defaultfalse
ScopeGlobal | Report
Since3.1.4

top

net.sf.jasperreports.governor.timeout
If the governor that checks if the elapsed time during report execution exceeds a specified amount of time is turned on, this property will indicate the maximum allowed amount of time, in order to prevent a memory overflow error. If this value becomes exceeded, the report execution will be stopped.

APIPROPERTY_TIMEOUT
DefaultN/A
ScopeGlobal | Report
Since3.1.4

top

net.sf.jasperreports.governor.timeout.enabled
A flag indicating whether the governor that checks if the elapsed time during report execution exceeds a specified amount of time is turned on.
With this property enabled, the JR engine will stop the report execution if the elapsed time becomes greater than the limit value.
By default it should be turned off.

APIPROPERTY_TIMEOUT_ENABLED
Defaultfalse
ScopeGlobal | Report
Since3.1.4

top

net.sf.jasperreports.hql.clear.cache
Property specifying whether Hibernate session cache should be cleared between two consecutive fetches when using pagination.
By default, the cache cleanup is not performed.

APIPROPERTY_HIBERNATE_CLEAR_CACHE
Defaultfalse
ScopeGlobal | Dataset
Since1.3.1

top

net.sf.jasperreports.hql.field.mapping.descriptions
Property specifying whether field descriptions should be used to determine the mapping between the fields and the query return values.
By default, field description are used.

APIPROPERTY_HIBERNATE_FIELD_MAPPING_DESCRIPTIONS
Defaulttrue
ScopeGlobal | Dataset
Since1.2.0

top

net.sf.jasperreports.hql.query.list.page.size
Property specifying the number of result rows to be retrieved at once when the execution type is 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).

APIPROPERTY_HIBERNATE_QUERY_LIST_PAGE_SIZE
Default0
ScopeGlobal | Dataset
Since1.2.0

top

net.sf.jasperreports.hql.query.run.type
Property specifying the Hibernate query execution type. Possible values are:
  • 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()

APIPROPERTY_HIBERNATE_QUERY_RUN_TYPE
Defaultlist
ScopeGlobal | Dataset
Since1.2.0

top

net.sf.jasperreports.image.dpi
Specifies the image resolution in dots-per-inch, for the images created by the engine when rasterizing SVGs or when clipping other renderers.

APIPROPERTY_IMAGE_DPI
Default72
ScopeGlobal
Since4.1.1

top

net.sf.jasperreports.image.encoder
Property specifying the name of the class implementing the JRImageEncoder interface to be used by the engine. If not set, the engine will try to an image encoder implementation that corresponds to the JVM version.

APIPROPERTY_IMAGE_ENCODER
DefaultN/A
ScopeGlobal
Since2.0.5

top

net.sf.jasperreports.image.reader
Property specifying the name of the class implementing the JRImageReader interface to be used by the engine. If not set, the engine will try to an image reader implementation that corresponds to the JVM version.

APIPROPERTY_IMAGE_READER
DefaultN/A
ScopeGlobal
Since2.0.5

top

net.sf.jasperreports.jdbc.cached.rowset
Flag property specifying if data will be stored in a cached rowset.

APIPROPERTY_CACHED_ROWSET
Defaultfalse
ScopeGlobal | Dataset
Since4.1.2

top

net.sf.jasperreports.jdbc.concurrency
Property specifying the concurrency rule for the java.sql.ResultSet created by the JRJdbcQueryExecuter. Possible values are:
  • 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.

APIPROPERTY_JDBC_CONCURRENCY
DefaultreadOnly
ScopeGlobal | Dataset
Since3.5.3

top

net.sf.jasperreports.jdbc.fetch.size
Property specifying the fetch size for the java.sql.ResultSet created by the JRJdbcQueryExecuter and the JRHibernateQueryExecuter.

APIPROPERTY_JDBC_FETCH_SIZE
Default0
ScopeGlobal | Dataset
Since1.2.0

top

net.sf.jasperreports.jdbc.holdability
Property specifying the cursor holdability after commit for the java.sql.ResultSet created by the JRJdbcQueryExecuter. Possible values are:
  • 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.

APIPROPERTY_JDBC_HOLDABILITY
Defaulthold
ScopeGlobal | Dataset
Since3.5.3

top

net.sf.jasperreports.jdbc.max.field.size
Property specifying the limit for the maximum number of bytes in a ResultSet column storing character or binary values created by the JRJdbcQueryExecuter.

APIPROPERTY_JDBC_MAX_FIELD_SIZE
DefaultN/A
ScopeGlobal | Dataset
Since3.5.3

top

net.sf.jasperreports.jdbc.result.set.type
Property specifying the type for the java.sql.ResultSet created by the JRJdbcQueryExecuter. Possible values are:
  • 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.

APIPROPERTY_JDBC_RESULT_SET_TYPE
DefaultforwardOnly
ScopeGlobal | Dataset
Since3.5.3

top

net.sf.jasperreports.jdk.glyph.fix.text.measurer.attempts
A property that specifies the number of times the measurer should attempt to measure a single text element before giving up.

APIPROPERTY_ATTEMPTS
Default20
ScopeGlobal
Since3.0.0

top

net.sf.jasperreports.jdk.glyph.fix.text.measurer.catch.empty.stacktrace
A property that specifies whether java.lang.NullPointer exceptions with empty stacktraces should be caught.
This is useful when running on a Sun server JVM (java -server), which might omit exception stacktraces in some cases.

APIPROPERTY_CATCH_EMPTY_STACKTRACE
Defaultfalse
ScopeGlobal
Since3.0.0

top

net.sf.jasperreports.jdk.glyph.fix.text.measurer.sleep
A property that specifies the number of milliseconds to sleep between measuring reattempts.
The default value is 0, which means that the measurer will not pause between reattempts (see DEFAULT_ATTEMPT_SLEEP).

APIPROPERTY_ATTEMPT_SLEEP
Default0
ScopeGlobal
Since3.0.0

top

net.sf.jasperreports.markup.processor.factory.{markup}
Prefix for properties that map markup text processors.
Properties having this prefix indicate the MarkupProcessor implementation to be used when parsing a given styled text having the markup type specified in the property suffix.

APIPROPERTY_MARKUP_PROCESSOR_FACTORY_PREFIX
DefaultN/A
ScopeGlobal
Since2.0.5

top

net.sf.jasperreports.page.break.no.pagination
Determines how page breaks are to be handled in reports that are not paginated.
Possible values are:
  • ignore - page breaks are ignored in non paginated reports.
  • apply - page breaks are honoured in non paginated reports.

APIPROPERTY_PAGE_BREAK_NO_PAGINATION
Defaultignore
ScopeGlobal | Report | Element
Since5.0.4

top

net.sf.jasperreports.print.keep.full.text
Property used to determine whether the fill process must preserve the original text for text elements that are not able to fit their entire contents. When this property is set, the engine saves the original text in the JRPrintText print text object, along with the index at which the text is to be truncated by the print object.

APIPROPERTY_PRINT_KEEP_FULL_TEXT
Defaultfalse
ScopeGlobal | Report | Text Element
Since2.0.3

top

net.sf.jasperreports.properties
The name of the system property that specifies the properties file name. If the system property 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.

APIPROPERTIES_FILE
Defaultjasperreports.properties
ScopeSystem
Since1.0.0

top

net.sf.jasperreports.query.chunk.token.separators
Property that specifies the list of token separators characters for TYPE_CLAUSE_TOKENS tokenized query clauses.

APIPROPERTY_CHUNK_TOKEN_SEPARATOR
Default, ; |
ScopeGlobal
Since2.0.5

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.query.executer.factory.{language}
Properties with this prefix associate a query executer factory implementation with a query language. To obtain query executer factories, a property having the query language appended to this prefix is used to get the query executer factory name.

APIQUERY_EXECUTER_FACTORY_PREFIX
DefaultN/A
ScopeGlobal
Since1.2.0

NOTE: By default, properties with this prefix are not read from the report context. This FAQ shows the additional steps to follow in order to set them on and get them from the report context.

top

net.sf.jasperreports.report.version
Property that specifies the JasperReports version associated with this report. Report elements/attributes newer than this version will be skipped by the JRXML writers (see the JRXmlWriter class for example) during the report template generation. If not set, the version is considered to be the currenly deployed version.

APIPROPERTY_REPORT_VERSION
DefaultN/A
ScopeGlobal | Report
Since4.8.0

top

net.sf.jasperreports.style.{style_property_suffix}
Properties with this prefix are used in the PropertyStyleProvider class (which is the default JR implementation of the StyleProvider interface) to configure dynamic style features for report elements. If such a property is found at element level, its value will override the related style feature of the element.

The following style properties are defined in PropertyStyleProvider class:
  • Properties for common style attributes:

    • net.sf.jasperreports.style.mode
    • net.sf.jasperreports.style.backcolor
    • net.sf.jasperreports.style.forecolor
    • net.sf.jasperreports.style.fill
    • net.sf.jasperreports.style.radius
    • net.sf.jasperreports.style.scaleImage
    • net.sf.jasperreports.style.hAlign
    • net.sf.jasperreports.style.vAlign
    • net.sf.jasperreports.style.rotation
    • net.sf.jasperreports.style.markup
    • net.sf.jasperreports.style.isBlankWhenNull
    • net.sf.jasperreports.style.fontName
    • net.sf.jasperreports.style.fontSize
    • net.sf.jasperreports.style.isBold
    • net.sf.jasperreports.style.isItalic
    • net.sf.jasperreports.style.isUnderline
    • net.sf.jasperreports.style.isStrikeThrough
    • net.sf.jasperreports.style.pdfFontName
    • net.sf.jasperreports.style.pdfEncoding
    • net.sf.jasperreports.style.isPdfEmbedded
    • net.sf.jasperreports.style.pattern - the value of this property is overriden by the <patternExpression/>, if present.

  • Properties for pen style attributes:

    • net.sf.jasperreports.style.pen.lineWidth
    • net.sf.jasperreports.style.pen.lineStyle
    • net.sf.jasperreports.style.pen.lineColor

  • Properties for box style attributes:

    • net.sf.jasperreports.style.box.padding
    • net.sf.jasperreports.style.box.topPadding
    • net.sf.jasperreports.style.box.leftPadding
    • net.sf.jasperreports.style.box.rightPadding
    • net.sf.jasperreports.style.box.bottomPadding
    • net.sf.jasperreports.style.box.pen.lineWidth
    • net.sf.jasperreports.style.box.pen.lineStyle
    • net.sf.jasperreports.style.box.pen.lineColor
    • net.sf.jasperreports.style.box.top.pen.lineWidth
    • net.sf.jasperreports.style.box.top.pen.lineStyle
    • net.sf.jasperreports.style.box.top.pen.lineColor
    • net.sf.jasperreports.style.box.left.pen.lineWidth
    • net.sf.jasperreports.style.box.left.pen.lineStyle
    • net.sf.jasperreports.style.box.left.pen.lineColor
    • net.sf.jasperreports.style.box.right.pen.lineWidth
    • net.sf.jasperreports.style.box.right.pen.lineStyle
    • net.sf.jasperreports.style.box.right.pen.lineColor
    • net.sf.jasperreports.style.box.bottom.pen.lineWidth
    • net.sf.jasperreports.style.box.bottom.pen.lineStyle
    • net.sf.jasperreports.style.box.bottom.pen.lineColor

  • Properties for paragraph style attributes:

    • net.sf.jasperreports.style.paragraph.lineSpacing
    • net.sf.jasperreports.style.paragraph.lineSpacingSize
    • net.sf.jasperreports.style.paragraph.firstLineIndent
    • net.sf.jasperreports.style.paragraph.leftIndent
    • net.sf.jasperreports.style.paragraph.rightIndent
    • net.sf.jasperreports.style.paragraph.spacingBefore
    • net.sf.jasperreports.style.paragraph.spacingAfter
    • net.sf.jasperreports.style.paragraph.tabStopWidth
Note: All the above properties are exclusively used to override features of the element's style, and not to define a new style in the report. Properties such as net.sf.jasperreports.style.name or net.sf.jasperreports.style.style have no meaning and no effects in this implementation. Conditional styles should be used instead.

APISTYLE_PROPERTY_PREFIX
DefaultN/A
ScopeElement
Since4.8.0

top

net.sf.jasperreports.style.evaluation.time.enabled
A flag the determines whether the style of an element is evaluated at the element evaluation time, or at the time the band on which the element is placed is rendered.
This applies to report elements that can have delayed evaluations times (such as text fields and images). When this flag is set to 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.

APIPROPERTY_EVALUATION_TIME_ENABLED
Defaultfalse
ScopeGlobal | Report | Element
Since3.5.2

top

net.sf.jasperreports.subreport.runner.factory
Property specifying the JRSubreportRunnerFactory implementation to use for creating subreport runners.

APISUBREPORT_RUNNER_FACTORY
Defaultnet.sf.jasperreports.engine.fill.JRThreadSubreportRunnerFactory
ScopeGlobal
Since1.2.2

top

net.sf.jasperreports.text.measurer.factory
This property can either hold the name of a text measurer factory class, or hold an alias of a text measurer factory class property. One can write an implementation of the JRTextMeasurerFactory interface. This will usually imply writing a custom implementation of the JRTextMeasurer interface, either from scratch or by extending the default implementation (TextMeasurer). A text measurer is responsible with computing text layout attributes (in the form of JRMeasuredText instances) for report text elements. The measurer is only used at report fill time, the exporters will use the computed text layout attributes. Then one can define an alias of the text measurer factory implementation by declaring a property 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.

APIPROPERTY_TEXT_MEASURER_FACTORY
Defaultnet.sf.jasperreports.engine.fill.TextMeasurerFactory
ScopeGlobal | Report | Text Element
Since2.0.3

top

net.sf.jasperreports.text.save.line.breaks
Boolean property that determines whether the positions where text line break occurs are to be saved during report fill in oder to be used at export time.
At report fill time, each text element is measured in order to determine how long it needs to stretch or where it needs to be truncated. During this measurement, the text wraps at certain positions in order to fit the text element defined width.
Setting this property to true instructs the engine to save the positions at which line breaks occur in the generated print element. The positions can be used by report exporters that want to enforce line breaks to occur at exactly the same position as they did during text measurement at fill time.
Currently, the HTML exporter will make use of the saved line break positions by introducing explicit line breaks.

APIPROPERTY_SAVE_LINE_BREAKS
Defaultfalse
ScopeGlobal | Report | Text Element
Since3.5.1

top

net.sf.jasperreports.text.truncate.at.char
Boolean property that determines whether text elements are to be truncated at the last character that fits. By default, when the entire text of a text element does not fit the element's area, the text is truncated at the last word that fits the area.

APIPROPERTY_TRUNCATE_AT_CHAR
Defaultfalse
ScopeGlobal | Report | Text Element
Since2.0.3

top

net.sf.jasperreports.text.truncate.suffix
Property whose value is used as a suffix for the truncated text. The suffix is appended to the text when truncation occurs. If the property is not defined or empty (which is the case by default), no suffix will be used when the text is truncated.

APIPROPERTY_TRUNCATE_SUFFIX
Defaultempty string
ScopeGlobal | Report | Text Element
Since2.0.3

top

net.sf.jasperreports.viewer.render.buffer.max.size
Maximum size (in pixels) of a buffered image that would be used by JRViewer to render a report page. If rendering a report page would require an image larger than this threshold (i.e. image width x image height > maximum size), the report page will be rendered directly on the viewer component. If this property is zero or negative, buffered images will never be used to render a report page.

APIVIEWER_RENDER_BUFFER_MAX_SIZE
Default0
ScopeGlobal
Since1.2.8

top

net.sf.jasperreports.virtual.page.element.size
Property that determines how many print elements will make up a virtual page handled as a unit by the virtualizer.

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.


APIPROPERTY_VIRTUAL_PAGE_ELEMENT_SIZE
Default2000
ScopeGlobal | Report
Since4.1.3

top

net.sf.jasperreports.virtualizer.files.delete.on.exit
Property used to decide whether 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.

APIPROPERTY_TEMP_FILES_SET_DELETE_ON_EXIT
Defaulttrue
ScopeGlobal
Since1.2.3

NOTE: By default, this property is not read from the report context. This FAQ shows the additional steps to follow in order to set it on and get it from the report context.

top

net.sf.jasperreports.xpath.executer.factory
Property specifying the JRXPathExecuterFactory XPath executer factory implementation class name. JasperReports is shipped with two implementation of this factory interface: XalanXPathExecuterFactory and JaxenXPathExecuter.

APIPROPERTY_XPATH_EXECUTER_FACTORY
Defaultnet.sf.jasperreports.engine.util.xml.XalanXPathExecuterFactory
ScopeGlobal
Since2.0.0



© 2001- TIBCO Software Inc. www.jaspersoft.com