Summary Properties

Property Name	Description
General
Description	Specifies the description of the object. Data type: String
Display Width	Specifies the display width of the object, which takes effect when you insert the object into reports. Type a numeric value to change the width. If you do not set the display width, Designer applies a default width to it automatically. Data type: Float After you set the Display Width property of an object and use the object while creating a data component with wizard, Designer may adjust its width according to the paper size.
Expression	Shows the statement of the summary. Read only.
Function	Specifies the aggregate function of the summary. Data type: String
Group By	Specifies the group-by field (break-by group) on which to perform the summary. Data type: String
Length	Specifies the length for the values of the summary, in bytes. Data type: Integer
Name	Specifies the mapped name of the object in the catalog. Data type: String
Number Base	Specifies the number base of the summary. Data type: Integer
Precision	Specifies the precision for the values of the object. The default precision comes from data source metadata and defines the object's largest number of digits. The larger the precision is, the more memory it might take; however, the more accurate values you can get. Data type: Integer
Scale	Specifies the number of digits to the right of the decimal point for the values of the object. Data type: Integer
Special Function	Specifies the special function for the summary. Designer applies the special function when the group-by field of the summary is Numeric, String, Date, or Time data type. Data type: String
SQL Type	Specifies the SQL type of the object defined in Java. Choose an option from the drop-down list. Data type: Integer
Summary On	Specifies the field on which the summary is to compute. Data type: String
Text Format
Auto Fit	Specifies whether to automatically adjust the width and height of the object according to its content. Data type: Boolean
Auto Scale in Number	Designer displays this property when the object is Number data type. You can use it to specify whether to automatically scale values of the object that fall into the two ranges: When 1000 <= value < 10^15, Designer applies the following quantity unit symbols of the International System of Units to scale the values: K (10^3), M (10^6), G (10^9), and T (10^12). When 0 < value < 0.001 or value >= 10^15, Designer uses scientific notation to scale the values. The option "auto" means that the property setting follows that of the parent data component when you use the object in a report. Data type: Boolean
Bold	Specifies whether to apply bold formatting to the text in the object. Data type: Boolean
Font Face	Specifies the font face of the text in the object. Choose an option from the drop-down list. Data type: Enumeration
Font Size	Specifies the font size of the text in the object. Type an integer value to change the size. Data type: Integer
Format	Specifies the format in which you want to display values of the object in reports. Choose an option from the drop-down list or type the format by yourself. Data type: String If the object is BigDecimal data type, to avoid precision loss, you should specify a prefix JRD when setting the format.
Horizontal Alignment	Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list. Data type: Enumeration
Italic	Specifies whether to italicize the text in the object. Data type: Boolean
Strikethrough	Specifies whether to draw a line through the text in the object. Data type: Boolean
Underline	Specifies whether to add a horizontal line under the text in the object. Data type: Boolean
Vertical Alignment	Specifies the vertical justification of the text in the object. Choose an option from the drop-down list. Data type: Enumeration
Word Wrap	Specifies whether to wrap the text according to the width of the object. Data type: Boolean
Padding
Bottom Padding	Specifies the space between the content in the object and the bottom border of the object. Type a numeric value to change the padding. Data type: Float
Left Padding	Specifies the space between the content in the object and the left border of the object. Type a numeric value to change the padding. Data type: Float
Right Padding	Specifies the space between the content in the object and the right border of the object. Type a numeric value to change the padding. Data type: Float
Top Padding	Specifies the space between the content in the object and the top border of the object. Type a numeric value to change the padding. Data type: Float
Geometry
Height	Specifies the height of the object, which takes effect when you insert the object into reports. If you do not set the height, Designer assigns a proper height to the object automatically. Data type: Float
Width	Specifies the width of the object, which takes effect when you insert the object into reports. If you do not set the width, Designer assigns a proper width to the object automatically. Data type: Float
Color
Background	Specifies the background color of the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Foreground	Specifies the foreground color of the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Border
Border Color	Specifies the color for the border of the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Border Thickness	Specifies the width for the border of the object. Type a numeric value to change the thickness. Data type: Float
Bottom Line	Specifies the line style for the bottom border of the object. Choose an option from the drop-down list. Data type: Enumeration
Left Line	Specifies the line style for the left border of the object. Choose an option from the drop-down list. Data type: Enumeration
Right Line	Specifies the line style for the right border of the object. Choose an option from the drop-down list. Data type: Enumeration
Shadow	Specifies whether to add a drop shadow effect to the border. Data type: Boolean
Shadow Color	Specifies the color of the border shadow. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Top Line	Specifies the line style for the top border of the object. Choose an option from the drop-down list. Data type: Enumeration
Pattern
Pattern Color	Specifies the color in which to draw a pattern to fill the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String
Pattern Style	Specifies the style of the pattern. Choose an option from the drop-down list. none Select if you do not want to apply a pattern to the object. 50% Select to fill the object using 50%-transparency of the specified pattern color. horizontal Select to fill the object with horizontal lines using the specified pattern color. vertical Select to fill the object with vertical lines using the specified pattern color. grid Select to fill the object with grids using the specified pattern color. diagonal Select to fill the object with diagonal lines using the specified pattern color. Data type: String
Others
Data Mapping File	Specifies the data mapping file (without the locale part) you want to apply to the object for NLS use. For example, if the data mapping file is Product_de_DE.properties, type Product in the value cell. Data type: String

Property Name

Description

General

Description

Specifies the description of the object.

Data type: String

Display Width

Specifies the display width of the object, which takes effect when you insert the object into reports. Type a numeric value to change the width. If you do not set the display width, Designer applies a default width to it automatically.

Data type: Float

Note icon After you set the Display Width property of an object and use the object while creating a data component with wizard, Designer may adjust its width according to the paper size.

Expression

Shows the statement of the summary. Read only.

Function

Specifies the aggregate function of the summary.

Data type: String

Group By

Specifies the group-by field (break-by group) on which to perform the summary.

Data type: String

Length

Specifies the length for the values of the summary, in bytes.

Data type: Integer

Name

Specifies the mapped name of the object in the catalog.

Data type: String

Number Base

Specifies the number base of the summary.

Data type: Integer

Precision

Specifies the precision for the values of the object. The default precision comes from data source metadata and defines the object's largest number of digits. The larger the precision is, the more memory it might take; however, the more accurate values you can get.

Data type: Integer

Scale

Specifies the number of digits to the right of the decimal point for the values of the object.

Data type: Integer

Special Function

Specifies the special function for the summary. Designer applies the special function when the group-by field of the summary is Numeric, String, Date, or Time data type.

Data type: String

SQL Type

Specifies the SQL type of the object defined in Java. Choose an option from the drop-down list.

Data type: Integer

Summary On

Specifies the field on which the summary is to compute.

Data type: String

Text Format

Auto Fit

Specifies whether to automatically adjust the width and height of the object according to its content.

Data type: Boolean

Auto Scale in Number

Designer displays this property when the object is Number data type. You can use it to specify whether to automatically scale values of the object that fall into the two ranges:

When 1000 <= value < 10^15, Designer applies the following quantity unit symbols of the International System of Units to scale the values: K (10^3), M (10^6), G (10^9), and T (10^12).
When 0 < value < 0.001 or value >= 10^15, Designer uses scientific notation to scale the values.

The option "auto" means that the property setting follows that of the parent data component when you use the object in a report.

Data type: Boolean

Bold

Specifies whether to apply bold formatting to the text in the object.

Data type: Boolean

Font Face

Specifies the font face of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Font Size

Specifies the font size of the text in the object. Type an integer value to change the size.

Data type: Integer

Format

Specifies the format in which you want to display values of the object in reports. Choose an option from the drop-down list or type the format by yourself.

Data type: String

Note icon If the object is BigDecimal data type, to avoid precision loss, you should specify a prefix JRD when setting the format.

Horizontal Alignment

Specifies the horizontal justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Italic

Specifies whether to italicize the text in the object.

Data type: Boolean

Strikethrough

Specifies whether to draw a line through the text in the object.

Data type: Boolean

Underline

Specifies whether to add a horizontal line under the text in the object.

Data type: Boolean

Vertical Alignment

Specifies the vertical justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

Word Wrap

Specifies whether to wrap the text according to the width of the object.

Data type: Boolean

Padding

Bottom Padding

Specifies the space between the content in the object and the bottom border of the object. Type a numeric value to change the padding.

Data type: Float

Left Padding

Specifies the space between the content in the object and the left border of the object. Type a numeric value to change the padding.

Data type: Float

Right Padding

Specifies the space between the content in the object and the right border of the object. Type a numeric value to change the padding.

Data type: Float

Top Padding

Specifies the space between the content in the object and the top border of the object. Type a numeric value to change the padding.

Data type: Float

Geometry

Height

Specifies the height of the object, which takes effect when you insert the object into reports. If you do not set the height, Designer assigns a proper height to the object automatically.

Data type: Float

Width

Specifies the width of the object, which takes effect when you insert the object into reports. If you do not set the width, Designer assigns a proper width to the object automatically.

Data type: Float

Color

Background

Specifies the background color of the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Foreground

Specifies the foreground color of the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border

Border Color

Specifies the color for the border of the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border Thickness

Specifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float

Bottom Line

Specifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Left Line

Specifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Right Line

Specifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Shadow

Specifies whether to add a drop shadow effect to the border.

Data type: Boolean

Shadow Color

Specifies the color of the border shadow. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Top Line

Specifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Pattern

Pattern Color

Specifies the color in which to draw a pattern to fill the object. Choose a color from the drop-down list, or select Custom to customize a color in the Pick a Color dialog box. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Pattern Style

Specifies the style of the pattern. Choose an option from the drop-down list.

none
Select if you do not want to apply a pattern to the object.
50%
Select to fill the object using 50%-transparency of the specified pattern color.
horizontal
Select to fill the object with horizontal lines using the specified pattern color.
vertical
Select to fill the object with vertical lines using the specified pattern color.
grid
Select to fill the object with grids using the specified pattern color.
diagonal
Select to fill the object with diagonal lines using the specified pattern color.

Data type: String

Others

Data Mapping File

Specifies the data mapping file (without the locale part) you want to apply to the object for NLS use. For example, if the data mapping file is Product_de_DE.properties, type Product in the value cell.

Data type: String