Chart platform

A chart platform is a container for other chart elements. You can use the properties listed in the following table to control the appearances or behavior of a chart platform. In the Report Inspector, a chart platform is displayed as ChartObject by default.

The properties of a chart platform are:

Property Name Description
General
Class Type Indicates the class type of the object. This property is read only.
Data Inherit Indicates whether the dataset for this object is inherited from another object. This property is read only.
Dataset Indicates the dataset used by the object. This property is read only.
Instance Name Shows the instance name of the object. This property is read only.
Geometry
Height Specifies the height of the object, in inches or centimeters. Enter a numeric value to change the height.

Data type: Float
Width Specifies the width of the object, in inches or centimeters. 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 in inches or centimeters.

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 in inches or centimeters.

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.
  • Specifies a style to be applied to the object. Choose a style from the drop-down list which is available when a Style Group has been selected at the report tab level and when there are styles in the Style Group that can be applied to the object, or type in the style name.
  • Specifies a CSS selector to be applied to the object. Enter a valid class name from the CSS file.

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
Cache Specifies whether to cache the dataset for this object in the data buffer so other objects which use the same dataset can share the data rather than perform their own SQL query.

Data type: Boolean
Export to CSV Specifies whether to include the object when exporting the report to CSV.

Data type: Boolean
Export to DHTML Specifies whether to include the object when exporting the report to DHTML.

Data type: Boolean
Export to Excel Specifies whether to include the object when exporting the report to Excel.

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
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:

  • The next visible table cell should be completely empty, that is, the cell should not hold any content including blank space.
  • When the property for several objects in the same row is set to next visible column, and the columns holding these objects are all hidden, then only the object in the rightmost column will be shown in the next visible cell.
Run in Flash Specifies whether to use flash to run the object. Flash gives the object a lively animation effect. This property is available to library components only, while is not supported on bullet charts.

When running a chart in flash, if there is not any web behavior bound to legend items, clicking an unselected legend item will filter the chart data based on the clicked legend item, and the state of the item will change to be selected. Then clicking the selected item will unselect it, and the chart data will be restored removing the filter condition generated from the selection of the legend item.

In order to run objects using flash, your web browser needs to install a flash player plug in.

Data type: Boolean
Position Specifies the position of the object. Choose an option from the drop-down list.
  • static - The object is positioned at the location in which it is inserted. If selected, the X, Y and other position-related properties will be hidden or disabled. The position of the object is affected by preceding objects in the same container.
  • absolute - The object will be located at the position specified by dragging and dropping or by setting its X and Y property values. The position of the object is not affected by preceding objects in the same container.

Data type: Enumeration

Note: This property only affects objects with a parent container that is the report body, a table cell, a tabular cell, or a text box.
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. Not supported in web reports or library components.

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 container. Not supported in web reports or library components.

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 tab 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 tab 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 tab 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 tab 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
Anti-aliasing Specifies whether to make the edges in a chart smooth.

Data type: Boolean
Pattern List Specifies patterns of the data markers. Click in the value cell and click 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
Show Legend Specifies whether to make the legend visible in a chart.

Data type: Boolean
Background
Border Color Specifies the color of the platform border. Choose a color from the drop-down list, enter a hexadecimal RGB value (0xCCAA00), choose a formula that returns a color, or select Custom from the drop-down list to specify the 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, in inches or centimeters. 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.
  • true - The dash size will be adjusted automatically. And the option Auto Adjust Dash in the Format Platform dialog will take effect.
  • false - The dash size will be of fixed size. And the option Fixed Dash Size in the Format Platform dialog will take effect.

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, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the color and fill effect.

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, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the color and fill effect.

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, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the color and fill effect.

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 filename of the image, a portion of which will be displayed as the platform background. Applied when Fill Type is set to image. Enter the filename 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, enter a hexadecimal RGB value (e.g. 0xff0000) or choose a formula that returns a color. , choose a formula that returns a color, or select Custom from the drop-down list to specify the 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, enter a hexadecimal RGB value (e.g. 0xff0000), choose a formula that returns a color, or select Custom from the drop-down list to specify the 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
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. Click in the value cell to specify the format.

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. Click in the value cell to specify the format.

Data type: String
Hint Value Format Specifies the number format for the hint message. Click in the value cell to specify the format.

Data type: String
Hyperlink Specifies whether to add a hyperlink that refers to another report or a website to the chart.

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 or directly input the name of the frame you have defined.
  • <Server Setting>
    Loads the linked file according to setting of the Pop Up New Window for Links option in the Configure DHTML Profile panel of the Profile dialog in JReport Server.
  • New Window
    Loads the linked file into a new window. The window is not named.
  • Whole Window
    Loads the linked file into the full browser window.
  • Same Frame
    Loads the linked file into the same frame as the link.
  • Parent Frame
    Loads the linked file into the parent frame of the frame that contains the link.
  • Other Frame
    Loads the linked file into some other specified frame. If the frame name does not exist, the linked file will be loaded into a new window.

Data type: String
Motion Bar Format Specifies the data format for the motion field values displayed on the motion bar. Click in the value cell to specify the format.

Data type: String
Go to Detail Specifies whether to show the detailed information when you click the object in JReport Viewer. This property is available only when the object is in the group header/footer panel of a banded object. For details about its usage, refer to Obtaining detailed information from a banded object.

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. Click in the value cell to specify the format.

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. Click in the value cell to specify the format.

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. Click in the value cell to specify the format.

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.
  • Switching between the category and series axes
    If you create a chart by adding fields to all of its axes, and set Swap Groups to true, data on the category and series axes will be switched.
  • Switching between the category and value axes
    If you create a chart by adding one field to the category axis and several to the value axis, and set Swap Groups to true, data on the category and value axes will be switched.

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 whether to add a hyperlink that refers to another report or a website to the X axis labels.

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 or directly input the name of the frame you have defined.
  • <Server Setting>
    Loads the linked file according to setting of the Pop Up New Window for Links option in the Configure DHTML Profile panel of the Profile dialog in JReport Server.
  • New Window
    Loads the linked file into a new window. The window is not named.
  • Whole Window
    Loads the linked file into the full browser window.
  • Same Frame
    Loads the linked file into the same frame as the link.
  • Parent Frame
    Loads the linked file into the parent frame of the frame that contains the link.
  • Other Frame
    Loads the linked file into some other specified frame. If the frame name does not exist, the linked file will be loaded into a new window.

Data type: String
Z HyperLink Specifies whether to add a hyperlink that refers to another report or a website to the Z axis labels.

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 or directly input the name of the frame. If the frame name does not exist, the linked document will be loaded into a new window.
  • <Server Setting>
    Loads the linked file according to setting of the Pop Up New Window for Links option in the Configure DHTML Profile panel of the Profile dialog in JReport Server.
  • New Window
    Loads the linked file into a new window. The window is not named.
  • Whole Window
    Loads the linked file into the full browser window.
  • Same Frame
    Loads the linked file into the same frame as the link.
  • Parent Frame
    Loads the linked file into the parent frame of the frame that contains the link.
  • Other Frame
    Loads the linked file into some other specified frame. If the frame name does not exist, the linked file will be loaded into a new window.

Data type: String
Accessibility
External CSS Class Selector Specifies a class selector to be applied to the object when exported as HTML. Enter a valid class name from the CSS file.

Data type: String
External ID A representation of the standard HTML attribute id. This attribute specifies a name to the object, which must be unique in the report.

Data type: String
External Title A representation of the standard HTML attribute title. This attribute offers advisory information about the object.

Data type: String
LongDesc A representation of the standard HTML attribute longdesc. This attribute specifies a link to a long description of the object.

Data type: String