Skip to main content

KPI Properties

  • Updated

BackPrevious Topic Next TopicNext

KPI Properties

This topic lists the properties of a KPI object. The availabilities of the properties vary for the supported report types: Web Report and Library Component.

Property NameAvailable ForDescription
Geometry
HeightWeb Report, Library ComponentSpecifies the height of the object. Type a numeric value to change the height.

Data type: Float

WidthWeb Report, Library ComponentSpecifies the width of the object. Type a numeric value to change the width.

Data type: Float

XWeb Report, Library ComponentSpecifies the horizontal coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Type a numeric value to change the position.

Data type: Float

YWeb Report, Library ComponentSpecifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is ignored if the Position property is set to static. Type a numeric value to change the position.

Data type: Float

Color
BackgroundWeb Report, Library ComponentSpecifies 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. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

CSS
ClassWeb Report, Library ComponentSpecifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

StyleWeb Report, Library ComponentThe property can be used in two ways.
  • Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the report or library component level and when there are styles in the Style Group that can be applied to the object, or type in the style name.
  • Specifies a CSS selector to be applied to the object. Type a valid class name from the CSS file.

Data type: String

Border
Border ColorWeb Report, Library ComponentSpecifies the color of 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. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.

Data type: String

Border ThicknessWeb Report, Library ComponentSpecifies the width of the border. Type a numeric value to change the thickness.

Data type: Float

Bottom LineWeb Report, Library ComponentSpecifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left LineWeb Report, Library ComponentSpecifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right LineWeb Report, Library ComponentSpecifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Top LineWeb Report, Library ComponentSpecifies the line style of the top border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Padding
Bottom PaddingWeb Report, Library ComponentSpecifies the space between the contents and the bottom border of the object. Type a numeric value to change the padding.

Data type: Float

Left PaddingWeb Report, Library ComponentSpecifies the space between the contents and the left border of the object. Type a numeric value to change the padding.

Data type: Float

Right PaddingWeb Report, Library ComponentSpecifies the space between the contents and the right border of the object. Type a numeric value to change the padding.

Data type: Float

Top PaddingWeb Report, Library ComponentSpecifies the space between the contents and the top border of the object. Type a numeric value to change the padding.

Data type: Float

Others
Auto Scale in NumberWeb Report, Library ComponentSpecifies whether to automatically scale the values that are of the Number data type in the object when the values 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 the values.

Data type: Boolean

Export to CSVWeb Report, Library ComponentSpecifies whether to include the object in the CSV result of the report.

Data type: Boolean

Export to ExcelWeb Report, Library ComponentSpecifies whether to include the object in the Excel result of the report.

Data type: Boolean

Export to HTMLWeb Report, Library ComponentSpecifies whether to include the object in the HTML result of the report.

Data type: Boolean

Export to PDFWeb Report, Library ComponentSpecifies whether to include the object in the PDF result of the report.

Data type: Boolean

Export to PostScriptWeb Report, Library ComponentSpecifies whether to include the object in the PostScript result of the report.

Data type: Boolean

Export to Report ResultWeb Report, Library ComponentSpecifies whether to include the object when previewing the report in Web Report Result and running the report in Web Report Studio, or when the library component is used in JDashboard.

Data type: Boolean

Export to RTF Web Report, Library ComponentSpecifies whether to include the object in the RTF result of the report.

Data type: Boolean

Export to TextWeb Report, Library ComponentSpecifies whether to include the object in the Text result of the report.

Data type: Boolean

Export to XML Web Report, Library ComponentSpecifies whether to include the object in the XML result of the report.

Data type: Boolean

Horizontal AlignmentWeb Report, Library ComponentSpecifies the horizontal justification of the contents in the KPI. Choose an option from the drop-down list.

Data type: Enumeration

InvisibleWeb Report, Library ComponentSpecifies whether to show the object in the design area and in the results. All formulas and calculations will still be performed if the property is set to true.

Data type: Boolean

PositionWeb Report, Library ComponentSpecifies the position of the object. Choose an option from the drop-down list.

Data type: Enumeration

SuppressWeb Report, Library ComponentSpecifies whether to show the object in the design area and in the results. All formulas and calculations will be skipped if the property is set to true.

Data type: Boolean

Note: When both the Invisible and Suppress properties of an object are set to true, Suppress has the higher priority.

Vertical AlignmentWeb Report, Library ComponentSpecifies the vertical justification of the contents in the KPI. Applied only when the web report runs in Web Report Studio. Choose an option from the drop-down list.

Data type: Enumeration

TOC
Anchor Display ValueWeb ReportSpecifies a string to display for the TOC entry for this object in the TOC Browser. By default it is the value of the specified object. The TOC Anchor property must be set to true for this property to take effect.

Data type: String

TOC AnchorWeb ReportSpecifies whether to include the object in the TOC Browser for the report.

Data type: Boolean

BackPrevious Topic Next TopicNext