| JasperReports Ultimate Guide - Sample Reference - Schema Reference - Configuration Reference - FAQ - API (Javadoc)
|
|
|
|
|
| JasperReports - Configuration Reference (version 6.16.0) | |
|
|
|
|
|
|
|
|
|
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. |
||||
|
|
||||
| API: | PROPERTY_ALLOW_ELEMENT_NEGATIVE_WIDTH
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.7.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.allow.element.negative.x | ||||
|
Property that determines whether elements positioned at negative X offsets on bands, frames and other element containers are allowed in a report.
Elements placed at negative X 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 X offsets. Otherwise, no check is performed on element X offsets. |
||||
|
|
||||
| API: | PROPERTY_ALLOW_ELEMENT_NEGATIVE_X
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.1.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. |
||||
|
|
||||
| API: | PROPERTY_ALLOW_ELEMENT_NEGATIVE_Y
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.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:
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. |
||||
|
|
||||
| API: | PROPERTY_ALLOW_ELEMENT_OVERLAP
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.awt.check.available.printers | ||||
| Property whose value is used to check the availability of printers accepting jobs. | ||||
|
|
||||
| API: | PROPERTY_CHECK_AVAILABLE_PRINTERS
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. | ||||
|
|
||||
| API: | PROPERTY_AWT_IGNORE_MISSING_FONT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.6.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.awt.indent.first.line | ||||
| Property used to disable the indentation for the first line in a paragraph. | ||||
|
|
||||
| API: | PROPERTY_AWT_INDENT_FIRST_LINE
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.awt.justify.last.line | ||||
| Property used to force the justified alignment for the last line in a paragraph. | ||||
|
|
||||
| API: | PROPERTY_AWT_JUSTIFY_LAST_LINE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.awt.superscript.fix.enabled | ||||
|
|
||||
| API: | PROPERTY_AWT_SUPERSCRIPT_FIX_ENABLED
|
|||
| Default: | N/A | |||
| Scope: | Global | |||
| Since: | 3.1.3 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.band.split.type | ||||
| Specifies the default split type for bands. See the splitType attribute of the report band. | ||||
|
|
||||
| API: | PROPERTY_SPLIT_TYPE
|
|||
| Default: | Stretch | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. | ||||
|
|
||||
| API: | PROPERTY_MINIMUM_PRECISION
|
|||
| Default: | 16 | |||
| Scope: | Global | |||
| Since: | 3.5.4 | |||
|
|
||||
| NOTE: This property is not read from the configuration context. This FAQ shows the additional steps to follow in order to set it dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.bookmarks.data.source.parameter | ||||
| Property that references the parameter containing the bookmarks data source. | ||||
|
|
||||
| API: | PROPERTY_BOOKMARKS_DATA_SOURCE_PARAMETER
|
|||
| Default: | N/A | |||
| Scope: | Part | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chart.dial.label | ||||
| Property containing the label text attached to the measured value in a meter or thermometer chart. | ||||
|
|
||||
| API: | PROPERTY_DIAL_LABEL
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 3.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. | ||||
|
|
||||
| API: | PROPERTY_DIAL_VALUE_DISPLAY_VISIBLE
|
|||
| Default: | false | |||
| Scope: | Chart | |||
| Since: | 3.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. | ||||
|
|
||||
| API: | PROPERTY_DOMAIN_AXIS_INTEGER_UNIT
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 4.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. | ||||
|
|
||||
| API: | PROPERTY_DOMAIN_AXIS_TICK_COUNT
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_DOMAIN_AXIS_TICK_INTERVAL
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 3.1.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chart.pie.ignore.duplicated.key | ||||
| Specifies whether duplicated key entries in pie dataset should be ignored and only the last value be considered, or whether an exception should be raised instead. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_DUPLICATED_KEY
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.0.2 | |||
|
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. | ||||
|
|
||||
| API: | PROPERTY_RANGE_AXIS_INTEGER_UNIT
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 4.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. |
||||
|
|
||||
| API: | PROPERTY_RANGE_AXIS_TICK_COUNT
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_RANGE_AXIS_TICK_INTERVAL
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 3.1.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chart.render.type | ||||
|
Specifies the default render type for charts. See the renderType attribute of the chart elements.
Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_CHART_RENDER_TYPE
|
|||
| Default: | draw | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_CHART_RENDERER_FACTORY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 2.0.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chart.theme | ||||
| Property used to specify the chart theme name. | ||||
|
|
||||
| API: | PROPERTY_CHART_THEME
|
|||
| Default: | default | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.argument.{name} | ||||
|
An arbitrary argument used when launching Chromium/Google Chrome.
The {name} suffix is used as argument name, and the property value as argument value. A boolean property value is required for flags. |
||||
|
|
||||
| API: | PROPERTY_ARGUMENT_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.enabled | ||||
|
Determines whether Chromium/Google Chrome is to be used to render JavaScript based components
(such as Custom Visualization Components) for exporting to formats other than HTML.
When enabled, a browser instance is launched (in headless mode by default) on the machine where JasperReports is running. Scripts and resources needed to render the components are written to a temporary folder, and JasperReports communicates with the browser instance via the Chrome DevTools Protocol. |
||||
|
|
||||
| API: | PROPERTY_ENABLED
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.executable.path | ||||
|
The path of the Chromium/Google Chrome executable.
If not set, a predefined list of common paths will be checked. |
||||
|
|
||||
| API: | PROPERTY_EXECUTABLE_PATH
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.headless | ||||
| Determines whether Chromium/Google Chrome is to be launched in headless mode. | ||||
|
|
||||
| API: | PROPERTY_HEADLESS
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.idle.timeout | ||||
|
The number of milliseconds after which an idle Chromium/Google Chrome instance will be
shut down.
After shuttind down an idle instnace, a fresh browser process is launched when needed. The property can be set to 0 to repress shutting down idle instances. |
||||
|
|
||||
| API: | PROPERTY_IDLE_TIMEOUT
|
|||
| Default: | 900000 | |||
| Scope: | Global | Context | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.live.timeout | ||||
|
The number of milliseconds a Chromium/Google Chrome instance is allowed to live.
The instance is shut down after the configured timeout, first waiting for the ongoing component render tasks to finish. After shuttind down an instance, a fresh browser process is launched when needed. The property can be set to 0 to repress shutting down browser instances. |
||||
|
|
||||
| API: | PROPERTY_LIVE_TIMEOUT
|
|||
| Default: | 7200000 | |||
| Scope: | Global | Context | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.page.isolate | ||||
|
Whether to create Chrome pages in isolated mode for component render tasks.
Isolated pages do not share cookies and other page data. The implementation relies on the Chrome DevTools Protocol Target.createBrowserContext command. |
||||
|
|
||||
| API: | PROPERTY_PAGE_ISOLATE
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.page.timeout | ||||
|
The number of milliseconds after which a component render task is interrupted.
A component render task usually consists of loading an HTML page from a temporary file, running JavaScript code to render the component and retriving an SVG representation of the component or taking a screenshot. Interrupting a component render task raises an exception which in most cases aborts the report export process. The property can be set to 0 to repress the interrupting component render tasks (unless the component itself has a timeout defined). |
||||
|
|
||||
| API: | PROPERTY_PAGE_TIMEOUT
|
|||
| Default: | 60000 | |||
| Scope: | Global | Context | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.chrome.tempdir.path | ||||
| The path were temporary resource files used for rendering components will be written. | ||||
|
|
||||
| API: | PROPERTY_TEMPDIR_PATH
|
|||
| Default: | System.getProperty("java.io.tmpdir") | |||
| Scope: | Global | Context | |||
| Since: | 6.11.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. For reports that use Java as expression language (which is the default), net.sf.jasperreports.engine.design.JRJdtCompiler is used as report compiler, if available, and net.sf.jasperreports.engine.design.JRJdk13Compiler otherwise. |
||||
|
|
||||
| API: | COMPILER_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.compiler.classpath | ||||
| Property specifying the classpath used by the report compiler during the compilation process. | ||||
|
|
||||
| API: | COMPILER_CLASSPATH
|
|||
| Default: | System.getProperty("java.class.path") | |||
| Scope: | Global | Context | |||
| Since: | 1.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. | ||||
|
|
||||
| API: | COMPILER_KEEP_JAVA_FILE
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 1.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.compiler.max.groovy.method.size | ||||
| Property that determines the maximum size of a generated groovy method. | ||||
|
|
||||
| API: | PROPERTY_MAX_METHOD_SIZE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 5.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.compiler.max.java.method.size | ||||
| Property that determines the maximum size of a generated Java method. | ||||
|
|
||||
| API: | PROPERTY_MAX_METHOD_SIZE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 5.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.compiler.temp.dir | ||||
| Property specifying the temporary working directory to be used by the report compiler. | ||||
|
|
||||
| API: | COMPILER_TEMP_DIR
|
|||
| Default: | System.getProperty("user.dir") | |||
| Scope: | Global | Context | |||
| Since: | 1.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). |
||||
|
|
||||
| API: | PROPERTY_CACHE_SCHEMAS
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 3.1.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_REPORT_PARSER_FACTORY
|
|||
| Default: | net.sf.jasperreports.engine.xml.JRReportSaxParserFactory | |||
| Scope: | Global | Context | |||
| Since: | 3.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.compiler.xml.validation | ||||
| Property that forces the XML validation of the report template file before compiling. | ||||
|
|
||||
| API: | COMPILER_XML_VALIDATION
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 1.0.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_COMPONENTS_VERSION_SUFFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Part | Component | |||
| Since: | 4.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.barcode4j.image.antiAlias | ||||
| Flag property that specify the barcode image should use antialiasing. Default value is true. | ||||
|
|
||||
| API: | PROPERTY_ANTIALIAS
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 3.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.barcode4j.image.gray | ||||
| Flag property that specify the barcode image should use the gray color scheme. Default value is true. | ||||
|
|
||||
| API: | PROPERTY_GRAY
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 3.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.barcode4j.image.producer | ||||
|
Property that determines which image producer to be used for a barcode component element. The property can
have a value of the name of the class that implements the image producer interface or an
alias that has been set for such a class, using a property of the form
net.sf.jasperreports.components.barcode4j.image.producer.{alias}.
JasperReports provides two barcode image producer implementations: one which renders the barcode in SVG format and one which renders the barcode as a rasterized image. The first implementation is registered under the svg alias and is used by default; the second one has image as alias and can be used by changing the net.sf.jasperreports.components.barcode4j.image.producer.{alias} property at any level. The SVG barcode image producer uses the Barcode4J API to export the barcode to SVG, then it creates a SVG renderer based on the Batik SVG library. Hence, this option introduces a dependency on Batik for viewing or exporting a report that includes barcodes. The rasterized image producer draws the barcode on a PNG image which can be then displayed in the generated report. This producer uses further properties, set at the same levels as the image producer property, to allow the customization of the generated image. |
||||
|
|
||||
| API: | PROPERTY_IMAGE_PRODUCER
|
|||
| Default: | svg | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 3.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.barcode4j.image.producer.{alias} | ||||
|
Property that determines which image producer implementation to be used for an alias associated
with the barcode component element using the net.sf.jasperreports.components.barcode4j.image.producer
property.
The value of this property represents the name of the class that implements the image producer interface for the specified alias. Rendering the barcode in SVG format is registered under the svg alias and is used by default; the built-in property value for this alias is net.sf.jasperreports.components.barcode4j.BarcodeSVGImageProducer. Rendering the barcode as rasterized is registered under the image alias and the built-in property value for this alias is net.sf.jasperreports.components.barcode4j.BarcodeRasterizedImageProducer. If the svg alias is set, the built-in SVG renderer is based on the Batik SVG library. Hence, this option introduces a dependency on Batik for viewing or exporting a report that includes barcodes. The rasterized image producer draws the barcode on a PNG image which can be then displayed in the generated report. This producer uses further properties, set at the same levels as the image producer property, to allow the customization of the generated image. Note: This property does not apply to QRCode barcodes which are generated based on a different library (ZXing). For QRCode barcodes, see net.sf.jasperreports.components.barcode4j.qrcode.producer.{alias}. |
||||
|
|
||||
| API: | PROPERTY_PREFIX_IMAGE_PRODUCER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 3.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.barcode4j.image.resolution | ||||
| Property that specify the barcode image resolution (ppi). Default value is 300. | ||||
|
|
||||
| API: | PROPERTY_RESOLUTION
|
|||
| Default: | 300 | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 3.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.barcode4j.qrcode.producer.{alias} | ||||
|
Property that determines which image producer implementation to be used for an alias associated
with the QRCode component element using the net.sf.jasperreports.components.barcode4j.image.producer
property.
The value of this property represents the name of the class that implements the image producer interface for the specified alias. Rendering the QRCode component in SVG format is registered under the svg alias and is used by default; the built-in property value for this alias is net.sf.jasperreports.components.barcode4j.QRCodeSVGImageProducer. Rendering the QRCode component as rasterized is registered under the image alias and the built-in property value for this alias is net.sf.jasperreports.components.barcode4j.QRCodeRasterizedImageProducer. |
||||
|
|
||||
| API: | PROPERTY_PREFIX_QRCODE_PRODUCER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 6.0.2 | |||
|
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 | ||||
|
|
||||
| API: | PROPERTY_FILTER_CHAR
|
|||
| Default: | \2606 | |||
| Scope: | Global | Context | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.icon.font | ||||
| Global property that specifies the font to be used for the icons on the column header | ||||
|
|
||||
| API: | PROPERTY_ICON_FONT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | |||
| Since: | 5.5.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. |
||||
|
|
||||
| API: | PROPERTY_CLIENT_ID
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.map.google.version | ||||
Property that indicates which version of the Google Maps API to be loaded. The version property may be set as:
|
||||
|
|
||||
| API: | PROPERTY_GOOGLE_VERSION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.4.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.map.key | ||||
Property that specifies the Google Maps API key. Using an API key enables additional features:
|
||||
|
|
||||
| API: | PROPERTY_KEY
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.0 | |||
|
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. | ||||
|
|
||||
| API: | PROPERTY_SIGNATURE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.qrcode.character.encoding | ||||
| Property that provides the character encoding to be used for QR code component elements. | ||||
|
|
||||
| API: | PROPERTY_QRCODE_CHARACTER_ENCODING
|
|||
| Default: | UTF-8 | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 6.5.0 | |||
|
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 | ||||
|
|
||||
| API: | PROPERTY_DOWN_ARROW_CHAR
|
|||
| Default: | \u25BC | |||
| Scope: | Global | Context | |||
| Since: | 4.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 | ||||
|
|
||||
| API: | PROPERTY_UP_ARROW_CHAR
|
|||
| Default: | \u25B2 | |||
| Scope: | Global | Context | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.column.conditionally.formattable | ||||
| Property that enables/disables conditional formatting | ||||
|
|
||||
| API: | PROPERTY_COLUMN_CONDITIONALLY_FORMATTABLE
|
|||
| Default: | true | |||
| Scope: | Column | |||
| Since: | 5.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.column.field | ||||
| Property that specifies the field to be used for sorting and/or filtering | ||||
|
|
||||
| API: | PROPERTY_COLUMN_FIELD
|
|||
| Default: | N/A | |||
| Scope: | Column | |||
| Since: | 5.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.column.filterable | ||||
| Property that enables/disables filtering | ||||
|
|
||||
| API: | PROPERTY_COLUMN_FILTERABLE
|
|||
| Default: | true | |||
| Scope: | Column | |||
| Since: | 5.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.column.sortable | ||||
| Property that enables/disables sorting | ||||
|
|
||||
| API: | PROPERTY_COLUMN_SORTABLE
|
|||
| Default: | true | |||
| Scope: | Column | |||
| Since: | 5.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.column.variable | ||||
| Property that specifies the variable to be used for sorting and/or filtering | ||||
|
|
||||
| API: | PROPERTY_COLUMN_VARIABLE
|
|||
| Default: | N/A | |||
| Scope: | Column | |||
| Since: | 5.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.floating.header | ||||
|
Property that enables/disables the floating header in the table component when scrolling.
If the interactivity has been disabled by setting net.sf.jasperreports.components.table.interactive to false, then setting this property will have no effect. |
||||
|
|
||||
| API: | PROPERTY_FLOATING_HEADER
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.generate.pdf.tags | ||||
| Property that enables/disables the automatic addition of specific custom properties to table cell elements, that would in turn trigger the creation of special document accessibility tags during PDF export. | ||||
|
|
||||
| API: | PROPERTY_GENERATE_TABLE_PDF_TAGS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Component | |||
| Since: | 6.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.interactive | ||||
| Property that enables/disables the interactivity in the table component | ||||
|
|
||||
| API: | PROPERTY_INTERACTIVE_TABLE
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Component | Column | |||
| Since: | 4.7.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.name | ||||
| Property that provides a name for table. The name is used as report name in element origins. | ||||
|
|
||||
| API: | PROPERTY_TABLE_NAME
|
|||
| Default: | N/A | |||
| Scope: | Component | |||
| Since: | 6.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.components.table.when.no.data.type | ||||
| Property that specifies a default value for the whenNoDataType attribute of table components. | ||||
|
|
||||
| API: | CONFIG_PROPERTY_WHEN_NO_DATA_TYPE
|
|||
| Default: | Blank | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.consume.space.on.overflow | ||||
| Property used to force the expanding text fields to occupy all remaining space at the bottom of the page so that no other element renders there. | ||||
|
|
||||
| API: | PROPERTY_CONSUME_SPACE_ON_OVERFLOW
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.create.sort.fields.for.groups | ||||
| Property that specifies whether additional sort fields should be created automatically to preserve the integrity of dataset groups, when interactive sorting is performed. The groups need to have simple expressions using single field or single variable reference, for this feature to work properly. | ||||
|
|
||||
| API: | PROPERTY_CREATE_SORT_FIELDS_FOR_GROUPS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.crosstab.bucket.measure.limit | ||||
| Property that limits the number of buckets in a crosstab, to avoid out of memory errors. | ||||
|
|
||||
| API: | PROPERTY_BUCKET_MEASURE_LIMIT
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | |||
| Since: | 1.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) | ||||
|
|
||||
| API: | PROPERTY_COLUMN_SPAN
|
|||
| Default: | N/A | |||
| Scope: | Internal | |||
| Since: | 3.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) | ||||
|
|
||||
| API: | PROPERTY_ROW_SPAN
|
|||
| Default: | N/A | |||
| Scope: | Internal | |||
| Since: | 3.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 |
||||
|
|
||||
| API: | PROPERTY_TYPE
|
|||
| Default: | N/A | |||
| Scope: | Internal | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.crosstab.column.header.sort.measure.index | ||||
| Property that provides the index of measure to be used for sorting the crosstab. | ||||
|
|
||||
| API: | PROPERTY_COLUMN_HEADER_SORT_MEASURE_INDEX
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 5.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.crosstab.floating.headers | ||||
|
Property that enables/disables the floating headers in the crosstab component when scrolling.
If the interactivity has been disabled by setting net.sf.jasperreports.crosstab.interactive to false, then setting this property will have no effect. |
||||
|
|
||||
| API: | PROPERTY_FLOATING_HEADERS
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Crosstab | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.crosstab.ignore.width | ||||
| Property that provides the default value for the crosstab ignoreWidth attribute. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_WIDTH
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.5.3 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.crosstab.interactive | ||||
| Property that enables/disables the interactivity in the crosstab component. | ||||
|
|
||||
| API: | PROPERTY_INTERACTIVE
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Crosstab | |||
| Since: | 5.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.crosstab.row.group.column.header | ||||
| Property that specifies this element is the column header for a row group represented by its index. | ||||
|
|
||||
| API: | PROPERTY_ROW_GROUP_COLUMN_HEADER
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 5.5.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.column.names.{arbitrary_name} | ||||
| Property having this prefix store the comma separated names of the columns to be extracted from the CSV source. | ||||
|
|
||||
| API: | CSV_COLUMN_NAMES
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.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. | ||||
|
|
||||
| API: | CSV_DATE_PATTERN
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.encoding | ||||
| Property holding the value of the charset used to encode the CSV stream. | ||||
|
|
||||
| API: | CSV_ENCODING
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.field.column.index | ||||
| Property specifying the 0-based index of the column in the CSV data to which the dataset field is mapped to, in case CSV data is used. | ||||
|
|
||||
| API: | PROPERTY_FIELD_COLUMN_INDEX
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.field.column.name | ||||
| Property specifying the name of the column in the CSV data to which the dataset field is mapped to, in case CSV data is used. | ||||
|
|
||||
| API: | PROPERTY_FIELD_COLUMN_NAME
|
|||
| Default: | N/A | |||
| Scope: | Field | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.field.delimiter | ||||
| Property holding the value of the field delimiter from the CSV source. | ||||
|
|
||||
| API: | CSV_FIELD_DELIMITER
|
|||
| Default: | , | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.locale.code | ||||
| Property holding the java.lang.String code of the locale to be used when parsing the CSV data. | ||||
|
|
||||
| API: | CSV_LOCALE_CODE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.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. | ||||
|
|
||||
| API: | CSV_NUMBER_PATTERN
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.record.delimiter | ||||
| Property holding the value of the record delimiter from the CSV source | ||||
|
|
||||
| API: | CSV_RECORD_DELIMITER
|
|||
| Default: | \n | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.source | ||||
String property representing a valid path to the requested resource containing the CSV data. It can be:
|
||||
|
|
||||
| API: | CSV_SOURCE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.csv.timezone.id | ||||
| Property holding the java.lang.String value of the time zone id to be used when parsing the CSV data. | ||||
|
|
||||
| API: | CSV_TIMEZONE_ID
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.customizer.{arbitrary_name}.{property_name} | ||||
| Properties having this form are usually supposed to be read by NamedChartCustomizer instances assigned to a chart element using a custom property in the form of net.sf.jasperreports.customizer.class.{arbitrary_name}. | ||||
|
|
||||
| API: | CUSTOMIZER_PROPERTY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Chart | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.customizer.class.{arbitrary_name} | ||||
| Properties having this prefix specify the name of a class that implements the JRChartCustomizer interface and has an empty constructor. This class will be used to instantiate a chart customizer object that will be then called to customize the chart produced by the element. The {arbitrary_name} suffix of the property is considered to be the name of the chart customizer instance and in case the chart customizer class implements the NamedChartCustomizer interface, this name is passed to it after instantiation using the setName(String) method. Named customizer implementations such as the ones extending the JRAbstractChartCustomizer could use this name to read custom chart element properties that are supposed to be their own, because they have this name as part of the full custom property name in the form of net.sf.jasperreports.customizer.{arbitrary_name}.{property_name}. | ||||
|
|
||||
| API: | CUSTOMIZER_CLASS_PROPERTY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Chart | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.data.adapter | ||||
| Property that provides the location of a data adapter resource to be used for the dataset. | ||||
|
|
||||
| API: | PROPERTY_DATA_ADAPTER_LOCATION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.1.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.data.cache.included | ||||
| Flag property that specifies if data associated with this object (report parameter, subreport element, subdataset run, report part) will be included in the data snapshot. Default value is false for report parameters and true for subreport elements, subdataset run and report parts. | ||||
|
|
||||
| API: | PROPERTY_INCLUDED
|
|||
| Default: | N/A | |||
| Scope: | Parameter | Subdataset Run | Subreport | Part | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.data.cache.persistable | ||||
| Flag property that specifies if the data snapshot can be persisted. Default value is true. | ||||
|
|
||||
| API: | PROPERTY_DATA_PERSISTABLE
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.data.cache.recordable | ||||
| Flag property that specifies if data recording is enabled. Default value is true. | ||||
|
|
||||
| API: | PROPERTY_DATA_RECORDABLE
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 4.6.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. |
||||
|
|
||||
| API: | DEFAULT_FIRST_LINE_INDENT
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | |||
| Since: | 4.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.default.font.name | ||||
| Specifies the default font name when no default font is explicitly given in a report. | ||||
|
|
||||
| API: | DEFAULT_FONT_NAME
|
|||
| Default: | SansSerif | |||
| Scope: | Global | Context | |||
| Since: | 1.3.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.default.font.size | ||||
| Specifies the default font size when no default font size is explicitly given in a report. | ||||
|
|
||||
| API: | DEFAULT_FONT_SIZE
|
|||
| Default: | 10 | |||
| Scope: | Global | Context | |||
| Since: | 1.3.0 | |||
|
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. |
||||
|
|
||||
| API: | DEFAULT_LEFT_INDENT
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | |||
| Since: | 4.0.2 | |||
|
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: |
||||
|
|
||||
| API: | DEFAULT_LINE_SPACING_SIZE
|
|||
| Default: | 1 | |||
| Scope: | Global | Context | |||
| Since: | 4.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.default.locale | ||||
| The default locale used to fill reports. The property is overridden by the REPORT_LOCALE parameter value. | ||||
|
|
||||
| API: | PROPERTY_DEFAULT_LOCALE
|
|||
| Default: | system locale | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. | ||||
|
|
||||
| API: | DEFAULT_PDF_EMBEDDED
|
|||
| Default: | false | |||
| Scope: | Global | Context | |||
| Since: | 1.3.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.default.pdf.encoding | ||||
| Property indicating the default PDF encoding, if not specified in the report template or at export time. | ||||
|
|
||||
| API: | DEFAULT_PDF_ENCODING
|
|||
| Default: | Cp1252 | |||
| Scope: | Global | Context | |||
| Since: | 1.3.0 | |||
|
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. | ||||
|
|
||||
| API: | DEFAULT_PDF_FONT_NAME
|
|||
| Default: | Helvetica | |||
| Scope: | Global | Context | |||
| Since: | 1.3.0 | |||
|
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. |
||||
|
|
||||
| API: | DEFAULT_RIGHT_INDENT
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | |||
| Since: | 4.0.2 | |||
|
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. |
||||
|
|
||||
| API: | DEFAULT_SPACING_AFTER
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | |||
| Since: | 4.0.2 | |||
|
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. |
||||
|
|
||||
| API: | DEFAULT_SPACING_BEFORE
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | |||
| Since: | 4.0.2 | |||
|
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. |
||||
|
|
||||
| API: | DEFAULT_TAB_STOP_WIDTH
|
|||
| Default: | 40 | |||
| Scope: | Global | Context | |||
| Since: | 4.0.2 | |||
|
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. | ||||
|
|
||||
| API: | PROPERTY_DEFAULT_TIMEZONE
|
|||
| Default: | system time zone | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. | ||||
|
|
||||
| API: | PROPERTY_JPA_QUERY_HINT_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Report | Dataset | |||
| Since: | 1.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). |
||||
|
|
||||
| API: | PROPERTY_JPA_QUERY_PAGE_SIZE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 1.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. |
||||
|
|
||||
| API: | PROPERTY_EVALUATOR_CLASS_REFERENCE_FIX_ENABLED
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 3.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.evaluator.ignore.npe | ||||
|
The expression evaluation engine in JasperReports has always ignored
java.lang.NullPointerException exceptions raised during expression evaluation.
An expression raising NullPointerException is evaluated to null.
However, in certain cases, users want to be able to track down the source of
their NPE and this configuration property can be set to instruct the expression
evaluation engine to treat NPEs just the way all other expression exceptions are treated.
The default value of this configuration property is true, meaning NPEs are ignored. The property can be set globally, at report or at dataset level. |
||||
|
|
||||
| API: | PROPERTY_IGNORE_NPE
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Dataset | |||
| Since: | 6.1.1 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_SUFFIX_DEFAULT_FILTER_FACTORY
|
|||
| Default: | same default value as for net.sf.jasperreports.export.default.filter.factory | |||
| Scope: | Global | Context | |||
| Since: | 3.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.{format}.exclude | ||||
| Element level property to exclude elements when exporting to a specific format. Possible values for the {format} token are pdf, html, xls, xlsx, rtf, odt, ods, csv and txt. The element will be excluded from a specific export format if the property is set to true at element level. | ||||
|
|
||||
| API: | PROPERTY_EXCLUDE_SUFFIX
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.{format}.exclude.key.{suffix} | ||||
|
Properties with this syntax are used by the exporters to create default exporter filter instances that filter
out content based on element key information. Possible values for the {format} token are
pdf, html, xls, xlsx, rtf, odt, ods, csv
and txt. The {suffix} token can be either the element's key value or an arbitrary string. The value of the property, if
defined, should be the element's key value. If the property has no value, its suffix will be assumed as a value.
The following example shows how to specify element keys which are to be excluded from specific export outputs: <jasperReport ...> <!-- exclude elements with keys Image1 and Text4 from HTML export --> <property name="net.sf.jasperreports.export.html.exclude.key.Image1"/> <property name="net.sf.jasperreports.export.html.exclude.key.Text4"/> <!-- exclude elements with keys Image5 from PDF export --> <property name="net.sf.jasperreports.export.pdf.exclude.key.the.image" value="Image5"/> ... </jasperReport> |
||||
|
|
||||
| API: | PROPERTY_EXCLUDED_KEY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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, xlsx, 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. |
||||
|
|
||||
| API: | PROPERTY_EXCLUDE_ORIGIN_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.3 | |||
|
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, xlsx, 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. |
||||
|
|
||||
| API: | KEEP_FIRST_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.3 | |||
|
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. | ||||
|
|
||||
| API: | PROPERTY_CHARACTER_ENCODING
|
|||
| Default: | UTF-8 | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.configuration.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. |
||||
|
|
||||
| API: | PROPERTY_EXPORT_CONFIGURATION_OVERRIDE_REPORT_HINTS
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 5.5.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. | ||||
|
|
||||
| API: | PROPERTY_COLUMN_NAME
|
|||
| Default: | N/A | |||
| Scope: | Text Element | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.csv.column.names.{arbitrary_name} | ||||
|
Properties with 'net.sf.jasperreports.export.csv.column.names.' prefix contain a list of
comma-separated names of the columns used in the metadata-based CSV export.
Column names in this property are used as default list for the getColumnNames() CSV metadata export output setting. Note: For accurate results it's recommended that column names in the list to follow the same order as the original columns. |
||||
|
|
||||
| API: | PROPERTY_COLUMN_NAMES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Report | |||
| Since: | 4.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. |
||||
|
|
||||
| API: | PROPERTY_DATA
|
|||
| Default: | N/A | |||
| Scope: | Text Element | |||
| Since: | 4.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. | ||||
|
|
||||
| API: | PROPERTY_FIELD_DELIMITER
|
|||
| Default: | , | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.csv.field.enclosure | ||||
|
Property containing the character to enclose a field value on a record.
If a sequence of characters is set for this property, only the leading one will be taken into account. Regular white spaces are trimmed and will not be considered. Non-breaking spaces (such as   or ) will be taken into account. Its value is used as default for the getFieldEnclosure() CSV export configuration setting. When this property is set in the JRXML report, we have to ensure that characters representing XML entity references are XML-escaped, accordingly. For instance, use " instead of ", ' instead of ', etc: <property name="net.sf.jasperreports.export.csv.field.enclosure" value="""/> or <property name="net.sf.jasperreports.export.csv.field.enclosure" value="'"/> |
||||
|
|
||||
| API: | PROPERTY_FIELD_ENCLOSURE
|
|||
| Default: | " | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.2.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.csv.force.field.enclosure | ||||
| Property that enforces all exported field values to be enclosed within a pair of enclosure characters (usually a pair of quotes:""). Its value is used as default for the getForceFieldEnclosure() CSV export configuration flag. | ||||
|
|
||||
| API: | PROPERTY_FORCE_FIELD_ENCLOSURE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.2.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. |
||||
|
|
||||
| API: | PROPERTY_RECORD_DELIMITER
|
|||
| Default: | \n | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. | ||||
|
|
||||
| API: | PROPERTY_REPEAT_VALUE
|
|||
| Default: | false | |||
| Scope: | Text Element | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.csv.write.bom | ||||
|
Property that specifies whether a BOM character should be put at the beginning of the output.
Its value is used as default for the isWriteBOM() CSV export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_WRITE_BOM
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.1.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. |
||||
|
|
||||
| API: | PROPERTY_WRITE_HEADER
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.default.exclude | ||||
| Element level property that acts as default for net.sf.jasperreports.export.{format}.exclude properties. Setting this property to true will exclude the element from all export formats except the ones for which net.sf.jasperreports.export.{format}.exclude is explicitly set to false. | ||||
|
|
||||
| API: | PROPERTY_DEFAULT_EXCLUDE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.11.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.default.filter.factory | ||||
| A property that gives the generic default filter factory class name. | ||||
|
|
||||
| API: | PROPERTY_DEFAULT_FILTER_FACTORY
|
|||
| Default: | net.sf.jasperreports.engine.export.DefaultExporterFilterFactory | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.embed.fonts | ||||
|
This property indicates whether the embeddable true type fonts used in the report should be embedded into the generated DOCX document.
Its value is used as default for the isEmbedFonts() DOCX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_EMBED_FONTS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.9.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_FLEXIBLE_ROW_HEIGHT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_FRAMES_AS_NESTED_TABLES
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Frame Element | |||
| Since: | 3.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. | ||||
|
|
||||
| API: | PROPERTY_HIDDEN_TEXT
|
|||
| Default: | false | |||
| Scope: | Text Element | |||
| Since: | 3.7.6 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.ignore.hyperlink | ||||
| This property is used by the DOCX exporter to determine if a certain hyperlink should be activated or not. This flag can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_HYPERLINK
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Hyperlink | |||
| Since: | 5.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.metadata.application | ||||
|
Property that contains the application information to use for the generated DOCX metadata.
Its value is used as default for the getMetadataApplication() DOCX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_APPLICATION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.metadata.author | ||||
|
Property that contains the author information to use for the generated DOCX metadata.
Its value is used as default for the getMetadataAutor() DOCX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_AUTHOR
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.metadata.keywords | ||||
|
Property that contains the keywords to use for the generated DOCX metadata.
Its value is used as default for the getMetadataKeywords() DOCX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_KEYWORDS
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.metadata.subject | ||||
|
Property that contains the subject information to use for the generated DOCX metadata.
Its value is used as default for the getMetadataSubject() DOCX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_SUBJECT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.metadata.title | ||||
|
Property that contains the title information to use for the generated DOCX metadata.
Its value is used as default for the getMetadataTitle() DOCX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_TITLE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.docx.new.line.as.paragraph | ||||
|
This property specifies whether the newline element present in a justified paragraph introduces a new justified paragraph.
If set to true, the text line before the new paragraph will lose the justified alignment.
It serves as default value for the isNewLineAsParagraph() DOCX export configuration setting. The property itself defaults to false (for backward compatibility reasons). |
||||
|
|
||||
| API: | PROPERTY_NEW_LINE_AS_PARAGRAPH
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Text Element | |||
| Since: | 6.1.1 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_EXPORTER_FILTER_FACTORY_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.flash.element.allow.script.access | ||||
| Property that determines the value of the allowScriptAccess parameter for Flash elements. | ||||
|
|
||||
| API: | PROPERTY_ALLOW_SCRIPT_ACCESS
|
|||
| Default: | sameDomain | |||
| Scope: | Global | Context | Report | Generic Element | |||
| Since: | 4.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. |
||||
|
|
||||
| API: | MINIMIZE_PRINTER_JOB_SIZE
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | |||
| Since: | 1.2.8 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.graphics2d.white.page.background | ||||
|
Property that that determines whether the Graphics2D exporter is to draw white backgrounds for exported pages.
Its value is used as default for the isWhitePageBackground() Graphics2D export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_WHITE_PAGE_BACKGROUND
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.5.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_ACCESSIBLE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_BETWEEN_PAGES_HTML
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.html.border.collapse | ||||
Configuration property that provides the value for the border-collapse CSS property to be applied
to the table generated for the report. Possible values are:
|
||||
|
|
||||
| API: | PROPERTY_BORDER_COLLAPSE
|
|||
| Default: | collapse | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.html.class | ||||
| Property used to specify the value of the CSS class attribute of elements when exported to HTML format. The value of this property will be used as the value for the class attribute of the <td> tag for the element when exported to HTML. | ||||
|
|
||||
| API: | PROPERTY_HTML_CLASS
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.html.convert.svg.to.image | ||||
| This property specifies whether the SVG graphics should be rasterized as images. The property provides a default value for the isConvertSvgToImage() export setting. | ||||
|
|
||||
| API: | PROPERTY_CONVERT_SVG_TO_IMAGE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Image Element | Chart | Component | |||
| Since: | 6.3.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.html.embed.image | ||||
| This property specifies whether the image should be Base64 encoded and embedded into the src attribute of the image tag, and not referenced as separate resource. The property provides a default value for the isEmbedImage() export setting. | ||||
|
|
||||
| API: | PROPERTY_EMBED_IMAGE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Image Element | |||
| Since: | 6.2.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.html.embedded.svg.use.fonts | ||||
| This property specifies whether the HTML embedded SVG should have the font family names replaced with the web fonts coming from font extensions, similar to what we do for text elements. | ||||
|
|
||||
| API: | PROPERTY_EMBEDDED_SVG_USE_FONTS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Image Element | |||
| Since: | 6.2.2 | |||
|
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. | ||||
|
|
||||
| API: | PROPERTY_FLUSH_OUTPUT
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_HTML_FOOTER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.2 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_HTML_HEADER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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 format. The value of this property will be used as the value for the id attribute of the <td> tag for the element when exported to HTML. | ||||
|
|
||||
| API: | PROPERTY_HTML_ID
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.7.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.html.ignore.hyperlink | ||||
| This property is used by the HTML exporter to determine if a certain hyperlink should be activated or not. This flag can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_HYPERLINK
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Hyperlink | |||
| Since: | 5.1.2 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_SIZE_UNIT
|
|||
| Default: | px | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.html.use.background.image.to.align | ||||
|
Property that indicates whether the images should be rendered using CSS background images, to achieve certain image alignment requirements, especially in the case of lazy images,
for which the real dimensions are not known at report fill time.
Its value is used as default for the isUseBackgroundImageToAlign() HTML export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_USE_BACKGROUND_IMAGE_TO_ALIGN
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Image Element | |||
| Since: | 6.8.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_WHITE_PAGE_BACKGROUND
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_WRAP_BREAK_WORD
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_IGNORE_PAGE_MARGINS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.5 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.boolean.{path} | ||||
| This element-level property is considered by the JsonMetadataExporter and provides the exported value of a boolean type for that element. This value will be exported within the JSON tree following the path specified by the property suffix. | ||||
|
|
||||
| API: | JSON_EXPORTER_BOOLEAN_PROPERTIES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.data | ||||
|
This element-level property is considered by the JsonMetadataExporter
and provides the exported value for that element. By default is considered the value of the report element itself.
When working with this property, numbers have to be written with no thousand separators and using a period as decimal. For instance, 1,000,000 should be written as "1000000" and 2,000.45 should be written as "2000.45". Dates must be written according to ISO 8601 standard: "yyyy-MM-dd'T'HH:mm:ss". |
||||
|
|
||||
| API: | JSON_EXPORTER_DATA_PROPERTY
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.date.{path} | ||||
|
This element-level property is considered by the JsonMetadataExporter
and provides the exported value of a date type for that element. This value will be exported within the JSON tree following the path specified
by the property suffix.
When working with this property, dates must be written according to ISO 8601 standard: "yyyy-MM-dd'T'HH:mm:ss". |
||||
|
|
||||
| API: | JSON_EXPORTER_DATE_PROPERTIES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.escape.members | ||||
| This report-level flag is considered by the JsonMetadataExporter and specifies if the member property names should be enclosed with quotes or no. | ||||
|
|
||||
| API: | JSON_EXPORTER_ESCAPE_MEMBERS
|
|||
| Default: | true | |||
| Scope: | Report | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.number.{path} | ||||
|
This element-level property is considered by the JsonMetadataExporter
and provides the exported value of a numeric type for that element. This value will be exported within the JSON tree following the path specified
by the property suffix.
When working with this property, numbers have to be written with no thousand separators and using a period as decimal. For instance, 1,000,000 should be written as "1000000" and 2,000.45 should be written as "2000.45". |
||||
|
|
||||
| API: | JSON_EXPORTER_NUMBER_PROPERTIES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.path | ||||
| This element-level property is used by the JsonMetadataExporter and specifies a given path within the JSON tree, where the current element will be exported. If the net.sf.jasperreports.export.json.schema property is not present in the report, this property can be used to determine a rule in the JSON schema as well. | ||||
|
|
||||
| API: | JSON_EXPORTER_PATH_PROPERTY
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.repeat.{path} | ||||
| This element-level flag is considered by the JsonMetadataExporter and specifies whether the value associated to that JSON path should be repeated or not when it is missing. Usually this property works in conjunction with one of the net.sf.jasperreports.export.json.{type}.{path} properties. | ||||
|
|
||||
| API: | JSON_EXPORTER_REPEAT_PROPERTIES_PREFIX
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 6.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.repeat.value | ||||
| This element-level flag is considered by the JsonMetadataExporter and specifies whether the value associated to the JSON path specified by net.sf.jasperreports.export.json.path property should be repeated or not when it is missing. | ||||
|
|
||||
| API: | JSON_EXPORTER_REPEAT_VALUE_PROPERTY
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.schema | ||||
This report-level property is considered by the JsonMetadataExporter
and specifies the path to a JSON schema file that will be used to generate the JSON structure at export time. Nodes in a given schema should provide:
|
||||
|
|
||||
| API: | JSON_EXPORTER_JSON_SCHEMA
|
|||
| Default: | N/A | |||
| Scope: | Report | |||
| Since: | 6.0.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.json.string.{path} | ||||
| This element-level property is considered by the JsonMetadataExporter and provides the exported value of a String type for that element. This value will be exported within the JSON tree following the path specified by the property suffix. | ||||
|
|
||||
| API: | JSON_EXPORTER_STRING_PROPERTIES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.1.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.matcher.filter.key | ||||
| Property that specifies a key for the element, in order to make it eligible for the exporter filter during the report export. | ||||
|
|
||||
| API: | PROPERTY_MATCHER_EXPORT_FILTER_KEY
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 5.5.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_ODS_FLEXIBLE_ROW_HEIGHT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_ODT_FLEXIBLE_ROW_HEIGHT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.odt.ignore.hyperlink | ||||
| This property is used by the ODT exporter to determine if a certain hyperlink should be activated or not. This flag can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_HYPERLINK
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Hyperlink | |||
| Since: | 5.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.parameters.override.report.hints | ||||
| Deprecated. Replaced by net.sf.jasperreports.export.configuration.override.report.hints. | ||||
|
|
||||
| API: | PROPERTY_EXPORT_PARAMETERS_OVERRIDE_REPORT_HINTS
|
|||
| Default: | true | |||
| Scope: | Global | Context | |||
| Since: | 2.0.2 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_128_BIT_KEY
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_COLLAPSE_MISSING_BOOKMARK_LEVELS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_COMPRESSED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_CREATE_BATCH_MODE_BOOKMARKS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_DISPLAY_METADATA_TITLE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_ENCRYPTED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.even.page.offset.x | ||||
|
Property that specifies the X offset (in pixels) for moving elements in even page number pages, to simulate gutter margins.
Its value is used as default for the getEvenPageOffsetX() PDF export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_EVEN_PAGE_OFFSET_X
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.even.page.offset.y | ||||
|
Property that specifies the Y offset (in pixels) for moving elements in even page number pages, to simulate gutter margins.
Its value is used as default for the getEvenPageOffsetY() PDF export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_EVEN_PAGE_OFFSET_Y
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.border.style | ||||
Property that specifies the PDF-compatible border style for input fields. Possible values are:
|
||||
|
|
||||
| API: | PDF_FIELD_BORDER_STYLE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.check.type | ||||
Property applicable to check input fields in a PDF form that specifies the check type decoration. Possible values are:
|
||||
|
|
||||
| API: | PDF_FIELD_CHECK_TYPE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.checked | ||||
| Flag property applicable for check input fields that specifies if the input field is checked. | ||||
|
|
||||
| API: | PDF_FIELD_CHECKED
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.choice.separators | ||||
| Specifies the set of characters used as choices separator in the choices list. See net.sf.jasperreports.export.pdf.field.choices property. | ||||
|
|
||||
| API: | PDF_FIELD_CHOICE_SEPARATORS
|
|||
| Default: | | | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.choices | ||||
|
Specifies the list of choices for an input field such as list or combobox. Choices in the list are delimited by a set of separator characters provided
by the net.sf.jasperreports.export.pdf.field.choice.separators property.
If no net.sf.jasperreports.export.pdf.field.choice.separators property is set, the default choices separator is "|".
Example: 'One'|'Two'|'Three' |
||||
|
|
||||
| API: | PDF_FIELD_CHOICES
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.combo.edit | ||||
| Flag property applicable for combobox input fields that specifies if the combobox field is editable. By default the combobox is not editable. | ||||
|
|
||||
| API: | PDF_FIELD_COMBO_EDIT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.name | ||||
| Property that specifies the field name, which serves as unique identifier within the PDF form. If not specified, the field name is generated using the report element UUID. | ||||
|
|
||||
| API: | PDF_FIELD_NAME
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.read.only | ||||
| Flag property that specifies if the input field is read-only. As a known limitation, this property is not applicable for radio group fields. | ||||
|
|
||||
| API: | PDF_FIELD_READ_ONLY
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.text.multiline | ||||
| Flag property applicable for input text fields that specifies if the input text is also multiline. | ||||
|
|
||||
| API: | PDF_FIELD_TEXT_MULTILINE
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.type | ||||
Property that specifies the input field type in PDF forms. Possible values are:
|
||||
|
|
||||
| API: | PDF_FIELD_TYPE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.field.value | ||||
| Property that specifies the initial text content for the text field or the initial selected value in list or combobox field, depending on the PDF form field type of the element. When this property is missing, the actual text content of the text element is used. | ||||
|
|
||||
| API: | PDF_FIELD_VALUE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.12.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.font.{arbitrary_name} | ||||
| Prefix of properties that specify font files for the PDF exporter. | ||||
|
|
||||
| API: | PDF_FONT_FILES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | |||
| Since: | 1.0.0 | |||
|
|
||||
| NOTE: Properties with this prefix are not read from the configuration context. This FAQ shows the additional steps to follow in order to set them dynamically. | ||||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.fontdir.{arbitrary_name} | ||||
| Prefix of properties that specify font directories for the PDF exporter. | ||||
|
|
||||
| API: | PDF_FONT_DIRS_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Global | |||
| Since: | 1.0.0 | |||
|
|
||||
| NOTE: Properties with this prefix are not read from the configuration context. This FAQ shows the additional steps to follow in order to set them dynamically. | ||||
|
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. |
||||
|
|
||||
| API: | PROPERTY_FORCE_LINEBREAK_POLICY
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_FORCE_SVG_SHAPES
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.ignore.hyperlink | ||||
| This property is used by the PDF exporter to determine if a certain hyperlink should be activated or not. This flag can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_HYPERLINK
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Hyperlink | |||
| Since: | 5.1.2 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_PDF_JAVASCRIPT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.justified.letter.spacing | ||||
| Property that determines whether justified text alignment can modify letter spacing in words. Default value is false. | ||||
|
|
||||
| API: | PROPERTY_JUSTIFIED_LETTER_SPACING
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.2.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_METADATA_AUTHOR
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_METADATA_CREATOR
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_METADATA_KEYWORDS
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_METADATA_SUBJECT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_METADATA_TITLE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.5.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.odd.page.offset.x | ||||
|
Property that specifies the X offset (in pixels) for moving elements in odd page number pages, to simulate gutter margins.
Its value is used as default for the getOddPageOffsetX() PDF export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_ODD_PAGE_OFFSET_X
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.4 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.odd.page.offset.y | ||||
|
Property that specifies the Y offset (in pixels) for moving elements in odd page number pages, to simulate gutter margins.
Its value is used as default for the getOddPageOffsetY() PDF export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_ODD_PAGE_OFFSET_Y
|
|||
| Default: | 0 | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.4 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_OWNER_PASSWORD
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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:
Its value is used as default for the getAllowedPermissions() PDF export configuration setting. By default no user permissions are allowed at all. |
||||
|
|
||||
| API: | PROPERTY_PERMISSIONS_ALLOWED
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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:
Its value is used as default for the getDeniedPermissions() PDF export configuration setting. By default there are no user permissions allowed for the document. |
||||
|
|
||||
| API: | PROPERTY_PERMISSIONS_DENIED
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_PRINT_SCALING
|
|||
| Default: | default | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. | ||||
|
|
||||
| API: | PROPERTY_SIZE_PAGE_TO_CONTENT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 4.7.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.colspan | ||||
| Property used to associate a PDF COLSPAN tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_COLSPAN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.h1 | ||||
| Property used to associate a PDF H1 tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_H1
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.h2 | ||||
| Property used to associate a PDF H2 tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_H2
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.h3 | ||||
| Property used to associate a PDF H3 tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_H3
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.h4 | ||||
| Property used to associate a PDF H4 tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_H4
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.h5 | ||||
| Property used to associate a PDF H5 tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_H5
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.h6 | ||||
| Property used to associate a PDF H6 tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_H6
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.l | ||||
| Property used to associate a PDF L tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_L
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.2.0 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_TAG_LANGUAGE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.li | ||||
| Property used to associate a PDF LI tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_LI
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 6.2.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.rowspan | ||||
| Property used to associate a PDF ROWSPAN tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_ROWSPAN
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.table | ||||
| Property used to associate a PDF TABLE tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_TABLE
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.td | ||||
| Property used to associate a PDF TD tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_TD
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.th | ||||
| Property used to associate a PDF TH tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_TH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdf.tag.tr | ||||
| Property used to associate a PDF TR tag with this element. | ||||
|
|
||||
| API: | PROPERTY_TAG_TR
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_TAGGED
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_USER_PASSWORD
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. |
||||
|
|
||||
| API: | PROPERTY_PDF_VERSION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.0.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdfa.conformance | ||||
|
Property whose value is used as default for the getPdfaConformance()
export configuration setting. It specifies the conformance level of the PDF/A document. Possible values are: pdfa1a, pdfa1b and none.
By default, this property is set to none. |
||||
|
|
||||
| API: | PROPERTY_PDFA_CONFORMANCE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pdfa.icc.profile.path | ||||
| Property whose value is used as default for the getIccProfilePath() export configuration setting. It specifies the path to the ICC profile file for the PDF/A compliant documents. | ||||
|
|
||||
| API: | PROPERTY_PDFA_ICC_PROFILE_PATH
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.background.as.slide.master | ||||
|
Property that specifies whether the elements from the background section on the first page should be exported as the contents of the slide master,
and then ignoring the background section elements for all pages/slides.
Its value is used as default for the isBackgroundAsSlideMaster() PPTX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_BACKGROUND_AS_SLIDE_MASTER
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.embed.fonts | ||||
|
This property indicates whether the fonts used in the report should be embedded into the generated PPTX document.
Note: PowerPoint does not embed TTF content type. Only EOT (Embedded OpenType) fonts are considered for embedding. Embeddable TTF fonts should be converted into EOT format first, then placed in the classpath using the font extension mechanism. Its value is used as default for the isEmbedFonts() PPTX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_EMBED_FONTS
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.9.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.field.type | ||||
Property that specifies the field type associated with this element in the PPTX export.
When this property is set, the element value will be automatically updated when the presentation is open.
The result displayed in the field depends on the report locale.
|
||||
|
|
||||
| API: | PROPERTY_FIELD_TYPE
|
|||
| Default: | N/A | |||
| Scope: | Text Element | |||
| Since: | 6.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.hide.slide.master.pages | ||||
| Property specifying the pages and/or page ranges for which the contents of the slide master should be hidden on. The value of the property should be a comma separated list of page numbers or page ranges. Page ranges are made of page numbers separated by a hyphen-minus character. For example: 1, 3-5, 7 | ||||
|
|
||||
| API: | PROPERTY_HIDE_SLIDE_MASTER_PAGES
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.ignore.hyperlink | ||||
| This property is used by the PPTX exporter to determine if a certain hyperlink should be activated or not. This flag can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_HYPERLINK
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Hyperlink | |||
| Since: | 5.1.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.metadata.application | ||||
|
Property that contains the application information to use for the generated PPTX metadata.
Its value is used as default for the getMetadataApplication() PPTX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_APPLICATION
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.metadata.author | ||||
|
Property that contains the author information to use for the generated PPTX metadata.
Its value is used as default for the getMetadataAutor() PPTX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_AUTHOR
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.metadata.keywords | ||||
|
Property that contains the keywords to use for the generated PPTX metadata.
Its value is used as default for the getMetadataKeywords() PPTX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_KEYWORDS
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.metadata.subject | ||||
|
Property that contains the subject information to use for the generated PPTX metadata.
Its value is used as default for the getMetadataSubject() PPTX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_SUBJECT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.metadata.title | ||||
|
Property that contains the title information to use for the generated PPTX metadata.
Its value is used as default for the getMetadataTitle() PPTX export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_METADATA_TITLE
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.3.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.slide.master.page | ||||
| Property that specifies the page number from which the slide master content is coming from. The default is 1, meaning the first page. | ||||
|
|
||||
| API: | PROPERTY_SLIDE_MASTER_PAGE
|
|||
| Default: | 1 | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.slide.master.report | ||||
| Property that specifies from which report is the page providing slide master content coming from, in a multi-report batch export. The default is 1, meaning the first report. | ||||
|
|
||||
| API: | PROPERTY_SLIDE_MASTER_REPORT
|
|||
| Default: | 1 | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.pptx.to.slide.master | ||||
| Property that specifies whether the element, when found on the first page, should be exported as the contents of the slide master, and then ignored for all pages/slides. | ||||
|
|
||||
| API: | PROPERTY_TO_SLIDE_MASTER
|
|||
| Default: | false | |||
| Scope: | Text Element | |||
| Since: | 6.8.0 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.rtf.ignore.hyperlink | ||||
| This property is used by the RTF exporter to determine if a certain hyperlink should be activated or not. This flag can be controlled at hyperlink declaration level by using the hyperlink parameter with the same name. | ||||
|
|
||||
| API: | PROPERTY_IGNORE_HYPERLINK
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Hyperlink | |||
| Since: | 5.1.2 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_CHARACTER_HEIGHT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_CHARACTER_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_LINE_SEPARATOR
|
|||
| Default: | the value of the "line.separator" system property | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_PAGE_HEIGHT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_PAGE_SEPARATOR
|
|||
| Default: | the duplicated value of the "line.separator" system property | |||
| Scope: | Global | Context | Report | |||
| Since: | 5.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. |
||||
|
|
||||
| API: | PROPERTY_PAGE_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.6.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.text.trim.line.right | ||||
|
Property that specifies whether the text lines in the document should be trimmed to the right.
Its value is used as default for the isTrimLineRight() export configuration setting. |
||||
|
|
||||
| API: | PROPERTY_TRIM_LINE_RIGHT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.0 | |||
|
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:
|
||||
|
|
||||
| API: | PROPERTY_AUTO_FILTER
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.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:
|
||||
|
|
||||
| API: | PROPERTY_AUTO_FIT_COLUMN
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 4.5.1 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.auto.fit.page.height | ||||
|
Flag property that provides a default value for the isAutoFitPageHeight() export setting.
If set to true, the exporter will automatically fit the print height of a sheet to the number of JasperPrint pages exported in that sheet
Allowed values are:
|
||||
|
|
||||
| API: | PROPERTY_AUTO_FIT_PAGE_HEIGHT
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 6.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.auto.fit.row | ||||
|
Flag property that indicates whether Excel should autofit the current row height.
Allowed values are:
|
||||
|
|
||||
| API: | PROPERTY_AUTO_FIT_ROW
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 4.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. | ||||
|
|
||||
| API: | PROPERTY_BREAK_AFTER_ROW
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 3.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. | ||||
|
|
||||
| API: | PROPERTY_BREAK_BEFORE_ROW
|
|||
| Default: | false | |||
| Scope: | Element | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_CELL_HIDDEN
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_CELL_LOCKED
|
|||
| Default: | true | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 3.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. |
||||
|
|
||||
| API: | PROPERTY_COLLAPSE_ROW_SPAN
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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. | ||||
|
|
||||
| API: | PROPERTY_COLUMN_NAME
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.column.names.{arbitrary_name} | ||||
|
Properties with 'net.sf.jasperreports.export.xls.column.names.' prefix contain a list of 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. |
||||
|
|
||||
| API: | PROPERTY_COLUMN_NAMES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Report | |||
| Since: | 4.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 |
||||
|
|
||||
| API: | PROPERTY_COLUMN_WIDTH
|
|||
| Default: | N/A | |||
| Scope: | Element | |||
| Since: | 4.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:
|
||||
|
|
||||
| API: | PROPERTY_COLUMN_WIDTH_RATIO
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 4.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:
|
||||
|
|
||||
| API: | PROPERTY_CREATE_CUSTOM_PALETTE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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.
When working with this property, numbers have to be written with no thousand separators and using a period as decimal. For instance, 1,000,000 should be written as "1000000" and 2,000.45 should be written as "2000.45". Dates must be written according to ISO 8601 standard: "yyyy-MM-dd'T'HH:mm:ss". By default this value is represented by the value stored in the report element this property is assigned to. |
||||
|
|
||||
| API: | PROPERTY_DATA
|
|||
| Default: | N/A | |||
| Scope: | Text Element | |||
| Since: | 4.0.2 | |||
|
top |
||||
|
|
||||
| net.sf.jasperreports.export.xls.defined.names.{arbitrary_name} | ||||
|
Property prefix used to identify a set of properties that store defined names for the generated Excel workbook.
Defined names in these properties are used as default for the getDefinedNames() Excel export configuration setting. Each property suffix (the {arbitrary_name} part) serves as name identifier and should be in accordance with the following rules (see Rules for Excel defined names):
The name test_sum_all is visible in the entire workbook and refers to the test_sum_1 name defined for Sheet_1. Note: Names that reference other names with limited visibility/scope (like the above test_sum_all) are NOT supported for the XLS (Excel 2003) export format. They work only in the XLSX (Excel 2007 or newer) exporter. A good practice would be to use only names visible in the entire workbook when exporting to XLS. |
||||
|
|
||||
| API: | PROPERTY_DEFINED_NAMES_PREFIX
|
|||
| Default: | N/A | |||
| Scope: | Report | Element | |||
| Since: | 6.4.3 | |||
|
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. |
||||
|
|
||||
| API: | PROPERTY_DETECT_CELL_TYPE
|
|||
| Default: | false | |||
| Scope: | Global | Context | Report | |||
| Since: | 2.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 overridden by report level settings; report level settings are overridden by element (sheet) level settings. |
||||
|
|
||||
| API: | PROPERTY_FIRST_PAGE_NUMBER
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | Element | |||
| Since: | 4.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. |
||||
|
|
||||
| API: | PROPERTY_FIT_HEIGHT
|
|||
| Default: | N/A | |||
| Scope: | Global | Context | Report | |||
| Since: | 3.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.