Skip to main content

UDS Column Properties

  • Updated

BackPrevious Topic  Next TopicNext

UDS Column Properties

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

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

Data type: Boolean

Auto Group IndexSpecifies the index of automatic group. The start index is 0, and if do not group by this field 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 formulas or summaries in which the BigDecimal type fields are imported.
  • true - The formula or summary which is built with the BigDecimal type field will be BigDecimal type, and its SQL Type value will be set to 3.
  • false - The normal data type will be used for the formula or summary.

Data type: Boolean

DescriptionSpecifies the description of the column.

Data type: String

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

Data type: Float

Note icon

  • If the Display Width value of a column is not set in the Catalog Manager, the column will be inserted in a report with the default width defined by Logi Report.
  • Assume that you have set the Display Width of a column, and used the column while creating a new component with the report wizard, its width may be adjusted according to the paper size.
LengthSpecifies the length of the column's value, in bytes.

Data type: Integer

NameSpecifies the mapped name of the column in the catalog.

Data type: String

NullableSpecifies the nullability of the column's value. Choose an option from the drop-down list.

Data type: Enumeration

Number Base Specifies the number base of the column.

Data type: Integer

Path StringSpecifies the path of the column, which is used to identify the column in tree.

Data type: String

PrecisionSpecifies the precision of the column's value. The default value comes from data source metadata and it specifies the column's largest number of digits. The larger the precision is, the more memory it might take, however, the more accurate values you will get.

Data type: Integer

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

Data type: Integer

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

Data type: Integer

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

Data type: Boolean

Auto Scale in NumberThe property is available when the column is of the Number data type. It specifies whether to automatically scale the column 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 column 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

Horizontal AlignmentSpecifies the horizontal justification of the text in the column. 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 column. 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 column. Type a numeric value to change the padding.

Data type: Float

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

Data type: Float

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

Data type: Float

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

Data type: Float

Geometry
HeightSpecifies the height of the column, which takes effect when the column is inserted into a report. By default, no value is specified to the property, which means a height will be assigned to the column by Logi Report automatically. Type a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the column, which takes effect when the column is inserted into a report. By default, no value is specified to the property, which means a height will be assigned to the column by Logi Report automatically. Type a numeric value to change the width.

Data type: Float

Color
BackgroundSpecifies the background color of the column. 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 column. 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 column. 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 column. Choose a style from the drop-down list.

Data type: Enumeration

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

Data type: Enumeration

Right LineSpecifies the line style of the right border of the column. 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 column.

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 column. 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 column. 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