BackPrevious Topic  Next TopicNext

KPI Properties

This topic describes the properties of a KPI object that you can use in web reports and library components.

Designer provides some properties only when you use the object in certain report types. You can get details from the Available For column in the property table.

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 object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.

Data type: Float
Y Web Report, Library Component Specifies the vertical coordinate of the object's top left corner, relative to its parent container, when the object is not in static position in the container. Type a numeric value to change the coordinate.

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 box. 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 the name of the Class Selector to apply to the object, which you define in the CSS file of the style the report applies.

For example, if you define the CSS file as follows:

@charset "GBK";
TextField {Background: #ff0000}
/*Style=LabelX*/
TextField[Style="LabelX"]{Background: #0000FF}
/*ID=W*/
TextField#W{Background: #FFFF00}
/*class=C*/
TextField.C{Background: #00FFFF}

To apply the Class Selector in the file to the object, type C in the value cell.

Data type: String
Style Web Report, Library Component Specifies the style you want to apply to the object. You can specify the style in two ways:
  • Type the style which should be an Attribute Selector whose attribute is "style" in the CSS file of the style the report applies. For example, to apply the style in the preceding sample CSS file to the object, type LabelX in the value cell.
  • Choose a style from the drop-down list if you have specified the Style Group property for the web report and there are styles in the style group that are applicable to the object.

Data type: String
Border
Border Color Web Report, Library Component Specifies the color for 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 box. 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 for the border of the object. Type a numeric value to change the thickness.

Data type: Float
Bottom Line Web Report, Library Component Specifies the line style for the bottom border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Left Line Web Report, Library Component Specifies the line style for the left border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Right Line Web Report, Library Component Specifies the line style for the right border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Top Line Web Report, Library Component Specifies the line style for the top border of the object. Choose an option from the drop-down list.

Data type: Enumeration
Padding
Bottom Padding Web Report, Library Component Specifies the space between the content in the object 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 content in the object 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 content in the object 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 content in the object 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 Number values in the object that fall into the two ranges:
  • When 1000 <= value < 10^15, Designer applies 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, Designer uses scientific notation to scale the values.

Data type: Boolean
Export to CSV Web Report, Library Component Specifies whether to include the object in the CSV output.

Data type: Boolean
Export to Excel Web Report, Library Component Specifies whether to include the object in the Excel output.

Data type: Boolean
Export to HTML Web Report, Library Component Specifies whether to include the object in the HTML output.

Data type: Boolean
Export to PDF Web Report, Library Component Specifies whether to include the object in the PDF output.

Data type: Boolean
Export to PostScript Web Report, Library Component Specifies whether to include the object in the PostScript output.

Data type: Boolean
Export to Report Result Web Report, Library Component Specifies whether to include the object when you preview the report in the Web Report Result format in Designer, and when users run the report in the same format or use the library component at runtime.

Data type: Boolean
Export to RTF Web Report, Library Component Specifies whether to include the object in the RTF output.

Data type: Boolean
Export to Text Web Report, Library Component Specifies whether to include the object in the Text output.

Data type: Boolean
Export to XML Web Report, Library Component Specifies whether to include the object in the XML output.

Data type: Boolean
Horizontal Alignment Web Report, Library Component Specifies the horizontal justification of the content in the object. Choose an option from the drop-down list.

Data type: Enumeration
Invisible Web Report, Library Component Specifies whether to hide the object in the design area and in the report. Report Engine performs all calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean
Position Web Report, Library Component Designer enables this property when the object is in a flow layout container, such as the report body or a tabular cell, text box, or KPI. You can use it to specify the position of the object in the container. Choose an option from the drop-down list.

Data type: Enumeration
Suppress Web Report, Library Component Specifies whether to suppress the object in the design area and in the report. If you suppress an object, Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible.

Data type: Boolean
Vertical Alignment Web Report, Library Component Specifies the vertical justification of the content in the object. Choose an option from the drop-down list.

Data type: Enumeration

Note icon This property takes effect only when the KPI runs in Web Report Studio.
TOC
Anchor Display Value Web Report Specifies the text you want to display as the object's TOC entry label, when you set the object's TOC Anchor property to "true".

Data type: String
TOC Anchor Web Report Specifies whether to include the object in the TOC of the report.

Data type: Boolean

Back to top

BackPrevious Topic  Next TopicNext