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 Name Available For Description
Geometry
Height Web Report, Library Component Specifies the height of the object. Type a numeric value to change the height.

Data type: Float

Width Web Report, Library Component Specifies the width of the object. Type a numeric value to change the width.

Data type: Float

X Web Report, Library Component Specifies 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

Y Web Report, Library Component Specifies 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
Background Web Report, Library Component Specifies 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
Class Web Report, Library Component Specifies a CSS class to be applied to the object which is a valid class in the CSS file.

Data type: String

Style Web Report, Library Component The 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 Color Web Report, Library Component Specifies 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 Thickness Web Report, Library Component Specifies the width of the border. Type a numeric value to change the thickness.

Data type: Float

Bottom Line Web Report, Library Component Specifies the line style of the bottom border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Left Line Web Report, Library Component Specifies the line style of the left border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Right Line Web Report, Library Component Specifies the line style of the right border of the object. Choose a style from the drop-down list.

Data type: Enumeration

Top Line Web Report, Library Component 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 Web Report, Library Component Specifies the space between the contents and the bottom border of the object. Type a numeric value to change the padding.

Data type: Float

Left Padding Web Report, Library Component Specifies the space between the contents and the left border of the object. Type a numeric value to change the padding.

Data type: Float

Right Padding Web Report, Library Component Specifies the space between the contents and the right border of the object. Type a numeric value to change the padding.

Data type: Float

Top Padding Web Report, Library Component Specifies 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 Number Web Report, Library Component 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:
  • 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 CSV Web Report, Library Component Specifies whether to include the object in the CSV result of the report.

Data type: Boolean

Export to Excel Web Report, Library Component Specifies whether to include the object in the Excel result of the report.

Data type: Boolean

Export to HTML Web Report, Library Component Specifies whether to include the object in the HTML result of the report.

Data type: Boolean

Export to PDF Web Report, Library Component Specifies whether to include the object in the PDF result of the report.

Data type: Boolean

Export to PostScript Web Report, Library Component Specifies whether to include the object in the PostScript result of the report.

Data type: Boolean

Export to Report Result Web Report, Library Component Specifies 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 Component Specifies whether to include the object in the RTF result of the report.

Data type: Boolean

Export to Text Web Report, Library Component Specifies whether to include the object in the Text result of the report.

Data type: Boolean

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

Data type: Boolean

Horizontal Alignment Web Report, Library Component Specifies the horizontal justification of the contents in the KPI. Choose an option from the drop-down list.

Data type: Enumeration

Invisible Web Report, Library Component Specifies 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

Position Web Report, Library Component Specifies the position of the object. Choose an option from the drop-down list.

Data type: Enumeration

Suppress Web Report, Library Component Specifies 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 Alignment Web Report, Library Component Specifies 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 Value Web Report Specifies 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 Anchor Web Report Specifies whether to include the object in the TOC Browser for the report.

Data type: Boolean

Back to top

BackPrevious Topic Next TopicNext