Essbase Chart Info Properties

The following properties are available on EssbaseChartInfo objects, which appear as expandable sub-properties of the objects that use them.

Appearance

Property	Type	Default	Description
Caption	string		The text displayed on the chart control pane title bar and tab. The value can contain tokens.
TitleTop	string		The text displayed as the title at the top within the chart control area. The value can contain tokens.

Property

Type

Default

Description

Caption

string

The text displayed on the chart control pane title bar and tab. The value can contain tokens.

TitleTop

string

The text displayed as the title at the top within the chart control area. The value can contain tokens.

Control

Property	Type	Default	Description
ChartName	string		The name of the chart control. The value is used to locate the chart control to fill with the retrieve range data, so the value must match the name of an existing chart control.

Property

Type

Default

Description

ChartName

string

The name of the chart control. The value is used to locate the chart control to fill with the retrieve range data, so the value must match the name of an existing chart control.

Data

Property	Type	Default	Description
RetrieveRangeName	string		The name of the retrieve range that contains the data to be represented by the chart. The RetrieveRangeName setting is optional. It is used to configure a chart that represents the data contained by a defined Essbase retrieve range. When the chart represents a sheet-level range, either include the worksheet name as part of the RetrieveRangeName using the Excel defined name convention, such as 'Market by Quarter'!Ess.Retrieve.Range.1 or use the SheetName setting to specify the name of the worksheet.
SheetName	string		The name of the sheet that contains the data to be represented by the chart. The SheetName setting is optional. When the used range of a worksheet is the Essbase retrieve range, there is no defined name for the Essbase retrieve range. To configure a chart that represents the used range of a worksheet, use the SheetName setting to specify the name of a worksheet that contains Essbase data, and leave the RetrieveRangeName blank.

Property

Type

Default

Description

RetrieveRangeName

string

The name of the retrieve range that contains the data to be represented by the chart.

The RetrieveRangeName setting is optional. It is used to configure a chart that represents the data contained by a defined Essbase retrieve range.

When the chart represents a sheet-level range, either include the worksheet name as part of the RetrieveRangeName using the Excel defined name convention, such as 'Market by Quarter'!Ess.Retrieve.Range.1 or use the SheetName setting to specify the name of the worksheet.

SheetName

string

The name of the sheet that contains the data to be represented by the chart.

The SheetName setting is optional. When the used range of a worksheet is the Essbase retrieve range, there is no defined name for the Essbase retrieve range. To configure a chart that represents the used range of a worksheet, use the SheetName setting to specify the name of a worksheet that contains Essbase data, and leave the RetrieveRangeName blank.