Previous Topic
KPI Chart Properties
This topic lists the properties of a KPI Chart 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 |
|---|---|---|
| General | ||
| Data Inherit | Web Report, Library Component | Indicates whether the dataset for this object is inherited from another object. This property is read only. |
| 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, 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 |
| Y | Web Report, Library Component | Specifies 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 |
| 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:
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 to apply to the object. You can specify the style in two ways:
Data type: String |
| Others | ||
| Alternative Text | Web Report, Library Component | Specifies the alternate text of the image, which will be shown when the image cannot be displayed. This property applies only when the chart is exported to HTML as an image chart. Type a string to serve as the alternative text.
Data type: String |
| Default for Filter | Web Report | Specifies whether to display the object as the default data component in the Apply To drop-down list of the Filter dialog box at runtime.
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 |
| Invisible | Web Report, Library Component | Specifies 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 |
| Invisible for Filter Dialogs | Web Report | Specifies whether to display the object in the Apply To drop-down list of the Filter dialog box at runtime. Designer disables this property when you set Default for Filter of the object to "true".
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, Logi Report Engine skips all formulas and calculations that involve the object. This property has higher priority over Invisible. Data type: Boolean |
| Suppress When No Records | Web Report, Library Component | Specifies whether to suppress the object in the report when no record is returned to its parent data component.
Data type: Boolean |
| Excel | ||
| Column Index | Web Report | Specifies the X coordinate of the object relative to its parent container in the Excel output, measured in cells. This property takes effect when you set Columned of the web report to "true" and Position of the object is not "static".
Data type: Integer |
| Column Number | Web Report | Specifies the number of columns to determine the width of the object in the Excel output. This property takes effect when you set Columned of the web report to "true". Type an integer value to change the number.
Data type: Integer |
| Row Index | Web Report | Specifies the Y coordinate of the object relative to its parent container in the Excel output, measured in cells. This property takes effect when you set Columned of the web report to "true" and Position of the object is not "static".
Data type: Integer |
| Row Number | Web Report | Specifies the number of rows to determine the height of the object in the Excel output. This property takes effect when you set Columned of the web report to "true". Type an integer value to change the number.
Data type: Integer |
| TOC | ||
| Anchor Display Value | Web Report | Specifies 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 Anchor | Web Report | Specifies whether to include the object in the TOC of the report. Data type: Boolean |
| Platform | ||
| Anti-aliasing | Web Report, Library Component | Specifies whether to make the edges in a chart smooth.
Data type: Boolean |
| Minimum Tick Mark Space | Web Report, Library Component | Specifies the minimum space between two adjacent tick marks. Type a numeric value to change the space.
Data type: Float |
| Pattern List | Web Report, Library Component | Specifies patterns of the data markers. Select  in the value cell and select the small squares in the color tray one by one to specify the patterns for the data markers. The patterns can be one or more of the following: Automatic, Color, Texture, and Gradient.
Data type: String |
| Background | ||
| Border Color | Web Report, Library Component | Specifies the color of the platform border. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Border End Caps | Web Report, Library Component | Specifies the ending style of the platform border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Joint | Web Report, Library Component | Specifies the joint style of the platform border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Outlined | Web Report, Library Component | Specifies whether to show the platform border line in Outline Path. If the property is set to true, the platform border line will be shown in Outline Path; otherwise, in Fill Path.
Data type: Boolean |
| Border Style | Web Report, Library Component | Specifies the line style of the platform border. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Thickness | Web Report, Library Component | Specifies the width of the platform border. Type a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Web Report, Library Component | Specifies the transparency of the platform border, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Border Type | Web Report, Library Component | Specifies the border type of the platform. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Variable Dash | Web Report, Library Component | Specifies whether to resize the dash automatically.
Data type: Boolean |
| Color | Web Report, Library Component | Specifies the color of the platform background. Applied when Fill Type of the platform background is set to color. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Fill Transparency | Web Report, Library Component | Specifies the transparency of the platform background, in percent. Type a numeric value to change the transparency.
Data type: Integer |
| Fill Type | Web Report, Library Component | Specifies the fill pattern for the platform background. Choose an option from the drop-down list. Can be none, color, texture, gradient or image.
Data type: Enumeration |
| Gradient End Color | Web Report, Library Component | Specifies the color of the point where the gradient ends. Applied when Fill Type of the platform background is set to gradient. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Gradient End X | Web Report, Library Component | Specifies the horizontal position where the gradient ends, measured in a percentage of the platform width. Applied when Fill Type of the platform background is set to gradient.
Data type: Integer |
| Gradient End Y | Web Report, Library Component | Specifies the vertical position where the gradient ends, measured in a percentage of the platform height. Applied when Fill Type of the platform background is set to gradient.
Data type: Integer |
| Gradient Start Color | Web Report, Library Component | Specifies the color of the point where the gradient begins. Applied when Fill Type of the platform background is set to gradient. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Gradient Start X | Web Report, Library Component | Specifies the horizontal position where the gradient begins, measured in a percentage of the platform width. Applied when Fill Type of the platform background is set to gradient.
Data type: Integer |
| Gradient Start Y | Web Report, Library Component | Specifies the vertical position where the gradient begins, measured in a percentage of the platform height. Applied when Fill Type of the platform background is set to gradient.
Data type: Integer |
| Gradient Style | Web Report, Library Component | Specifies the gradient style for the platform background. Applied when Fill Type of the platform background is set to gradient. Choose an option from the drop-down list.
Data type: Enumeration |
| Image File | Web Report, Library Component | Specifies the file name of the image, a portion of which will be displayed as the platform background. Applied when Fill Type of the platform background is set to image. Type the file name with suffix in the value cell. If the image is outside of the current catalog, you should include the full path of the image correctly.
Data type: String |
| Image Height | Web Report, Library Component | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the platform background. They take effect when Fill Type of the platform background is set to image.
Image Height specifies the height of the image portion, measured in a percentage of the image height. Data type: Integer |
| Image Layout | Web Report, Library Component | Specifies the layout style for the image that will be displayed as the platform background. Applied when Fill Type of the platform background is set to image. Choose an option from the drop-down list.
Data type: Enumeration |
| Image Width | Web Report, Library Component | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the platform background. They take effect when Fill Type of the platform background is set to image.
Image Width specifies the width of the image portion, measured in a percentage of the image width. Data type: Integer |
| Image X | Web Report, Library Component | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the platform background. They take effect when Fill Type of the platform background is set to image.
Image X specifies the distance between the left border of image and the portion that will contain the pattern, measured in a percentage of the image width. Data type: Integer |
| Image Y | Web Report, Library Component | The four properties, Image X, Image Y, Image Width, and Image Height, together are used to define a portion of the image (the portion is a rectangle), which will be displayed as the platform background. They take effect when Fill Type of the platform background is set to image.
Image Y specifies the distance between the top border of image and the portion that will contain the pattern, measured in a percentage of the image height. Data type: Integer |
| Inset Bottom | Web Report, Library Component | Specifies the bottom position of the background area, measured in a percentage of the chart height, from the bottom edge of the chart.
Data type: Float |
| Inset Left | Web Report, Library Component | Specifies the left position of the background area, measured in a percentage of the chart width, from the left edge of the chart.
Data type: Float |
| Inset Right | Web Report, Library Component | Specifies the right position of the background area, measured in a percentage of the chart width, from the right edge of the chart.
Data type: Float |
| Inset Top | Web Report, Library Component | Specifies the top position of the background area, measured in a percentage of the chart height, from the top edge of the chart.
Data type: Float |
| Radius | Web Report, Library Component | Specifies the radius for the joint of the platform border line. Applied when Border Joint is set to joint round. Type a numeric value to change the radius.
Data type: Float |
| Texture Background Color | Web Report, Library Component | Specifies the background color of the texture. Applied when Fill Type of the platform background is set to texture. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Texture Foreground Color | Web Report, Library Component | Specifies the foreground color of the texture. Applied when Fill Type of the platform background is set to texture. Choose a color from the drop-down list or select Custom to customize a color. You can also type a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Texture Style | Web Report, Library Component | Specifies the texture style of the platform background. Applied when Fill Type of the platform background is set to texture. Choose an option from the drop-down list.
Data type: Enumeration |
In the same report, you can only set one data component's Default for Filter property to "true".