Excel.Interfaces.ChartCollectionLoadOptions interface
A collection of all the chart objects on a worksheet.
Remarks
[Api set: ExcelApi 1.1]
Properties
| $all | Specifying |
| axes | For EACH ITEM in the collection: Represents chart axes. |
| category |
For EACH ITEM in the collection: Specifies a chart category label level enumeration constant, referring to the level of the source category labels. |
| chart |
For EACH ITEM in the collection: Specifies the type of the chart. See |
| data |
For EACH ITEM in the collection: Represents the data labels on the chart. |
| display |
For EACH ITEM in the collection: Specifies the way that blank cells are plotted on a chart. |
| format | For EACH ITEM in the collection: Encapsulates the format properties for the chart area. |
| height | For EACH ITEM in the collection: Specifies the height, in points, of the chart object. |
| id | For EACH ITEM in the collection: The unique ID of chart. |
| left | For EACH ITEM in the collection: The distance, in points, from the left side of the chart to the worksheet origin. |
| legend | For EACH ITEM in the collection: Represents the legend for the chart. |
| name | For EACH ITEM in the collection: Specifies the name of a chart object. |
| pivot |
For EACH ITEM in the collection: Encapsulates the options for a pivot chart. |
| plot |
For EACH ITEM in the collection: Represents the plot area for the chart. |
| plot |
For EACH ITEM in the collection: Specifies the way columns or rows are used as data series on the chart. |
| plot |
For EACH ITEM in the collection: True if only visible cells are plotted. False if both visible and hidden cells are plotted. |
| series | For EACH ITEM in the collection: Represents either a single series or collection of series in the chart. |
| series |
For EACH ITEM in the collection: Specifies a chart series name level enumeration constant, referring to the level of the source series names. |
| show |
For EACH ITEM in the collection: Specifies whether to display all field buttons on a PivotChart. |
| show |
For EACH ITEM in the collection: Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only. |
| style | For EACH ITEM in the collection: Specifies the chart style for the chart. |
| title | For EACH ITEM in the collection: Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. |
| top | For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart). |
| width | For EACH ITEM in the collection: Specifies the width, in points, of the chart object. |
| worksheet | For EACH ITEM in the collection: The worksheet containing the current chart. |
Property Details
$all
Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
$all?: boolean;Property Value
boolean
axes
For EACH ITEM in the collection: Represents chart axes.
axes?: Excel.Interfaces.ChartAxesLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.1]
categoryLabelLevel
For EACH ITEM in the collection: Specifies a chart category label level enumeration constant, referring to the level of the source category labels.
categoryLabelLevel?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.8]
chartType
For EACH ITEM in the collection: Specifies the type of the chart. See Excel.ChartType for details.
chartType?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.7]
dataLabels
For EACH ITEM in the collection: Represents the data labels on the chart.
dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.1]
displayBlanksAs
For EACH ITEM in the collection: Specifies the way that blank cells are plotted on a chart.
displayBlanksAs?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.8]
format
For EACH ITEM in the collection: Encapsulates the format properties for the chart area.
format?: Excel.Interfaces.ChartAreaFormatLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.1]
height
For EACH ITEM in the collection: Specifies the height, in points, of the chart object.
height?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.1]
id
For EACH ITEM in the collection: The unique ID of chart.
id?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.7]
left
For EACH ITEM in the collection: The distance, in points, from the left side of the chart to the worksheet origin.
left?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.1]
legend
For EACH ITEM in the collection: Represents the legend for the chart.
legend?: Excel.Interfaces.ChartLegendLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.1]
name
For EACH ITEM in the collection: Specifies the name of a chart object.
name?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.1]
pivotOptions
For EACH ITEM in the collection: Encapsulates the options for a pivot chart.
pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.9]
plotArea
For EACH ITEM in the collection: Represents the plot area for the chart.
plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.8]
plotBy
For EACH ITEM in the collection: Specifies the way columns or rows are used as data series on the chart.
plotBy?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.8]
plotVisibleOnly
For EACH ITEM in the collection: True if only visible cells are plotted. False if both visible and hidden cells are plotted.
plotVisibleOnly?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.8]
series
For EACH ITEM in the collection: Represents either a single series or collection of series in the chart.
series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.1]
seriesNameLevel
For EACH ITEM in the collection: Specifies a chart series name level enumeration constant, referring to the level of the source series names.
seriesNameLevel?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.8]
showAllFieldButtons
For EACH ITEM in the collection: Specifies whether to display all field buttons on a PivotChart.
showAllFieldButtons?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.7]
showDataLabelsOverMaximum
For EACH ITEM in the collection: Specifies whether to show the data labels when the value is greater than the maximum value on the value axis. If the value axis becomes smaller than the size of the data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only.
showDataLabelsOverMaximum?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.8]
style
For EACH ITEM in the collection: Specifies the chart style for the chart.
style?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.8]
title
For EACH ITEM in the collection: Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.
title?: Excel.Interfaces.ChartTitleLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.1]
top
For EACH ITEM in the collection: Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).
top?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.1]
width
For EACH ITEM in the collection: Specifies the width, in points, of the chart object.
width?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.1]
worksheet
For EACH ITEM in the collection: The worksheet containing the current chart.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.2]