Chart

The properties of a chart object, inclduing a KPI chart are as follows. A chart object can have the following child objects: Chart Label, Chart Legend, Chart Paper, as well as Heat Map Rectangle and Heat Map Rectangle Title for a heat map chart, and Org Chart Line and Org Chart Node for an org chart.

Property Name	Description
General
Display Name	Specifies the display name of the object. Data type: String
Instance Name	Shows the instance name of the object. This property is read only.
Geometry
Height	Specifies the height of the object, in inches. Enter a numeric value to change the height. Data type: Float
Width	Specifies the width of the object, in inches. 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 unavailable if the Position property is set to static. Enter a numeric value to change the position in inches. Data type: Float
Y	Specifies the vertical coordinate of the top left corner of the object, relative to its parent container. This property is unavailable if the Position property is set to static. Enter a numeric value to change the position in inches. Data type: Float
Others
Auto Scale in Number	Specifies whether to automatically scale the values that are of the Number data type in the object when the values fall into the two ranges: When 1000 <= value < 10^15, the following quantity unit symbols of the International System of Units are used to scale the values: K (10^3), M (10^6), G (10^9), and T (10^12). When 0 < value < 0.001 or value >= 10^15, scientific notation is used to scale the values. 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 in Web Report Studio or when the report is opened in Web 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 or hide the object. All formulas and calculations will still be performed if the property is set to true. You can also use a formula to control whether or not to show the object. Data type: Boolean
Position	Specifies the position of the object. Available when the object is directly contained in the report body or a tabular cell. absolute - The object's position will be decided by its X and Y property values. static - The object will be positioned at the default location in its container. If selected, the X, Y and other position-related properties will be hidden or disabled. Data type: Enumeration
Platform
Minimum Tick Mark Space	Specifies the minimum space between two adjacent tick marks. Enter a numeric value to change the space. Data type: Float
Show Legend	Specifies whether to make the legend visible in a chart. Unavailable to KPI charts. 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 define a color in the Color Picker dialog. 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 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. Enter a numeric value to change the thickness. Data type: Float
Border Transparency	Specifies the color 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 - If selected, the dash size will be adjusted automatically. false - If selected, the dash size will be of fixed size. Data type: Boolean
Color	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 define a color in the Color Picker dialog. 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 color, 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. None - No fill (default). Color - Fills with a specified color. More Effects - Specifies either a gradient or an image as the fill effect in the Fill Effects dialog. Data type: Enumeration
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
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. Select in the value cell to specify the format in the Data Format dialog. 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
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. For details about the format of the URL used to run a report, refer to Running Reports. 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. <Server Setting> - Loads the linked file according to setting of the Pop Up New Window for Links option. 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 selected, you can also directly input the name of the frame you have defined in the text box. 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. 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 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
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: If the chart has fields on all of its axes, data on the category and series axes will be switched. If the chart has one field on the category axis and several on the value axis, data on the category and value axes will be switched. 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. For details about the format of the URL used to run a report, refer to Running Reports. 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. <Server Setting> - Loads the linked file according to setting of the Pop Up New Window for Links option. 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 selected, you can also directly input the name of the frame you have defined in the text box. If the frame name does not exist, the linked file will be loaded into a new window. Data type: String

Border Type

Specifies the border type of an object. Can be one of the following:

None
The object has no visible border lines.
Raised
The object has 3-D borders that appear as if they are raised off the page.
Recess
The object has 3-D borders that appear as if they are pressed into the page.
Shadow
The object has two shadowed borders, beneath and to the right of the object.
Solid
The object has single-line borders.

Border End Caps

Specifies the ending style of the border line. Can be one of the following:

Butt
Ends unclosed subpaths and dash segments with no added decoration.
Round
Ends unclosed subpaths and dash segments with a round decoration that has a radius equal to half of the width of the pen.
Square
Ends unclosed subpaths and dash segments with a square projection that extends beyond the end of the segment to a distance equal to half of the line width.

Border Joint

Specifies the joint style. Can be one of the following:

Miter
Joins path segments by extending their outside edges until they meet.
Round
Joins path segments by rounding off the corner at a radius of half the line width.
Bevel
Joins path segments by connecting the outer corners of their wide outlines with a straight segment.
Joint Round
Joins path segments by rounding off the corner at the specified radius. Available only for chart platform.

Start Offset(1st.Data.Set), End Offset(1st.Data.Set), Start Offset(2nd.Data.Set), and End Offset(2nd.Data.Set)

These four properties are used to control the data source range that appears on the chart.

For 2-level-group charts, record-level charts and all kinds of combination charts, Start Offset(1st.Data.Set) and End Offset(1st.Data.Set) are used to control the starting offset and ending offset of the data series; Start Offset(2ndDataSet) and End Offset(2nd Data.Set) are used to control the range of the categories.

For 1-level-group charts, Start Offset(2nd.Data.Set) and End Offset(2nd.Data.Set) are used to control the starting offset and ending offset of the categories; Start Offset(1st.Data.Set) and End Offset(1st.Data.Set) will not work because there is no series data in chart that contains only one group.

The range of the property values can be -1 (Default, Not Set) or an integer between 0 and Number of Data Series – 1 (or, Number of Categories - 1).

If the value is out of this range, the following rules will be applied to the default value:

IF	THEN
Start Offset(1st.Data.Set) < 0	Start Offset(1st.Data.Set) = 0
Start Offset(1st.Data.Set) > max data number	Start Offset(1st.Data.Set) = max data number
End Offset(1st.Data.Set) < 0	End Offset(1st.Data.Set) = max data number
End Offset(1st.Data.Set) > max data number	End Offset(1st.Data.Set) = max data number
Start Offset(1st.Data.Set) > End Offset(1st.Data.Set) and EndOffset(1st.Data.Set) >=0	Start Offset(1st.Data.Set) = 0, End Offset(1st.Data.Set) = max data number

Same rules apply to Start Offset(2nd.Data.Set) and End Offset(2nd.Data.Set).

Previous Topic Next Topic