Crosstab

The properties of a crosstab are:

Property Name Description
General
Class Type Indicates the class type of the object. This property is read only.
Data Inherit Indicates whether the dataset for this object is inherited from another object. This property is read only.
Dataset Indicates the dataset used by the object. This property is read only.
Geometry
Height Displays the height of the object, in inches or centimeters. This property is read only.
Width Displays the width of the object, in inches or centimeters. This property is read only.
X Specifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position in inches or centimeters.

Data type: Float

Y Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Enter a numeric value to change the position in inches or centimeters.

Data type: Float

Color
Background Specifies the background color of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (e.g. 0xff0000) or choose a formula that returns a color.

Data type: String

CSS
Class Specifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

Style The property can be used in two ways.
  • Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the report level and when there are styles in the Style Group that can be applied to the object, or type in the style name.
  • Specifies a CSS selector to be applied to the object. Enter a valid class name from the CSS file.

Data type: String

Others
Cache Specifies whether to cache the dataset for this object in the data buffer so other objects which use the same dataset can share the data rather than perform their own SQL query.

Data type: Boolean

Current Column Block Index Specifies the horizontal index of the data block that will be displayed. 0 means the first block index, and 1 the second, and so on.

The four properties work together to control the data of the crosstab to be displayed in continuous page mode: Current Row Block Index, Current Column Block Index, Items per Row Block, and Items per Column Block.

Data type: Integer

Current Row Block Index Specifies the vertical index of the data block that will be displayed. 0 means the first block index, and 1 the second, and so on.

The four properties work together to control the data of the crosstab to be displayed in continuous page mode: Current Row Block Index, Current Column Block Index, Items per Row Block, and Items per Column Block.

Data type: Integer

Export to CSV Specifies whether to include the object when exporting the report to CSV.

Data type: Boolean

Export to DHTML Specifies whether to include the object when exporting the report to DHTML.

Data type: Boolean

Export to Excel Specifies whether to include the object when exporting the report to Excel.

Data type: Boolean

Export to PDF Specifies whether to include the object when exporting the report to PDF. This property is available only when a web control has been inserted into the object.

Data type: Boolean

Invisible Specifies whether to show the object in the design area and in the report results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

Items per Column Block Specifies the number of columns of records in each data block.

The four properties work together to control the data of the crosstab to be displayed in continuous page mode: Current Row Block Index, Current Column Block Index, Items per Row Block, and Items per Column Block.

Data type: Integer

Items per Row Block Specifies the number of rows of records in each data block.

The four properties work together to control the data of the crosstab to be displayed in continuous page mode: Current Row Block Index, Current Column Block Index, Items per Row Block, and Items per Column Block.

Data type: Integer

Position Specifies the position of the object. Choose an option from the drop-down list.
  • static - The object is positioned at the location in which it is inserted. The X and Y properties are ignored. The position of the object is affected by preceding objects in the same container.
  • absolute - The object will be located at the position specified by dragging and dropping or by setting its X and Y property values. The position of the object is not affected by preceding objects in the same container.

Data type: Enumeration

Note: This property only affects objects with a parent container that is the report body, a tabular cell, or a text box.

Record Location Specifies the calculation point for the properties which use formulas. Choose an option from the drop-down list.
  • default - The values of the properties are calculated in the default location where they are located.
  • Page Header - The values of the properties are calculated in the page header.
  • Page Footer - The values of the properties are calculated in the page footer.

Data type: Enumeration

Suppress Specifies whether to show the object in the report results. All formulas and calculations will be skipped if the property is set to true.

Data type: Boolean

Suppress When Empty Specifies whether to display the object in the report results when no record is returned to it.

Data type: Boolean

Suppress When No Records Specifies whether to display the object in the report results when no record is returned to its parent data container.

Data type: Boolean

Excel
Column Index Specifies the X coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report level must be set to true for this property to take effect.

Data type: Integer

Row Index Specifies the Y coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report level must be set to true for this property to take effect.

Data type: Integer

Border
Border Color Specifies the color of the border of the object. Choose a color from the drop-down list, enter a hexadecimal RGB value (0xCCAA00) or choose a formula that returns a color.

Data type: String

Has Border Specifies whether to show the cell borders.

Data type: Boolean

Crosstab Property
Avoid Orphan Header Specifies whether to make the column header be together with the data.

Sometimes the column header happens to be at the bottom of a page. To keep the column header together with the data in the next page, set this property to true.

Data type: Boolean

Block Gap Specifies the space between each part if the crosstab is split into more than one part.

Data type: Float

Boundary Value Specifies the number of aggregate fields to be displayed in one column when displayed vertically, or in one row when displayed horizontally. The left fields will be word-wrapped.

Data type: Integer

Column Total on Left Specifies whether to display the Total column in the first column in the crosstab.

Data type: Boolean

Expand Data Specifies whether to enable JReport Web users to expand or collapse dimensions in the crosstab.

Data type: Boolean

Horizontal Gap Specifies the space between the left/right edge of a crosstab cell and the contents in it.

Data type: Float

Outside Aggregate Title Specifies whether to place the titles of aggregate fields outside.

Data type: Boolean

Repeat Aggregate Specifies whether to repeat the crosstab for different aggregate fields.

Data type: Boolean

Repeat Column Header Specifies whether to repeat column headings on every page.

Data type: Boolean

Row Total on Top Specifies whether to display the Total row in the first row of the crosstab.

Data type: Boolean

Suppress Column Header Specifies whether to suppress the column header in view mode.

Data type: Boolean

Suppress Row Header Specifies whether to suppress the row header in view mode.

Data type: Boolean

Use Table Style Specifies whether to add headers to the Total row and column.

Data type: Boolean

Vertical Gap Specifies the space between the top/bottom edge of a crosstab cell and the contents in it.

Data type: Float

Vertical Layout Indicates whether the aggregate fields are displayed vertically. The property is read only.
TOC
Anchor Display Value Specifies the text for the TOC entry for this object in the TOC browser. By default the text is the unique object name assigned by JReport Designer. The TOC Anchor property must be set to true for this property to take effect.

Data type: String

TOC Anchor Specifies whether to include the object in the TOC browser for the report.

Data type: Boolean

Accessibility
External CSS Class Selector Specifies a class selector to be applied to the object when exported as HTML. Enter a valid class name from the CSS file.

Data type: String

External ID It is mapped to the HTML attribute id. This attribute specifies a name to the object, which must be unique in the report.

Data type: String

External Style It is mapped to the HTML attribute style. This attribute specifies style information for the object.

Data type: String

Language It is mapped to the HTML attribute lang. This attribute specifies the base language of the object's attribute values and text content.

Data type: String

Summary It is mapped to the HTML attribute summary. This attribute provides a summary of the object's purpose and structure.

Data type: String

A crosstab has some child objects, the properties of which will be shown in the following topics: