Skip to main content

KPI Properties

  • Updated

BackPrevious Topic  Next TopicNext

KPI Properties

This topic describes the properties of a KPI.

Property NameDescription
General
Display Name Specifies the display name of the object.

Data type: String

Instance Name Shows the instance name of the object. This property is read only.
Geometry
HeightSpecifies the height of the object, in inches. Type a numeric value to change the height.

Data type: Float

WidthSpecifies the width of the object, in inches. Type a numeric value to change the width.

Data type: Float

XSpecifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is unavailable if the Position property is set to static. Type a numeric value to change the position in inches.

Data type: Float

YSpecifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is unavailable if the Position property is set to static. Type a numeric value to change the position in inches.

Data type: Float

Color
BackgroundSpecifies the background color of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker 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 of the border of the object. Choose a color from the drop-down list or select Custom to define a color in the Color Picker dialog box. 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 in inches. Type a numeric value to change the thickness.

Data type: Float

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

Data type: Enumeration

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

Data type: Enumeration

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

Data type: Enumeration

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

Data type: Enumeration

Padding
Bottom PaddingSpecifies the space between the content and the bottom border of the object, in inches. Type a numeric value to change the padding.

Data type: Float

Left PaddingSpecifies the space between the content and the left border of the object, in inches. Type a numeric value to change the padding.

Data type: Float

Right PaddingSpecifies the space between the content and the right border of the object, in inches. Type a numeric value to change the padding.

Data type: Float

Top PaddingSpecifies the space between the content and the top border of the object, in inches. Type a numeric value to change the padding.

Data type: Float

Others
Auto Scale in Number

Specifies whether to automatically scale the values that are of the Number data type when the values fall into the two ranges:

  • When 1000 <= value < 10^15, Logi Report uses 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 uses scientific notation to scale the values.

Data type: Boolean

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

Data type: Boolean

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

Data type: Boolean

Export to HTMLSpecifies whether to include the object when exporting the report to HTML.

Data type: Boolean

Export to PDFSpecifies whether to include the object when exporting the report to PDF.

Data type: Boolean

Export to PostScriptSpecifies whether to include the object when exporting the report to PostScript.

Data type: Boolean

Export to Report ResultSpecifies whether to include the object in Web Report Studio or when the report is opened in Web Report Result.

Data type: Boolean

Export to RTFSpecifies whether to include the object when exporting the report to RTF.

Data type: Boolean

Export to TextSpecifies whether to include the object when exporting the report to Text.

Data type: Boolean

Export to XMLSpecifies whether to include the object when exporting the report to XML.

Data type: Boolean

InvisibleSpecifies whether to show or hide the object. All formulas and calculations will still be performed if the property is set to true. You can also use a formula to control whether to show it.

Data type: Boolean

PositionSpecifies the position of the object. Available when the object is directly contained in the report body or a tabular cell.
  • absolute - The object's position will be decided by its X and Y property values.
  • static - The object will be positioned at the default location in its container. If selected, the X, Y and other position-related properties will be hidden or disabled.

Data type: Enumeration

BackPrevious Topic  Next TopicNext