Skip to main content

Summary Properties

  • Updated

BackPrevious Topic  Next TopicNext

Summary Properties

This topic lists the properties of a Summary object in a catalog.

Property NameDescription
General
DescriptionSpecifies the description of the summary.

Data type: String

Display WidthSpecifies the display width of the summary. Type a numeric value to change the width.

Data type: Float

Note icon

  • If the Display Width value of a summary is not set in the Catalog Manager, the summary will be inserted in a report with the default width defined by Logi Report.
  • Assume that you have set the Display Width of a summary, and used the summary while creating a new component with the report wizard, its width may be adjusted according to the paper size.
ExpressionDisplays the statement of the summary. This property is read only.
FunctionSpecifies the function of the summary.

Data type: String

Group By Specifies the criteria (break-by group) that the summary will be performed.

Data type: String

LengthSpecifies the length of the summary's value, in bytes.

Data type: Integer

NameSpecifies the name of the summary.

Data type: String

Number Base Specifies the number base of the summary.

Data type: Integer

PrecisionSpecifies the precision of the summary's value. The default value comes from data source metadata and it specifies the value's largest number of digits.

Data type: Integer

ScaleSpecifies the number of digits to the right of the decimal point for the summary's value.

Data type: Integer

Special FunctionIf the group-by field is of Numeric, String, Date or Time type, you can further define to calculate the summary by specifying a special function.

Data type: String

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

Data type: Integer

Summary On Specifies the field on which the summary performs.

Data type: String

Text Format
Auto Fit Specifies whether to adjust the width and height of the summary according to the contents.

Data type: Boolean

Auto Scale in NumberThe property is available when the summary is of the Number data type. It specifies whether to automatically scale the summary values that fall into the two ranges:
  • When 1000 <= value < 10^15, the following quantity unit symbols of the International System of Units are used 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, scientific notation is used to scale values.

The option "auto" means that the property setting follows that of the parent data container when the summary is added in a report.

Data type: Boolean

BoldSpecifies whether to make the text bold.

Data type: Boolean

Font FaceSpecifies the font of the text. Choose an option from the drop-down list.

Data type: Enumeration

Font SizeSpecifies the font size of the text. Type an integer value to change the size.

Data type: Integer

FormatSpecifies the display format of the summary's value. The format varies with the summary's data type and can be defined manually.

Data type: String

Horizontal AlignmentSpecifies the horizontal justification of the text in the summary. Choose an option from the drop-down list.

Data type: Enumeration

ItalicSpecifies whether to make the text italic.

Data type: Boolean

StrikethroughSpecifies whether to add a strikethrough line to the text.

Data type: Boolean

UnderlineSpecifies whether to underline the text.

Data type: Boolean

Vertical AlignmentSpecifies the vertical justification of the text in the summary. Choose an option from the drop-down list.

Data type: Enumeration

Word WrapSpecifies whether to wrap the text to the width.

Data type: Boolean

Padding
Bottom PaddingSpecifies the space between the text and the bottom border of the summary. Type a numeric value to change the padding.

Data type: Float

Left PaddingSpecifies the space between the text and the left border of the summary. Type a numeric value to change the padding.

Data type: Float

Right PaddingSpecifies the space between the text and the right border of the summary. Type a numeric value to change the padding.

Data type: Float

Top PaddingSpecifies the space between the text and the top border of the summary. Type a numeric value to change the padding.

Data type: Float

Geometry
HeightSpecifies the height of the summary, which takes effect when the summary is inserted into a report. Type a numeric value to change the height. The default is 0 which means a proper height will be specified to the summary by Logi Report automatically.

Data type: Float

WidthSpecifies the width of the summary, which takes effect when the summary is inserted into a report. Type a numeric value to change the width. The default is 0 which means a proper width will be specified to the summary by Logi Report automatically.

Data type: Float

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

Data type: String

ForegroundSpecifies the foreground color of the summary. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border
Border ColorSpecifies the color of the border of the summary. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border ThicknessSpecifies the width of the border. Type a numeric value to change the thickness.

Data type: Float

Bottom LineSpecifies the line style of the bottom border of the summary. Choose a style from the drop-down list.

Data type: Enumeration

Left LineSpecifies the line style of the left border of the summary. Choose a style from the drop-down list.

Data type: Enumeration

Right LineSpecifies the line style of the right border of the summary. Choose a style from the drop-down list.

Data type: Enumeration

ShadowSpecifies whether or not to draw two shadowed borders, beneath and to the right of the summary.

Data type: Boolean

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

Data type: String

Top LineSpecifies the line style of the top border of the summary. Choose a style from the drop-down list.

Data type: Enumeration

Pattern
Pattern ColorSpecifies the color with which to draw a pattern to fill the summary. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

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

Data type: Enumeration

Others
Data Mapping FileSpecifies the data mapping file to the object for NLS use.

For example, if the data mapping file name is Category_de_DE.properties, set the value as Category (without the language and locale part).

Data type: String

BackPrevious Topic  Next TopicNext