Siebel Object Types Reference > Siebel Object Types Reference > Applet Object Types >

Chart Element


A chart element specifies one of the static characteristics of a chart, including title, legend, labels, chart body, or axis.

This object type occurs in the following location in the object hierarchy:

Table 20 describes properties that Siebel CRM uses with a chart element. Each property applies to only some types of chart elements. For more information, see Properties That Siebel CRM Uses for Different Types of Chart Elements.

Table 20. Properties of the Chart Element
Property
Description

Axis Id (O)

Specifies the axis to which subsequent axis elements apply. Applies to the AxisLabel, AxisLineGrid, and AxisTitle elements. To view the values you can use, click the Axis Id property in Siebel Tools.

Color (O)

Specifies color for all elements. In particular, it specifies color for the following elements:

  • Sets the text color for elements that contain text.
  • Sets the fill color for the Plot element, chart element, and the HorizArea graphic.
  • Sets the line color for the Axis Line Grid element and the Line, Rectangle, Ellipse, and HorizLine graphics.

The value you enter must use the following format:

  • A space-separated red, green, blue triplet with each value in the range 0 through 255.

Coordinates (O)

For more information, see Configuring the Coordinates Property of a Chart Element.

Display Format (O)

Specifies the format for the label of the AxisLabel element on the axis that the Axis Id property specifies. If this property:

  • Includes a value. Siebel CRM applies the format string that this property specifies. It applies this format to the axis label before it displays the label in the chart.
  • Does not include a value. Siebel CRM applies the default format for the Category, Series, or Data Point Field business component field that it uses for the x-axis, z-axis, or y-axis.

You can use any format string that the Display Format accepts. For example:

0.##%

Divisions (O)

Specifies the number of divisions for the axis that the Axis Id property specifies. Applies to the AxisLabel element. It applies to the y-axis. It applies differently for the following charts:

  • Scatter chart. Applies to the x-axis and the y-axis.
  • Other charts. If the field values are numbers, then it applies to the x-axis or z-axis.
  • Histogram chart. The axis that the Axis Id property specifies must display numeric data. If it does not, then Siebel CRM displays labels and does not bucket data. To support a histogram chart, you must also specify the Coordinates property.

You can use any number greater than 0. If the Divisions property does not include a value, then Siebel CRM automatically calculates the number of divisions. For example, if the Divisions property includes the following value, then Siebel CRM draws five labels on the axis:

4

The Divisions property is required only for the x-axis and z-axis in a histogram chart.

Font Effect (O)(H)

Specifies format to apply to the font, such as StrikeThrough. Applies to the AxisLabel, AxisTitle, Legend, and Title elements. To view the values you can use, click the Font Effect property in Siebel Tools.

Font Name (O)

Specifies the font name that Siebel CRM uses for the element text. Applies to the Axis Label, Axis Title, and Title elements.

Font Size (O)

Specifies the font size that Siebel CRM uses for the element text. Applies to the Axis Label, Axis Title, and Title elements. Siebel CRM does the following:

  • If the chart is minimized, and if the screen resolution is 1024 by 768 or higher, then it applies this font size.
  • If the chart is maximized, then it uses a larger font.
  • If the screen resolution is lower, then it uses a smaller font.

Font Style (O)(H)

Specifies the font style that Siebel CRM uses for the element text, such as Bold. Applies to the AxisLabel, AxisTitle, Legend, and Title elements. To view the values you can use, click the Font Style property in Siebel Tools.

Graphic Type (O)

Specifies the type of graphic element that Siebel CRM draws. The Coordinates property specifies the graphic geometry. Applies to the Graphic element. To view the values you can use, click the Graphic Type property in Siebel Tools.

If you set the Type property of the chart element to Graphic, then you must set the Graphic Type property.

Line Style (O)

Specifies the line style that Siebel CRM uses for a Graphic or AxisLineGrid element. Applies to the AxisLineGrid and Graphic elements. Siebel CRM applies this property only if the Line Width property is 0 or is empty. To view the values you can use, click the Line Style property in Siebel Tools.

Line Width (O)

Specifies the line thickness that Siebel CRM uses. Applies to the AxisLineGrid and Graphic elements. You can use any positive number. The default value is 0, which is a thin line.

List Of Values (O)

Specifies the list of possible values for the x-axis, y-axis, or z-axis that the Axis Id property specifies. Applies to the AxisLabel element. This property allows the user to specify values that Siebel CRM does not display, such as 0 or an empty value.

If you apply this property to the y-axis, then Siebel CRM displays string values on the y-axis instead of numeric values.

If you specify a list of values on the AxisLabel label for the X axis, then Siebel CRM displays every value that this list contains even if the returned value in the Y axis is 0 or empty. It displays these values on the X axis.

By default, if the value is empty, then Siebel CRM uses only the corresponding field values that the current business component contains for a given axis.

This property uses the following format:

business_component,field_name,search_specification,sort_specification

where:

  • business_component identifies the name of the business component that the current business object references.
  • field_name identifies the business component field that Siebel CRM uses to get the values that it displays.
  • search_specification specifies the search specification that Siebel CRM uses on the business component.
  • sort_specification specifies the sort specification that Siebel CRM uses on the business component.

For example:

List Of Values,Value,Type = LEAD_QUALITY,Order By

For example:

Sales Cycle Def,Sales Cycle Stage,Sales Stage Order

Log Base (O)

Specifies to use a logarithmic axis instead of a linear axis. Applies to the AxisLabel element. You can use any positive number. For example:

  • If the value of the LogBase property is 10, then the axis displays 1, 10, 100, 1000, 10000, and so on.
  • if the value of the LogBase property is 2, then the axis displays 1, 2, 4, 8, 16, 32, 64, and so on.

Name (R)

Specifies the name for the chart element. This name must be unique in the chart object.

Show Category Legend (O)

Specifies to display a legend for the axis that the Axis Id property specifies. Siebel CRM applies this property only to the x-axis and z-axis for the AxisLabel element.

If the x-axis labels are long, or if a large number of labels exist, then the labels might overlap.

You can use one of the following values:

  • TRUE. Display the entire x-axis group label on the x-axis.
  • FALSE. Do not display the entire x-axis group label on the x-axis.

By default, if Siebel CRM displays more than one group on the x-axis legend, then it displays only the first three letters of each x-axis group.

Sort Specification (O)

Specifies the sort operation that Siebel CRM performs on the axis that the Axis Id property identifies. Applies to the x-axis, y-axis, or z-axis of the AxisLabel element. This property uses the following format:

order,field_name

where:

  • order is Ascending, Descending, or None.
  • field_name identifies the field that Siebel CRM sorts according to a column other than the category or series.

For example, the following setting configures Siebel CRM to sort the Sales Stage Order field in ascending order:

Ascending,Sales Stage Order

For the y-axis, Siebel CRM sorts the x-axis labels according to y-axis numeric values. If you specify a sort specification for the y-axis, then you cannot specify a sort specification for the x-axis.

If the List Of Values property contains a value, then Siebel CRM ignores the Sort Specification property.

Text (O)

Specifies the text that Siebel CRM displays for the AxisTitle, Legend, Title, or HorizLine element.

Type (O)

Specifies the type of chart element. Applies to all elements. To view the values you can use, click the Type property in Siebel Tools.

Vertical (O)

Specifies to display labels vertically on the x-axis. Applies to the AxisLabel element. Note the following:

  • If the x-axis contains less than five labels, then Siebel CRM ignores the Vertical property and displays all labels horizontally.
  • If a long label exists, then Siebel CRM moves the chart upward.
  • If the monitor is a low resolution, then space is limited.
  • Siebel CRM cannot display all fonts vertically.
  • The Vertical property does not apply to a Period chart.

You can use one of the following values:

  • TRUE. Display the labels vertically.
  • FALSE. Display the labels horizontally.

Configuring the Coordinates Property of a Chart Element

The Coordinates property of a chart element specifies coordinates for the Graphic and AxisLabel elements. This property is required for the following items:

  • Graphic elements
  • X-axis labels in a scatter chart
  • X-axis and z-axis labels in a histogram chart

Rectangle, Ellipse, and Line apply only to the scatter chart. HorizLine and HorizArea apply to all charts.

A histogram chart requires the following items:

  • Coordinates for the axes that the user categorizes
  • A value in the Divisions property.

The value you enter depends on the following type of element you specify:

  • AxisLabel. You specify the minimum and maximum values for the Axis Id. You enter two numbers that specify the following coordinates:
    • Minimum value
    • Maximum value

      For example:

    0 1000000

    This example sets a range that includes 0 through 1 million.

  • Rectangle, Line, or Ellipse. You enter four numbers that specify the following coordinates:
    • Left
    • Bottom
    • Top
    • Right

      For example:

    60 1000 80 3000

    This example sets the coordinates so that the left side of the element occurs at coordinate 60, the bottom at coordinate 1000, the top at coordinate 80, and the right side at coordinate 3000.

  • HorizArea. You enter four numbers that specify the following coordinates:
    • minYaxisValue
    • maxYaxisValue

    20 50

    This example configures Siebel CRM to draw the horizontal area between y coordinate 20 and y coordinate 50.

  • HorizLine. You enter one number that specifies the YaxisValue. For example:

    40000

    This example configures Siebel CRM to draw a horizontal line at a y coordinate of 40000.

Properties That Siebel CRM Uses for Different Types of Chart Elements

Table 21 describes the properties that Siebel CRM uses for different types of chart elements.

Table 21. Properties That Siebel CRM Uses for Different Types of Chart Elements
Type of Chart Element
Properties

Axis Label

Siebel CRM uses the following properties:

  • Axis Id
  • Color
  • Coordinates
  • Display Format
  • Divisions
  • Font Effect
  • Font Name
  • Font Size
  • Font Style
  • List Of Values
  • Log Base
  • Show Category Legend
  • Sort Specification
  • Vertical

Axis Line Grid

Siebel CRM uses the following properties:

  • Axis Id
  • Color
  • Line Style
  • Line Width

You cannot configure the AxisLineGrid element.

Axis Title

Siebel CRM uses the following properties:

  • Axis Id
  • Color
  • Font Effects
  • Font Name
  • Font Size
  • Font Style
  • Text

Graphic

Siebel CRM uses the following properties:

  • Color
  • Coordinates
  • Graphic Type
  • Line Style
  • Line Width
  • Text

Legend

Siebel CRM uses the following properties:

  • Color
  • Font Effect
  • Font Name
  • Font Size
  • Font Style

You cannot configure the Font Name property or the Font Size property.

Plot

Siebel CRM uses the following properties:

  • Color

Siebel CRM release 7.x does not support the Plot chart element.

Title

Siebel CRM uses the following properties:

  • Color
  • Font Effect
  • Font Name
  • Font Size
  • Font Style
  • Text
Siebel Object Types Reference Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.