Previous Topic
KPI Chart Properties
This topic lists the properties of a KPI Chart object. The availabilities of the properties vary for the supported report types: Web Report and Library Component.
| 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 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 |
| 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.
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 show the data component as the default component in the Apply To drop-down list of the Filter dialog box in Web Report Studio.
Data type: Boolean
|
| Export to Excel | Web Report, Library Component | Specifies whether to include the object in the Excel output of the report.
Data type: Boolean |
| Export to HTML | Web Report, Library Component | Specifies whether to include the object in the HTML output of the report.
Data type: Boolean |
| Export to PDF | Web Report, Library Component | Specifies whether to include the object in the PDF output of the report.
Data type: Boolean |
| Export to PostScript | Web Report, Library Component | Specifies whether to include the object in the PostScript output 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 output of the report.
Data type: Boolean |
| 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 |
| Invisible for Filter Dialogs | Web Report | Specifies whether to show the data component in the Apply To drop-down list of the Filter dialog box in Web Report Studio. This property cannot be edited when Default for Filter 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
|
| Suppress When No Records | Web Report, Library Component | Specifies whether to display the object in the results 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 when exported to Excel or CSV, measured in cells. The Columned property at the report level must be set to true for this property to take effect.
Data type: Integer |
| Column Number | Web Report | Specifies the number of columns which will be the object's width in the Excel or CSV output. The Columned property at the report level must be set to true for this property to take effect.
Data type: String |
| Row Index | Web Report | Specifies the Y coordinate of the object relative to its parent container when exported to Excel or CSV, measured in cells. The Columned property at the report level must be set to true for this property to take effect.
Data type: Integer |
| Row Number | Web Report | Specifies the number of rows which will be the object's height in the Excel or CSV output. The Columned property at the report level must be set to true for this property to take effect.
Data type: String |
| 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 |
| 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 a report, you can set only one data component's Default for Filter property to true.