Skip to main content

UDS Column Properties

  • Updated

BackPrevious Topic  Next TopicNext

UDS Column Properties

This topic describes the properties of a Column object in a user-defined data source.

Property NameDescription
General
ArraySpecifies whether the column is an array type.

Data type: Boolean

Auto Group IndexSpecifies the index of the automatic group. The start index is 0, and if do not group by this column automatically, the index is -1.

Data type: Integer

Column IndexSpecifies the column index in the result set.

Data type: Integer

Column Mapping IndexSpecifies the column index in the result set.

Data type: Integer

Column NameSpecifies the name of the column in the raw data source.

Data type: String

CurrencySpecifies whether to control the SQL type of the formulas and summaries which reference the column if the column is of the BigDecimal type.
  • true
    Select to apply the BigDecimal type to the formulas and summaries and set their SQL Type to 3.
  • false
    Select to apply the normal data type to the formulas and summaries.

Data type: Boolean

DescriptionSpecifies the description of the object.

Data type: String

Display WidthSpecifies 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.

LengthSpecifies the length for the values of the column, in bytes.

Data type: Integer

NameSpecifies the mapped name of the object in the catalog.

Data type: String

NullableSpecifies the nullability for the values of the object. Choose an option from the drop-down list.
  • true
    Select to indicate the object supports null values.
  • false
    Select to indicate the values of the object cannot be null.
  • unknown
    Select to indicate whether the values of the object can be null or not is unknown.

Data type: Enumeration

Number Base Specifies the number base of the column.

Data type: Integer

Path StringSpecifies the path of the column for identifying the column in tree.

Data type: String

PrecisionSpecifies 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

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

Data type: Integer

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

Data type: Integer

Text Format
Auto FitSpecifies whether to automatically adjust the width and height of the object according to its content.

Data type: Boolean

Auto Scale in NumberDesigner 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, Logi Report Engine 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, Logi Report Engine 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

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

Data type: Boolean

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

Data type: Enumeration

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

Data type: Integer

FormatSpecifies the format in which you want to display values of the object in the report. 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 AlignmentSpecifies the horizontal justification of the text in the object. Choose an option from the drop-down list.

Data type: Enumeration

ItalicSpecifies whether to italicize the text in the object.

Data type: Boolean

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

Data type: Boolean

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

Data type: Boolean

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

Data type: Enumeration

Padding
Bottom PaddingSpecifies 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 PaddingSpecifies 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 PaddingSpecifies 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 PaddingSpecifies 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
HeightSpecifies 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

WidthSpecifies 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
BackgroundSpecifies 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

ForegroundSpecifies 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 ColorSpecifies 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 ThicknessSpecifies the width for the border of the object. Type a numeric value to change the thickness.

Data type: Float

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

Data type: Enumeration

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

Data type: Enumeration

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

Data type: Enumeration

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

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 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 LineSpecifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration

Pattern
Pattern ColorSpecifies 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 StyleSpecifies 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 FileSpecifies the data mapping file you want to apply 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 locale part).

Data type: String

BackPrevious Topic  Next TopicNext

Related articles