Siebel Reports Administration Guide > Using Graphics in Reports >

Chart Control Properties


The property settings for a chart control are set in the Component Editor. Access the Component Editor by right-clicking the chart, choosing Properties from the pop-up menu, and clicking the Properties tab. Summary and detail charts have the same set of available properties, with the exception of the properties in the Expressions category, which differ between the two types.

The properties for a chart control, arranged by property category (the folder you must expand to view the property), are described in Table 15.

Table 15.  Chart Properties by Property Category
Category
Property
Description
 
TargetWindow Name
The name of the target window in which the contents of a hyperlink appear.
Advanced
LinkExp
The expression defining a hyperlink for this chart object.
ObjectVariable
The name of an optional method in the frame that will point to this chart object.
Expressions (in AcDetailChart only)
XLabelExp
Contains a data row variable, in square brackets, from which a text x-axis label can be obtained for each point. Note that values are not aggregated for each label.
XValueExp
Contains a data row variable, in square brackets, that supplies the X value for each data point. For example, in a scatter chart that plots revenue on the y-axis against sales stage on the x-axis, the setting for this property would be [ssSales_Stage].
YValueExp
Contains a data row variable, in square brackets, that supplies the Y value for each data point. For example, in a scatter chart that plots revenue on the y-axis against sales stage on the x-axis, the setting for this property would be [ssRevenue].
Expressions (in ssSummaryGraph only)
CategoryExp
Contains a data row variable or expression that specifies the category, that is, the x-axis value that groups data. This should normally evaluate to an integer. For example, in a summary chart that groups opportunities by month, the category key would be:
Year([ssClose_Date]) * 12 + Month([ssClose_Date]) -1
CategoryLabelExp
Contains a data row variable or expression that provides the text label for each category. For example, in a summary chart that groups opportunities by month, the category label expression would be:
[ssClose_Date_ Formatted]
SeriesExp
Contains a data row variable or expression that specifies the series (z-axis) for the data point, that is, the value that determines which bar color or line chart curve the point appears in. This should normally evaluate to an integer.
SeriesLabelExp
Contains a data row variable or expression that provides the text label to appear in the legend for each series.
YValueExp
Contains a data row variable or expression that supplies the Y value for each data point. For example, in a summary chart that displays opportunity revenue by month, the value expression would be:
Sum(Val([ssRevenue]))
General
BackgroundColor
Background color of the chart.
ChartBackgroundColor
Color of the rectangle around the chart.
ChartBorderStyle
Style for the border around the chart. Options are ChartNoBorder, ChartSolidBorder, ChartDropShadow, ChartShadowAndBorder, ChartRaisedBorder, and ChartLoweredBorder.
PointLabelAlignment
Enumerated. The options are:
  • ChartHorizontalAlignment aligns the point labels horizontally.
  • ChartVerticalAlignment aligns the point labels vertically.
  • ChartAutoAlignment tilts the data point labels such that they do no overlap.
PointLabelColor
The color of the labels displayed for each point.
PointLabelStyle
The style of the labels displayed for each point. Options are ChartNoPointLabels, ChartCustomLabels, ChartNumericLabels, ChartColoredNumericLabels, and ChartColoredCustomLabels.
ValuesColorList
A comma-separated list of color names or RGB values to identify different data series.
ChartType-Specific
BarGrouping
Specifies that a bar chart is clustered, stacked, or without clustering or stacking. Ignored for charts other than bar charts. Options are ChartBarNoGrouping, ChartBarCluster, ChartBarClusterZ (3D only), ChartBarStack, and ChartBarStackPercentage.
BarOrientation
Specifies that a bar chart has horizontal or vertical bars. Ignored for charts other than bar charts. Options are ChartBarVertical, ChartBarHorizontal, and ChartBarHorizontalReversed.
ChartType
Specifies the chart type. Option are Chart2DPie, Chart3DPie, Chart2DBar, Chart3DBar, ChartLine, Chart2DArea, Chart2DScatter, ChartHLC, ChartTape, ChartOHLC, Chart2DArea, and Chart3DArea.
 
HLCBarStyle
HLC and OHLC charts only. Determines how the chart displays high, low, and close tick marks. Options are ChartHLCAllBars, ChartHLCThickBars, ChartHLCNoClose, and ChartHLCNoBars.
LineStyle
Specifies that a line chart has solid lines of default thickness, broken lines of a particular pattern, or thick lines. Applies to line charts only. Options are ChartDefaultLines, ChartPatternLines, and ChartThickLines.
LineStylesList
Line charts only. A comma-separated list of line styles, one style for each data set. Options are SingleLine, DashLine, DotLine, DashDotLine, DashDotDotLine, and NullLine.
LineThickness
Line and scatter charts only. Specifies the thickness of lines in chart-specific units.
PointsArePercent
Area charts only. TRUE indicates that the numbers on the data points are percentage figures. FALSE indicates that the points are absolute numbers.
ShowAsPercent
Area charts and pie charts only. Draws the chart showing the percentage of each data point as the sum of all points in that dataset. The area always fills the full chart height.
ShowLines
Line, log/lin, lin/log, and log/log charts only. TRUE shows lines connecting the points.
ShowSticks
Line, log/lin, lin/log, log/log, and scatter charts only. TRUE shows lines from the y-axis to each point.
ShowSymbols
Line, log/lin, lin/log, log/log, and scatter charts only. TRUE shows symbols for each point.
HTML
Alignment
Specifies the alignment of the chart window within the flow of text in the report.
AlternateText
In browsers that do not support Java applets, specifies the text that appears in place of the chart.
BorderWidth
The number of pixels of thickness of the border around the chart.
Margin
The number of pixels of horizontal and vertical space between the window and the surrounding text.
UseDefaultSize
Determines whether to use the default image size computed by the browser. If it is set to TRUE, the system does not generate the height and width HTML attributes. If FALSE, the system generates these attributes from the Size property.
Legend
LegendBackgroundColor
Background color for the legend.
LegendBorderStyle
The style of the box to draw around the legend. Options are ChartNoBorder, ChartSolidBorder, ChartDropShadow, ChartShadowAndBorder, ChartRaisedBorder, and ChartLoweredBorder.
LegendColorText
TRUE if the legend entries are the same color as the lines, points, or bars they identify. FALSE if they are all the color given by Legend.LegendFont.Color.
LegendFont
A group of properties that defines the font of the legend labels, including Bold, Color, FaceName, Italic, and so on.
LegendPosition
The position of the legend. Defaults to ChartLegendRight.
Titles
TitleBackground Color
Background color for the rectangle enclosing the title.
TitleBorderStyle
Style for the border around the title. Options are ChartNoBorder, ChartSolidBorder, ChartDropShadow, ChartShadowAndBorder, ChartRaisedBorder, and ChartLoweredBorder.
TitleFont
A set of properties that defines the font for the chart title.
TitleText
Title that appears above the chart.
TOC
TocAddComponent
Determines whether the component name is added to the report's table of contents. The values are:
TOCAlwaysAdd. Always add the component to the table of contents.
TOCIfAllVisible. Add component name to the table of contents only if the user can view at least one page generated from the component based on page security. This is the default.
TOCIfAnyVisible. Add component to table of contents even if the user cannot view any pages generated from the component based on page security.
TOCSkip. Never add the component to the table of contents. Use this to hide components such as parallel or sequential sections or detail frames from the user.
TocAddContents
Determines whether the component's contents are added to the report's table of contents.
TocValueExp
Returns a string to show as the table of contents entry for this object.
Viewing
CursorShape
The kind of cursor to show when the mouse cursor passes over the chart object.
HelpText
The text to show for this chart object when the user asks for help.
Searchable
Specifies whether the chart object can be searched in the Viewer.
SearchAlias
The name to display to the user when building a search for this chart object.
Selectable
TRUE if the user can select this chart object in the Viewer.
Visual
Position
The position of the chart object in its enclosing frame.
Size
The size of the chart object.
X-Axis
XAxisPosition
The position of the x-axis. Options are ChartXAxisAuto, ChartXAxisTop, and ChartXAxisBottom.
XAxisColor
Color of the axis lines.
XAxisOrigin
The location of the chart origin. Options are ChartZeroOrigin, ChartAutoOrigin, and ChartCustomOrigin.
XLabelFont
A set of properties that defines the font for the x- axis values labels, and that of the data labels adjacent to each point.
XLabelFormat
The format string used to create custom x-axis labels.
XLabelsList
A comma-separated list of quoted x-axis values.
XLabelStyle
The kind of labels to show along the x-axis. Options are the following:
ChartNoLabels. Displays no labels.
ChartAutoLabels. Displays labels computed automatically.
ChartCustomLabels. Displays custom labels based on the information you enter in the XLabelsList property.
ChartExpressionLabels. Displays labels computed from an expression you specify in the LabelExp property.
XMajorGridStyle
The style of line to draw for the major grid lines. Options are SingleLine, DashLine, DotLine, DashDotLine, DashDotDotLine, and NullLine.
 
XMajorTickCount
The number of ticks to display. For charts with X values, this is the number of ticks to display. For charts without X values, this is the frequency of the ticks (that is, points per tick).
XMajorTickStyle
The kind of tick marks to include. Options are ChartNoTicks, ChartAutoTicks, and ChartCustomTicks.
XMax
Sets the maximum x-axis limit. This value is computed when the chart is displayed. When the chart is being designed, this value is used for displaying sample data.
XMin
Sets the minimum x-axis limit. This value is computed when the chart is displayed. When the chart is being designed, this value is used for displaying sample data.
XMinorGridStyle
The style of line to draw for the minor grid lines.
XShowMinorTicks
TRUE indicates that the chart displays minor tick marks. If so, there will always be five minor tick marks between two major tick marks.
XTitle
The text of the label to show for the x-axis.
XTitleBackGround Color
The background color of the x-axis title.
XTitleBorderStyle
The style of the rectangle that encloses the x-axis title. Options are ChartNoBorder, ChartSolidBorder, ChartDropShadow, ChartShadowAndBorder, ChartRaisedBorder, and ChartLoweredBorder.
XTitleFont
A set of properties that defines the font of the x- axis.
XValueSet
Indicates how the system should determine how many x-axis values are available.
ChartDefaultXValues. No x-axis values are available; the Chart should provide default spacing along the x-axis.
ChartXValuePerDataSet. There is one set of x-axis values provided in the points for the first (or only) data set that apply to all points.
ChartXValuePerPoint. Each point has its own X value.
XVerticalLabels
TRUE to show x-axis labels vertically instead of horizontally.
Y-Axis
DualYAxisColor
Color of the axis lines.
DualYLabelFont
A set of properties that defines the font for the y- axis values labels, and that of the data labels adjacent to each point.
DualYTitleFont
A set of properties that defines the font of the y-axis titles.
YAxisColor
Color of the axis lines.
YAxisPosition
The position of the y-axis. Options are ChartYAxisAuto, ChartYAxisLeft, and ChartYAxisRight.
YAxisOrigin
The location of the chart origin. Options are ChartZeroOrigin, ChartAutoOrigin, and ChartCustomOrigin.
YLabelFont
A set of properties that defines the font for the y- axis values labels, and that of the data labels adjacent to each point.
YLabelFormat
The format string used to create custom y-axis labels.
YLabelsList
A comma-separated list of quoted y-axis values.
YLabelStyle
The kind of labels to show along the y-axis. Options are the following:
ChartNoLabels. Displays no labels.
ChartAutoLabels. Displays labels computed automatically.
ChartCustomLabels. Displays custom labels based on the information you enter in the XLabelsList property.
ChartExpressionLabels. Displays labels computed from an expression you specify in the LabelExp property.
YMajorGridStyle
The style of line to draw for the major grid lines. Options are SingleLine, DashLine, DotLine, DashDotLine, DashDotDotLine, and NullLine.
YMajorTickCount
The number of ticks to display. For charts with y-axis values, this is the number of ticks to display. For charts without y-axis values, this is the frequency of the ticks.
YMajorTickStyle
The kind of tick marks to include. Options are ChartNoTicks, ChartAutoTicks, and ChartCustomTicks.
 
YMax
Sets the maximum y-axis limit. This value is computed when the chart is displayed. When the chart is being designed, this value is used for displaying sample data.
YMin
Sets the minimum y-axis limit. This value is computed when the chart is displayed. When the chart is being designed, this value is used for displaying sample data.
YMinorGridStyle
The style of line to draw for the minor grid lines. Options are ChartDefaultLines, ChartPatternLines, and ChartThickLines.
YShowMinorTicks
TRUE indicates that the chart displays minor tick marks. If so, there will always be five minor tick marks between two major tick marks.
YTitle
The text of the label to show for the y-axis.
YTitleBackGround Color
The background color of the y-axis title.
YTitleBorderStyle
The style of the rectangle that encloses the y-axis title. Options are ChartNoBorder, ChartSolidBorder, ChartDropShadow, ChartShadowAndBorder, ChartRaisedBorder, and ChartLoweredBorder.
YTitleFont
A set of properties that defines the font of the y-axis titles.
YTitleOrientation
Determines how the text appears for the y-axis title. The default is ChartYLabelUp, which rotates the text 90 degrees counterclockwise. Options are ChartYLabelHoriz, ChartYLabelUp, and ChartYLabelDown.
YVerticalLabels
TRUE to show x-axis labels rotated 90 degrees.


 Siebel Reports Administration Guide 
 Published: 18 July 2003