Previous Topic
Properties of Chart in Web Report
A chart can have the following child objects: Chart Paper, Chart Legend and Chart Label.
The properties of a chart object in a web report are as follows:
| Property Name | Description |
|---|---|
| General | |
| Data Inherit | Indicates whether the dataset for this object is inherited from another object. This property is read only. |
| Geometry | |
| Height | Specifies the height of the object. Enter a numeric value to change the height.
Data type: Float |
| Width | Specifies the width of the object. Enter a numeric value to change the width.
Data type: Float |
| X | 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. Enter a numeric value to change the position.
Data type: Float |
| Y | 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. Enter a numeric value to change the position.
Data type: Float |
| CSS | |
| Class | Specifies a CSS class to be applied to the object which is a valid class in the CSS file.
Data type: String |
| Style | The property can be used in two ways.
Data type: String |
| Others | |
| Alternative Text | 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.
Enter a string to serve as the alternative text.
Data type: String |
| Default for Filter | Specifies whether to show the data component as the default component in the Apply to drop-down list of the Filter dialog in Web Report Studio.
Data type: Boolean Note: In a web report, only one data component’s Default for Filter property can be set to true. |
| Export to Applet | Specifies whether to include the object when exporting the report to Applet.
Data type: Boolean |
| Export to Excel | Specifies whether to include the object when exporting the report to Excel.
Data type: Boolean |
| Export to HTML | Specifies whether to include the object when exporting the report to HTML.
Data type: Boolean |
| Export to PDF | Specifies whether to include the object when exporting the report to PDF.
Data type: Boolean |
| Export to PostScript | Specifies whether to include the object when exporting the report to PostScript.
Data type: Boolean |
| Export to Report Result | Specifies whether to include the object when exporting the report to Report Result.
Data type: Boolean |
| Export to RTF | Specifies whether to include the object when exporting the report to RTF.
Data type: Boolean |
| Invisible | Specifies whether to show the object in the design area and in the report results. All formulas and calculations will still be performed if the property is set to true.
Data type: Boolean |
| Invisible for Filter Dialogs | Specifies whether to show the data component in the Apply to drop-down list of the Filter dialog in Web Report Studio. This property cannot be edited when Default for Filter is set to true.
Data type: Boolean |
| Logic Column | Specifies whether to show the object in the next visible table cell in the same row when the column which holds the object is hidden. Choose an option from the drop-down list.
Data type: Enumeration Notes:
|
| Position | Specifies the position of the object. Choose an option from the drop-down list.
Data type: Enumeration |
| Suppress | Specifies whether to show the object in the design area and in the report results. All formulas and calculations will be skipped if the property is set to true.
Data type: Boolean Note: When both the Invisible and Suppress properties of an object are set to true, Suppress has the higher priority. |
| Suppress When No Records | Specifies whether to display the object in the report results when no record is returned to its parent data component.
Data type: Boolean |
| Excel | |
| Column Index | 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 | Specifies the number of columns which will be the object's width in the exported Excel or CSV file. The Columned property at the report level must be set to true for this property to take effect.
Data type: String |
| Row Index | 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 | Specifies the number of rows which will be the object's height in the exported Excel or CSV file. 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 | Specifies a string or formula 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 | Specifies whether to include the object in the TOC Browser for the report.
Data type: Boolean |
| Platform (not available to organization chart) | |
| Anti-aliasing | Specifies whether to make the edges in a chart smooth.
Data type: Boolean |
| Color When Null | Specifies the color when the value is null. This property is available to heat map only and is applied when the heat map is colored only by a summary.
Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data Type: String |
| Color When Zero | Specifies the color mapping to the zero value. Available to heat map only. It works when the heat map is colored only by a summary and the Using Color When Zero property is set to true.
Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data Type: String |
| End Color | Specifies the end color of the gradient colors. This property is available to heat map only and is applied when the heat map is colored only by a summary.
Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
| Minimum Tick Mark Space | Specifies the minimum space between two adjacent tick marks. Enter a numeric value to change the space.
Data type: Float |
| Pattern List | 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.
For heat maps, the Pattern List property works only when using single color and using groups as the color-by fields. Data type: String |
| Reverse | Specifies whether to reverse the start color and the end color. This property is available to heat map only and is applied when the heat map is colored only by a summary.
Data type: Boolean |
| Show Legend | Specifies whether to make the legend visible in a chart.
Data type: Boolean |
| Start Color | Specifies the start color of the gradient colors. This property is available to heat map only and is applied when the heat map is colored only by a summary.
Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color. Data type: String |
| Using Color When Zero | Specifies whether to map the zero value to the color specified by the property Color When Zero.
This property is available to heat map only and is applied when the heat map is colored only by a summary. Data type: Boolean |
| Background | |
| Border Color | 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 enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Border End Caps | Specifies the ending style of the platform border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Joint | Specifies the joint style of the platform border line. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Outlined | 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 | Specifies the line style of the platform border. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Thickness | Specifies the width of the platform border. Enter a numeric value to change the thickness.
Data type: Float |
| Border Transparency | Specifies the transparency of the platform border, in percent. Enter a numeric value to change the transparency.
Data type: Integer |
| Border Type | Specifies the border type of the platform. Choose an option from the drop-down list.
Data type: Enumeration |
| Border Variable Dash | Specifies whether to resize the dash automatically.
Data type: Boolean |
| Color | Specifies the color of the platform background, applied when the property Fill Type is set to color. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Fill Transparency | Specifies the transparency of the platform background, in percent. Enter a numeric value to change the transparency.
Data type: Integer |
| Fill Type | Specifies the fill pattern for the platform background. Choose an option from the drop-down list.
Data type: Enumeration |
| Gradient End Color | Specifies the color of the point where the gradient ends, applied when the property Fill Type is set to gradient. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Gradient End X | Specifies the horizontal position where the gradient ends, measured in a percentage of the platform width. Applied when the property Fill Type is set to gradient.
Data type: Integer |
| Gradient End Y | Specifies the vertical position where the gradient ends, measured in a percentage of the platform height. Applied when the property Fill Type is set to gradient.
Data type: Integer |
| Gradient Start Color | Specifies the color of the point where the gradient begins, applied when the property Fill Type is set to gradient. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Gradient Start X | Specifies the horizontal position where the gradient begins, measured in a percentage of the platform width. Applied when the property Fill Type is set to gradient.
Data type: Integer |
| Gradient Start Y | Specifies the vertical position where the gradient begins, measured in a percentage of the platform height. Applied when the property Fill Type is set to gradient.
Data type: Integer |
| Gradient Style | Specifies the gradient style for the platform background, applied when the property Fill Type is set to gradient. Choose an option from the drop-down list.
Data type: Enumeration |
| Image File | Specifies the file name of the image, a portion of which will be displayed as the platform background. Applied when Fill Type is set to image. Enter 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 | 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 the property Fill Type 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 | Specifies the layout style for the image that will be displayed as the platform background, applied when the property Fill Type is set to image. Choose an option from the drop-down list.
Data type: Enumeration |
| Image Width | 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 the property Fill Type 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 | 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 the property Fill Type 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 | 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 the property Fill Type 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 | 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 | 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 | 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 | 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 | Specifies the radius for the joint of the platform border line. The property takes effect only when Border Joint is set to joint round. Enter a numeric value to change the radius.
Data type: Float |
| Texture Background Color | Specifies the background color of the texture, applied when the property Fill Type is set to texture. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Texture Foreground Color | Specifies the foreground color of the texture, applied when the property Fill Type is set to texture. Choose a color from the drop-down list or select Custom to customize a color. You can also enter a hexadecimal RGB value (for example, 0xff0000) to specify a color.
Data type: String |
| Texture Style | Specifies the texture style of the platform background, applied when the property Fill Type is set to texture. Choose an option from the drop-down list.
Data type: Enumeration |
| Data (not available to organization chart) | |
| For heat map | |
| Color by Logarithm | Specifies whether to calculate the color-by summary based on logarithm function. Available to heat map only. Choose an option from the drop-down list:
Data type: String |
| Size by Logarithm | Specifies whether to calculate the size-by summary based on logarithm function. Available to heat map only. Choose an option from the drop-down list:
Data type: String |
| For other chart types | |
| Category Data Mapping File | Specifies the data mapping file to the object for NLS use, which takes effect for category values shown on the category (X) axis and the hints of the data markers.
For example, if the data mapping file name is Category_de_DE.properties, set the value as Category (without the language and locale part). Data type: String |
| Category End Offset | The four properties work together to control the range of the data being displayed on a chart: Category Start Offset, Category End Offset, Series Start Offset, and Series End Offset.
Category End Offset specifies the ending offset of the categories. It does not apply to the charts which involve only one group. Data type: Integer |
| Category Format | Specifies the data format for the category axis (the X axis) to display the tick mark labels in the way you choose. Select in the value cell to specify the format in the Data Format dialog.
Data type: String |
| Category Range Data Mapping File | Specifies the data mapping file to the object for NLS use, which takes effect for the special group values shown in the range of the category axis in a chart.
For example, if the data mapping file name is Category_de_DE.properties, set the value as Category (without the language and locale part). Data type: String |
| Category Start Offset | The four properties work together to control the range of the data being displayed on a chart: Category Start Offset, Category End Offset, Series Start Offset, and Series End Offset.
Category Start Offset specifies the starting offset of the categories. It does not apply to the charts which involve only one group. Data type: Integer |
| Category Value Encoding | Specifies the encoding format for values on the category axis. Choose an option from the drop-down list.
Data type: String |
| Hint Percent Format | Specifies the format for each hint percentage to the total. Select in the value cell to specify the format in the Data Format dialog.
Data type: String |
| Hint Value Format | Specifies the number format for the hint message. Select in the value cell to specify the format in the Data Format dialog.
Data type: String |
| Hyperlink | Specifies to add a hyperlink that refers to another report or a website to the data markers of the chart. Enter the URL of the report or website in the value cell.
Data type: String |
| Hyperlink Target | Specifies the target window or frame in which to display the content the Hyperlink property specifies. Choose an option from the drop-down list.
Data type: String |
| Motion Bar Format | Specifies the data format for the motion field values displayed on the motion bar. Select in the value cell to specify the format in the Data Format dialog.
Data type: String |
| Overall Series | Specifies whether to calculate the top or bottom N category values based on the series values.
Data type: Boolean |
| Primary Data Format | Specifies the data format for the primary value axis (the Y1 axis) to display the tick mark labels in the way you choose. Select in the value cell to specify the format in the Data Format dialog.
Data type: String |
| Reverse Category | Specifies whether to reverse the sequence of the category field value.
Data type: Boolean |
| Reverse Series | Specifies whether to reverse the sequence of the series field value.
Data type: Boolean |
| Secondary Data Format | Specifies the data format for the secondary value axis (the Y2 axis) to display the tick mark labels in the way you choose. Select in the value cell to specify the format in the Data Format dialog.
Data type: String |
| Series Data Mapping File | Specifies the data mapping file to the object for NLS use, which takes effect for series values shown in the legend and the hints of the data markers. Not available to bubble chart.
For example, if the data mapping file name is Category_de_DE.properties, set the value as Category (without the language and locale part). Data type: String |
| Series End Offset | The four properties work together to control the range of the data being displayed on a chart: Category Start Offset, Category End Offset, Series Start Offset, and Series End Offset.
Series End Offset specifies the ending offset of the series. Data type: Integer |
| Series Format | Specifies the data format for the series axis (the Z axis) to display the tick mark labels in the way you choose. Select in the value cell to specify the format in the Data Format dialog.
Data type: String |
| Series Start Offset | The four properties work together to control the range of the data being displayed on a chart: Category Start Offset, Category End Offset, Series Start Offset, and Series End Offset.
Series Start Offset specifies the starting offset of the series. Data type: Integer |
| Series Value Encoding | Specifies the encoding format for values on the series axis. Choose an option from the drop-down list.
Data type: String |
| Sort Category | Specifies the sorting order for the category field values. Choose an option from the drop-down list.
Data type: Enumeration |
| Sort Series | Specifies the sorting order for the series field values. Choose an option from the drop-down list.
Data type: Enumeration |
| Swap Groups | Specifies to display values from different data fields by switching data between the category and series axes, the category and value axes of a chart. By default, this property is set to false, which means no switch will take place in the chart. When it is set to true:
Data type: Boolean Note: If the chart has only one field on the category axis and one on the value axis, even though the property value is set to true, there will be no switch take place on the two axes. |
| X HyperLink | Specifies to add a hyperlink that refers to another report or a website to the X axis labels. Enter the URL of the report or website in the value cell.
Data type: String |
| X Hyperlink Target | Specifies the target window or frame in which to display the content the X Hyperlink property specifies. Choose an option from the drop-down list.
Data type: String |
| Z HyperLink | Specifies to add a hyperlink that refers to another report or a website to the Z axis labels. Enter the URL of the report or website in the value cell.
Data type: String |
| Z Hyperlink Target | Specifies the target window or frame in which to display the content the Z Hyperlink property specifies. Choose an option from the drop-down list.
Data type: String |