Skip to main content
Pentaho Documentation

Attributes reference

Parent aricle

You can click on any element, and the composition of the Attributes pane will adjust to show the ways it can be customized. Not all properties will apply to every attribute.

NoteYou cannot edit any Style or Attributes options for any selected report elements in the workspace while the Data tab has focus. Click the Structure tab to see the Style and Attributes panes for selected elements.

All of the items in the Attributes pane are described in the following reference:

Barcode

The following attributes belong to the barcode property:

Attribute NamePurposeValues
bar-heightSets the height of the bar code.Integer of any value.
bar-widthSets the width of the bar code.Integer of any value.
checksumShows the checksum value.Boolean; default is false.
typeSets the type of bar code.String; default is code128 (see Barbecue project documentation for details)
show-textDisplays text under the bar code.Boolean; default is false.

Common

The following attributes belong to the common property:

Attribute NamePurposeValues
typeDefines the type of element.Predefined and locked as an element type.
field-nameDefines the existing field to use.String; there is no default, you must define a value manually.
valueDefines a hard coded value instead of a field.String or integer; no default value.
group-fieldsDefines the field to group by.String or integer; no default value.
resource-valueA resource string found within the resource bundle.String; no default value.
resource-identifierDefines the file that contains resource strings.String; no default. This is a properties file, including the path.
nameThe name you want to assign to this element.String; no default value.
output-formatSets preferred output type for the report.String; no default value. Possible values are: html, pdf, xls, rtf, csv, xml.
lock-output-formatLocks the output type specified in the output-format attribute so that no other output type can be chosen.Boolean; default is false.
auto-submitIf selected, your parameterized reports will automatically update based on the current selection in your parameter lists. If un-checked, parameter selections will not automatically change the report data; report users will have to select a new parameter value and then click View Report to update the report.Boolean; default is false.
formatSets the Java format string.String; there is no default. Must be in the Java number or date format.
if-nullIf the defined field or value returns null, show the value defined here.Boolean; default value is false.
message-null-valueIf the message returns null, then return the value defined here.String; no default value.
arc-heightDefines the arc (corner) height of a rectangle.Integer; default value is 0.
arc-widthDefines the arc (corner) width of a rectangle.Integer; default value is 0.
data-cacheDetermines whether parameter result sets are cached, which would reduce the amount of reload time when switching parameters in a rendered report. This option can be further configured through the org.pentaho.reporting.engine.classic. core.cache.InMemoryCache.CachableRowLimit and org.pentaho.reporting.engine.classic. core.cache.InMemoryCache.MaxEntries engine settings.Boolean; default is True (cache is turned on).

Table of contents

The following attributes belong to the table-of-contents property:

Attribute NamePurpose Values
group-fieldsDefines both the depth of the data-collection and the fields from which to read the group-value-X values.If the group-field given in the array is empty, the field value will be read from the current relational group and in the details-processing, the value will be null. If the group-fields list is empty, an automatic mode is activated that collects all groups extracting the group-value from the relational group.
title-fieldDefines a field in the master-report that will be read for a valid item-titleAny column field or function
title-formulaDefines a formula that is evaluated when a new item has been collected. The formula will only be evaluated if the title-field is not set.Formula
collect-detailsDefines, whether detail items should be included in the data-collection.Boolean; default is false.

This attribute consumes a significant amount of system memory. Do not use this attribute on reports that are over a million rows.

index-separatorDefines the separator text that is used between the index-elements.String; default is comma (,).

Index

The following attributes belong to the index property:

Attribute NamePurpose Values
data-fieldDefines the field to be used as the item-data or item-key.Any column field or function
data-formulaDefines an open formula to be used as the item-data or item-key.Formula

Make sure that data-field is not defined, if this attribute is used.

index-separatorDefines the separator text that is used between page numbers in the item-pages field in the index sub report. It defaults to ",".String; default is comma (,).
condensed-styleDefines whether or not a dash (-) is used between continuous page numbers; for example, 4,5,6,7 display as 4-7.Boolean; default is false.

Excel

The following attributes belong to the excel property:

Attribute NamePurposeValues
formulaConverts an entered value or formula into a Excel numeric value.String; no default value.
page-header-textAppends text into Excel page header.String; no default value.
page-footer-textAppends text into Excel page footer.String; no default value.

HTML

The following attributes belong to the html property:

Attribute NamePurposeValues
append-headerInserts the HTML entered here into the <header> of the HTML output.String; no default value.
append-bodyInserts the HTML entered here into the <body> of the HTML output.String; no default value.
append-body-footerInserts the HTML entered here into the <footer> of the HTML output.String; no default value.
alt-nameDefines the text for the HTML <img> tag's alt attribute.String; no default value.

HTML-events

The following attributes belong to the html-events property:

Attribute NamePurposeValues
classDefines the value to insert into the HTML <class> tag.String; no default value.
nameDefines value for the name HTML object attribute.String; no default value.
titleDefines the value to insert into the HTML <title> tag.String; no default value.
xml-idDefines value to insert into the HTML <xml-id> tag.String; no default value.
on-clickDefines value for the onclick HTML DOM event object property.String; no default value.
double-clickDefines value for the doubleclick HTML DOM event object property.String; no default value.
on-mouse-downDefines value for the onmousedown HTML DOM event object property.String; no default value.
on-mouse-upDefines value for the onmouseup HTML DOM event object property.String; no default value.
on-mouse-moveDefines value for the onmousemove HTML DOM event object property.String; no default value.
on-mouse-overDefines value for the onmouseover HTML DOM event object property.String; no default value.
on-key-downDefines value for the onkeydown HTML DOM event object property.String; no default value.
on-key-pressedDefines value for the onkeypress HTML DOM event object property.String; no default value.
on-key-upDefines value for the onkeyup HTML DOM event object property.String; no default value.

Images

The following attributes belong to the images property:

Attribute NamePurposeValues
image-encode-qualityControls the JPEG encoding qualityA decimal percentage value between 0 and 1. The closer to 1, the higher the quality and larger the file size.
image-encode-typeDetermines the image format of PDF and HTML graphics.Possible values are: .jpg and .png. Default is .png.

PDF

The following attributes belong to the pdf property:

Attribute NamePurposeValues
scriptReferences a script name inside the PDF.String; no default value.

Pentaho

The following attributes belong to the pentaho property:

NoteThis list is incomplete.
Attribute NamePurposeValues
report-cacheDetermines whether parameterized reports published to the Pentaho Server are cached on a per-session basis, which would reduce the amount of reload time when switching parameters in a rendered report.Boolean; default is True (cache is turned on).

Query

The following attributes belong to the query property:

Attribute NamePurposeValues
nameAssigns a name to the selected query. If you are using a JDBC Custom data source, you can type the entire query directly into the name field.String; no default value.
row-limitRow limit for the query.Integer; default value is -1, meaning there is no hard limit.
time-outTimeout limit for the query.Integer; default value is 0, meaning there is no timeout.
design-time-outTimeout limit when running from Report Designer.Integer; default value is 0, meaning there is no timeout.

Query-metadata

The following attributes belong to the query-metadata property:

Attribute NamePurposeValues
data-formatUse the number or date formatting from the Report Design Wizard or the data source.Boolean; default is true if you are using the wizard, false if you are not.
style-formatUse the style formatting from the Report Design Wizard or the data source.Boolean; default is true if you are using the wizard, false if you are not.

Parameter

The following attributes belong to the parameter property:

Attribute NameData TypeDefinition/Values
auto-submitBoolean

Determines whether the report uses the parameter interface in the Pentaho User Console (PUC) when it runs. The values are:

  • True

    When set to True, the report runs when any control is updated in the parameter interface.

  • False

    When set to False, the report does not run when a control is updated in the parameter interface. The report runs when you select the Update button.

  • undefined

    (Default). When set to undefined, the auto-submit checkbox displays in the parameter interface so you can control when you want to use the option. The initial state of the checkbox is determined by the auto-submit-default attribute.

auto-submit-defaultBoolean

Sets the state of the auto submit checkbox on the parameter interface. The values are:

  • True

    When set to True or undefined, the auto submit checkbox is enabled.

  • False

    (Default): When set to False, the auto submit check box is disabled.

  • undefined

    When set to True or undefined, the auto submit checkbox is enabled.

parameter-layoutSelection

Sets the parameter display in Pentaho User Console. The values are:

  • vertical

    The vertical value adds each selection control into separate rows (Default).

  • horizontal

    Thehorizontal value adds each selection control into the same row.

  • flow

    The flow value adds each selection control into the same row and wraps them when space is limited.

show-parameter-uiBoolean

Determines whether the parameter interface will display in Pentaho User Console. The values are:

  • True

    When set to True, the parameter interface displays.

  • False

    (Default). When set to False, the parameter interface does not display.

Sparkline

The following attributes belong to the sparkline property:

Attribute NamePurposeValues
spacingSets the spacing (in pixels) between bars for a bar sparkline.Integer; default is 0.
start-angleSets the start angle (in degrees) on a pie sparkline.Integer; possible values are from 1 to 360. Default is 1.
counter-clockwiseSets the plot direction on a pie sparkline.Boolean; default is false, which represents clockwise.
high-sliceSets the hexadecimal color for the high slice.String; there is no default, you must define it manually.
medium-sliceSets the hexadecimal color for the medium slice.String; there is no default, you must define it manually.
low-sliceSets the hexadecimal color for the low slice.String; there is no default, you must define it manually.

Survey-scale

The following attributes belong to the survey-scale property:

Attribute NamePurposeValues
highestSets the scale max value.Integer; default is 5.
lowestSets the scale min value.Integer; default is 1.
range-upperSets the bar plot max value.Integer; default is not defined.
range-lowerSets the bar plot min value.Integer; default is not defined.

Swing

The following attributes belong to the swing property:

Attribute NamePurposeValues
actionDefines the Java method.String; default is not defined.
tooltipDefines the content of the tooltip.String; default is not defined.

Wizard

The following attributes belong to the wizard property:

Attribute NamePurposeValues
wizard-enabledIf enabled, clears out all bands affected by the generated-content-marker attribute and starts from scratch.Boolean; default is true.
aggregation-groupDefines the group name to aggregate by.String; default is not defined.
aggregation-typeDefines the function to use to aggregate the field.String; default is not defined.
generated-content-markerMarks the band that you want to insert the wizard's generated content into.Boolean; default is false.
grid-colorDefines the hexadecimal border color of the selected element in the Details band.String; default is not defined.
grid-styleDefines the border style of the selected element in the Details band.String; default is not defined. Possible values are: solid, dashed, dot-dash, dot-dot-dash, dotted, double, hidden, none, groove, ridge, inset, outset.
grid-widthDefines the border width (in pixels) of the selected element in the Details band.Integer; default is not defined.
label-detail-headerDefines the Details band header.String; default is the selected field name.
only-show-changing-valueControls whether the field repeats in the Details band.Boolean; default is false.