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 | Shows whether the object inherits dataset from another object. 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, 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 |
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 you want to apply to the object. You can specify the style in two ways:
Data type: String |
Others | ||
Alternate Text | Web Report, Library Component | Specifies the text you want to show when the chart cannot display in the HTML output, if you export the chart to HTML as an image chart. 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 In the same report, you can only set one data component's Default for Filter property to "true". |
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. 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, 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. Data type: Integer This property takes effect when you set the web report's Columned property to "true" and the object's Position property is not "static". |
Column Number | Web Report | Specifies the number of columns to determine the width of the object in the Excel output. Type an integer value to change the number.
Data type: Integer This property takes effect when you set the web report's Columned property to "true". |
Row Index | Web Report | Specifies the Y coordinate of the object relative to its parent container in the Excel output, measured in cells. Data type: Integer This property takes effect when you set the web report's Columned property to "true" and the object's Position property is not "static". |
Row Number | Web Report | Specifies the number of rows to determine the height of the object in the Excel output. Type an integer value to change the number.
Data type: Integer This property takes effect when you set the web report's Columned property to "true". |
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 |
Platform | ||
Anti-aliasing | Web Report, Library Component | Specifies whether to smooth out edges of the chart. Data type: Boolean |
Minimum Tick Mark Space | Web Report, Library Component | Specifies the minimum space between two adjacent tick marks on the category axis of the chart. Type a numeric value to change the space. Data type: Float |
Pattern List | Web Report, Library Component | Specifies the color pattern of the data markers in the same data series in the chart. Select the ellipsis in the value cell to edit the pattern in the Color List dialog box.
Data type: String |
Background (for customizing fill pattern of the platform) | ||
Border Color | Web Report, Library Component | Specifies the color for the border of the element. 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 End Caps | Web Report, Library Component | Specifies the ending style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Joint | Web Report, Library Component | Specifies the joint style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Outlined | Web Report, Library Component | Specifies whether to use outline path for the border of the element. Default is to apply fill path.
Data type: Boolean |
Border Style | Web Report, Library Component | Specifies the line style for the border of the element. Choose an option from the drop-down list.
Data type: Enumeration |
Border Thickness | Web Report, Library Component | Specifies the width for the border of the element. Type a numeric value to change the thickness.
Data type: Float |
Border Transparency | Web Report, Library Component | Specifies the transparency for the border of the element, in percent. Type a numeric value to change the transparency.
Data type: Integer |
Border Type | Web Report, Library Component | Specifies the type for the border of the element.
Data type: Enumeration |
Border Variable Dash | Web Report, Library Component | Specifies whether to resize the dash automatically when you select a dash line style for Border Style. Default is to apply fixed dash size. Data type: Boolean |
Color | Web Report, Library Component | Specifies the color to fill the element, when you set Fill Type of the element to "color". 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 |
Fill Transparency | Web Report, Library Component | Specifies the transparency for the fill pattern of the element, in percent. Type a numeric value to change the transparency.
Data type: Integer |
Fill Type | Web Report, Library Component | Specifies how you want to fill the element, by color, texture, gradient, or image, or not to fill it. Choose an option from the drop-down list.
Data type: Enumeration |
Gradient End Color | Web Report, Library Component | Specifies the ending color of the gradient, when you set Fill Type of the element to "gradient". 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 |
Gradient End X | Web Report, Library Component | Specifies the horizontal position where the gradient ends when you set Fill Type of the element to "gradient", measured in a percentage of the element's width or the width of the inset in the element if you define an inset, from the left edge of the element or inset.
Data type: Integer |
Gradient End Y | Web Report, Library Component | Specifies the vertical position where the gradient ends when you set Fill Type of the element to "gradient", measured in a percentage of the element's height or the height of the inset in the element if you define an inset, from the bottom edge of the element or inset.
Data type: Integer |
Gradient Start Color | Web Report, Library Component | Specifies the starting color of the gradient, when you set Fill Type of the element to "gradient". 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 |
Gradient Start X | Web Report, Library Component | Specifies the horizontal position where the gradient begins when you set Fill Type of the element to "gradient", measured in a percentage of the element's width or the width of the inset in the element if you define an inset, from the left edge of the element or inset.
Data type: Integer |
Gradient Start Y | Web Report, Library Component | Specifies the vertical position where the gradient begins when you set Fill Type of the element to "gradient", measured in a percentage of the element's height or the height of the inset in the element if you define an inset, from the bottom edge of the element or inset.
Data type: Integer |
Gradient Style | Web Report, Library Component | Specifies the style of the gradient to fill the element, when you set Fill Type of the element 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 you want to use to fill the element, when you set Fill Type of the element to "image". Type the file name with suffix in the value cell. If the image is outside the current catalog, you should include the full path of the image correctly.
Data type: String |
Image Height | Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image Height specifies the height of the portion, measured in a percentage of the image's height. Data type: Integer |
Image Layout | Web Report, Library Component | Specifies the layout of the image portion to fill the element, when you set Fill Type of the element to "image". Choose an option from the drop-down list.
Data type: Enumeration |
Image Width | Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image Width specifies the width of the portion, measured in a percentage of the image's width. Data type: Integer |
Image X | Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image X specifies the left position of the portion, measured in a percentage of the image's width, from the left edge of the image. Data type: Integer |
Image Y | Web Report, Library Component | You can use the four properties, Image Height, Image Width, Image X, and Image Y, to define a portion of an image (the portion is a rectangle) to fill the element, when you set Fill Type of the element to "image".
Image Y specifies the top position of the portion, measured in a percentage of the image's height, from the bottom edge of the image. Data type: Integer |
Inset Bottom | Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Bottom specifies the bottom position of the inset, measured in a percentage of the element's height, from the bottom edge of the element. Data type: Float |
Inset Left | Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Left specifies the left position of the inset, measured in a percentage of the element's width, from the left edge of the element. Data type: Float |
Inset Right | Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Right specifies the right position of the inset, measured in a percentage of the element's width, from the right edge of the element. Data type: Float |
Inset Top | Web Report, Library Component | You can use the four properties, Inset Bottom, Inset Left, Inset Right, and Inset Top, to define an inset in the element and fill the inset instead of the entire element.
Inset Top specifies the top position of the inset, measured in a percentage of the element's height, from the top edge of the element. Data type: Float |
Radius | Web Report, Library Component | Specifies the radius for the joint of the platform border, when you set Border Joint 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, when you set Fill Type of the element to "texture". 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 |
Texture Foreground Color | Web Report, Library Component | Specifies the foreground color of the texture, when you set Fill Type of the element to "texture". 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 |
Texture Style | Web Report, Library Component | Specifies the style of the texture to fill the element, when you set Fill Type of the element to "texture". Choose an option from the drop-down list.
Data type: Enumeration |