Previous Topic
KPI
The properties of a KPI are:
| Property Name | Description |
|---|---|
| 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 | |
| Height | Specifies the height of the object, in inches. Type a numeric value to change the height.
Data type: Float |
| Width | Specifies the width of the object, in inches. Type a numeric value to change the width.
Data type: Float |
| X | Specifies 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 |
| Y | Specifies 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 | |
| Background | Specifies 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 Color | Specifies 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 Thickness | Specifies the width of the border in inches. Type a numeric value to change the thickness.
Data type: Float |
| Bottom Line | Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Left Line | Specifies the line style of the left border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Right Line | Specifies the line style of the right border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Top Line | Specifies the line style of the top border of the object. Choose a style from the drop-down list.
Data type: Enumeration |
| Padding | |
| Bottom Padding | Specifies 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 Padding | Specifies 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 Padding | Specifies 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 Padding | Specifies 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 in the object when the values fall into the two ranges:
Data type: Boolean |
| Export to CSV | Specifies whether to include the object when exporting the report to CSV.
Data type: Boolean |
| Export to Excel | Specifies whether to include the object when exporting the report to Excel.
Data type: Boolean |
| Export to HTML | Specifies whether to include the object when exporting the report to HTML.
Data type: Boolean |
| Export to PDF | Specifies whether to include the object when exporting the report to PDF.
Data type: Boolean |
| Export to PostScript | Specifies whether to include the object when exporting the report to PostScript.
Data type: Boolean |
| Export to Report Result | Specifies whether to include the object in Web Report Studio or when the report is opened in Web Report Result.
Data type: Boolean |
| Export to RTF | Specifies whether to include the object when exporting the report to RTF.
Data type: Boolean |
| Export to Text | Specifies whether to include the object when exporting the report to Text.
Data type: Boolean |
| Export to XML | Specifies whether to include the object when exporting the report to XML.
Data type: Boolean |
| Invisible | Specifies 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 or not to show it.
Data type: Boolean |
| Position | Specifies the position of the object. Available when the object is directly contained in the report body or a tabular cell.
Data type: Enumeration |