Skip to main content

KPI Properties

  • Updated

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

Data type: Float

YWeb Report, Library ComponentSpecifies the vertical coordinate of the object's top left corner, relative to its parent container, which Logi Report Engine applies when the object is not in static position in the container. Type a numeric value to change the coordinate.

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

Data type: String

CSS
ClassWeb Report, Library ComponentSpecifies 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

StyleWeb Report, Library Component

Specifies the style 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 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 box. 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 Number values in the object that fall into the two ranges:
  • When 1000 <= value < 10^15, Logi Report Engine 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, Logi Report Engine uses scientific notation to scale the values.

Data type: Boolean

Export to CSVWeb Report, Library ComponentSpecifies whether to include the object in the CSV output.

Data type: Boolean

Export to ExcelWeb Report, Library ComponentSpecifies whether to include the object in the Excel output.

Data type: Boolean

Export to HTMLWeb Report, Library ComponentSpecifies whether to include the object in the HTML output.

Data type: Boolean

Export to PDFWeb Report, Library ComponentSpecifies whether to include the object in the PDF output.

Data type: Boolean

Export to PostScriptWeb Report, Library ComponentSpecifies whether to include the object in the PostScript output.

Data type: Boolean

Export to Report ResultWeb Report, Library ComponentSpecifies 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 ComponentSpecifies whether to include the object in the RTF output.

Data type: Boolean

Export to TextWeb Report, Library ComponentSpecifies whether to include the object in the Text output.

Data type: Boolean

Export to XML Web Report, Library ComponentSpecifies whether to include the object in the XML output.

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 hide the object in the design area and in the report. Logi Report Engine performs all calculations that involve the object regardless of whether the object is visible or not.

Data type: Boolean

PositionWeb Report, Library ComponentDesigner 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

SuppressWeb Report, Library ComponentSpecifies whether to suppress the object in the design area and in the report. If you suppress an object, Logi Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible.

Data type: Boolean

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 the text you want to display as the object's TOC entry label. This property takes effect when you set TOC Anchor of the object to "true".

Data type: String

TOC AnchorWeb ReportSpecifies whether to include the object in the TOC of the report.

Data type: Boolean

BackPrevious Topic  Next TopicNext