1. Object Types Reference
  2. Chart

Chart

A chart displays graphical data in the boundaries of an applet.

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

  • Siebel Objects > Applet > Chart

The following table describes properties that Siebel CRM uses with a chart.

Property Description

Bar Colors (O)

Specifies a list of colors for bars or pie slices in an itemized list of red, green, and blue triplets:

  • The first triplet specifies the color for the first series.

  • The second triplet specifies the color for the second series.

  • And so on.

If the list contains more series members than triplets, then Siebel CRM repeats the list of colors.

You can specify up to 15 triplets. Each number in a triplet must be between 0 and 255. For example, 128 0 0, 0 128 0, 0 0 128.

The following value is the default value:

0 255 0,0 0 255,255 0 0,255 0 255,255 255 0,0 255 255,255 0 128,255 128 0,0 255 128,128 0 255,255 255 128,128 255 255,128 128 64,128 64 128,64 128 128

Category Captions (O)

Specifies the caption for the x-axis.

Category Field (R)

For more information, see Configuring the Category Field Property of a Chart.

Compare (O)(H)

Obsolete. Do not use.

Data Function (O)

Specifies the operation that Siebel CRM performs on data. You can use one of the following values:

  • COUNT. Counts the number of records.

  • SUM. Sums field values for all records in the category.

  • AVERAGE. Calculates the average value for each record of the field.

  • PLOT. Plots all cell values. If a cell in the logical table does not contain a value, then Siebel CRM sets the chart value to NULL.

If COUNT is the only data function you must apply to the chart because the Picklist Functions property is empty, then it is recommended that you do specify a value for the Data Point Field property value. This configuration can improve performance.

For more information, see Configuring the Data Function Property of a Chart.

Data Point Captions (O)

Specifies the caption for the y-axis.

Data Point Field (O)

Specifies the field that contains the data that Siebel CRM plots on the y-axis. If you do not specify this property, then specify COUNT in the Data Function property.

For more information, see Configuring the Data Function Property of a Chart.

Editable (O)

Obsolete. Do not use.

Invert (O)

You can use one of the following values:

  • TRUE. Invert the x-axis, z-axis, labels, and titles. This configuration can be useful to display a different view of the data.

  • FALSE. Do not invert the x-axis, z-axis, labels, and titles.

Choosing a By picklist item modifies this property except in a time period chart where it modifies the time period on the x-axis.

Multi Data Point (O)

You can use one of the following values:

  • TRUE. Plot multiple line-graph curves on the same y-axis according to different source field and function combinations. Siebel CRM displays the name for each curve in the legend. You must also set the following properties in the chart object definition:

    • Data Point Field

    • Data Function

    • Picklist Functions

    • Multi Data Point

  • FALSE. Do not plot multiple curves.

Name (R)

Specifies the name of the chart.

Period (O)

Specifies a calendar period or a time period that the user defines as the default time period for this chart. To view the values you can choose, click the Period property in Siebel Tools.

If you specify the Period property, then you must set the field type of the business component field that supplies the values for the chart categories to Date or DateTime.

The user can define any time period that the Period business component contains, such as fiscal month, quarter, or year. To allow the user to define a time period in a chart, you must add the Period business component to the current business object.

Picklist Function Captions (O)

Specifies captions for the list of functions that the y-axis uses.

Picklist Functions (O)

Specifies the data functions that Siebel CRM lists in the Show picklist in the applet. To suppress a function in this picklist, do not specify a string in the position of this function. For more information, see Configuring the Data Function Property of a Chart.

Siebel CRM does not specify a value for this property and does not display this picklist in the applet, by default.

For example:

Number of Opportunities, Opportunity Revenue,
Average Revenue.

Siebel CRM associates each item you enter with a data point field and data function in a corresponding position in the Data Point Field property and the Data Function property. It makes this association according to the order that you use when you enter the items in the Picklist Functions property.

Picklist Period Captions (O)

Specifies the captions that Siebel CRM displays for the list of date time periods that the x-axis uses.

Picklist Periods (O)

Specifies the time periods that Siebel CRM displays in a picklist in an applet. You enter a comma-separated list that does not include a space after the comma. For example:

Month(Calendar),
Quarter (Calendar), Year(Calendar),Day,Week,Month,
Quarter,Year

If the Picklist Periods property is empty, then Siebel CRM does not display time periods in the picklist in the client.

To allow the user to define a time period in a chart, you must add the Period business component to the current business object.

Picklist Type Captions (O)

Specifies the captions for the types of charts.

Picklist Types (O)

Specifies the chart types that Siebel CRM includes in the picklist in the applet. You enter a comma-separated list that does not include a space after the comma. For example:

2dBar,3dBar

If the Picklist Types property is empty, then Siebel CRM does not display chart types in the picklist in the client.

To display a 2dScatter, 3dScatter, or Combo chart, you must use the Type property. You cannot use the Picklist Types property to display these chart types.

For a list of chart types that you can specify, see the description for the Type property.

Selection Based (O)

You can use one of the following values:

  • TRUE. Chart only the currently active record that the business component contains.

  • FALSE. Chart all records that the business component contains.

Series Captions (O)

Specifies the caption for the z-axis.

Series Field (O)

Specifies the field that contains the data that Siebel CRM plots on the z-axis. If this property is empty, then it maps all of the records into a single series. For more information, Configuring the Series Field Property of a Chart.

Type (O)

Specifies the type of chart that Siebel CRM displays. You can use one of the following values:

  • 2dBar, 3dBar, 2dStackedBar, 3dStackedBar, 2dLine, 3dLine, Combo, 2dHorizBar, 3dHorizBar, 2dCube, 3dCube

  • 3dClusteredBar, 2dPie, 3dPie, 2dDoughnut

  • 2dScatter, 3dScatter, 2dSpline, 3dSpline

To display a combo chart, you must specify a value in the Data Point Field property. Siebel CRM displays the Sum (Data Function) of this field on the y-axis and the Count for this field on the second y-axis.

To display a 2dScatter chart or a 3dScatter chart, you must specify the Coordinates property for the axis label of the x-axis. For more information, see Chart Element.

Use Category MVGroup Data (O)

You can use one of the following values:

  • TRUE. If the category field is a multivalue group (MVG), then Siebel CRM gets the charting data from this field. If you set this property to TRUE, then you cannot use the following properties:

    • Data Function

    • Data Point Captions

    • Data Point Field

  • FALSE. Use the value listed in the business component.