Excel.Interfaces.ChartLoadOptions interface
Represents a chart object in a workbook. To learn more about the chart object model, see Work with charts using the Excel JavaScript API.
Remarks
Properties
| $all | Specifying |
| axes | Represents chart axes. |
| category |
Specifies a chart category label level enumeration constant, referring to the level of the source category labels. |
| chart |
Specifies the type of the chart. See |
| data |
Represents the data labels on the chart. |
| display |
Specifies the way that blank cells are plotted on a chart. |
| format | Encapsulates the format properties for the chart area. |
| height | Specifies the height, in points, of the chart object. |
| id | The unique ID of chart. |
| left | The distance, in points, from the left side of the chart to the worksheet origin. |
| legend | Represents the legend for the chart. |
| name | Specifies the name of a chart object. |
| pivot |
Encapsulates the options for a pivot chart. |
| plot |
Represents the plot area for the chart. |
| plot |
Specifies the way columns or rows are used as data series on the chart. |
| plot |
True if only visible cells are plotted. False if both visible and hidden cells are plotted. |
| series | Represents either a single series or collection of series in the chart. |
| series |
Specifies a chart series name level enumeration constant, referring to the level of the source series names. |
| show |
Specifies whether to display all field buttons on a PivotChart. |
| show |
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 | Specifies the chart style for the chart. |
| title | Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. |
| top | 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 | Specifies the width, in points, of the chart object. |
| worksheet | The worksheet containing the current chart. |
Property Details
$all
Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
$all?: boolean;Property Value
boolean
axes
Represents chart axes.
axes?: Excel.Interfaces.ChartAxesLoadOptions;Property Value
Remarks
categoryLabelLevel
Specifies a chart category label level enumeration constant, referring to the level of the source category labels.
categoryLabelLevel?: boolean;Property Value
boolean
Remarks
chartType
Specifies the type of the chart. See Excel.ChartType for details.
chartType?: boolean;Property Value
boolean
Remarks
dataLabels
Represents the data labels on the chart.
dataLabels?: Excel.Interfaces.ChartDataLabelsLoadOptions;Property Value
Remarks
displayBlanksAs
Specifies the way that blank cells are plotted on a chart.
displayBlanksAs?: boolean;Property Value
boolean
Remarks
format
Encapsulates the format properties for the chart area.
format?: Excel.Interfaces.ChartAreaFormatLoadOptions;Property Value
Remarks
height
Specifies the height, in points, of the chart object.
height?: boolean;Property Value
boolean
Remarks
id
left
The distance, in points, from the left side of the chart to the worksheet origin.
left?: boolean;Property Value
boolean
Remarks
legend
Represents the legend for the chart.
legend?: Excel.Interfaces.ChartLegendLoadOptions;Property Value
Remarks
name
Specifies the name of a chart object.
name?: boolean;Property Value
boolean
Remarks
pivotOptions
Encapsulates the options for a pivot chart.
pivotOptions?: Excel.Interfaces.ChartPivotOptionsLoadOptions;Property Value
Remarks
plotArea
Represents the plot area for the chart.
plotArea?: Excel.Interfaces.ChartPlotAreaLoadOptions;Property Value
Remarks
plotBy
Specifies the way columns or rows are used as data series on the chart.
plotBy?: boolean;Property Value
boolean
Remarks
plotVisibleOnly
True if only visible cells are plotted. False if both visible and hidden cells are plotted.
plotVisibleOnly?: boolean;Property Value
boolean
Remarks
series
Represents either a single series or collection of series in the chart.
series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions;Property Value
Remarks
seriesNameLevel
Specifies a chart series name level enumeration constant, referring to the level of the source series names.
seriesNameLevel?: boolean;Property Value
boolean
Remarks
showAllFieldButtons
Specifies whether to display all field buttons on a PivotChart.
showAllFieldButtons?: boolean;Property Value
boolean
Remarks
showDataLabelsOverMaximum
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
style
Specifies the chart style for the chart.
style?: boolean;Property Value
boolean
Remarks
title
Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.
title?: Excel.Interfaces.ChartTitleLoadOptions;Property Value
Remarks
top
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
width
Specifies the width, in points, of the chart object.
width?: boolean;Property Value
boolean
Remarks
worksheet
The worksheet containing the current chart.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;Property Value
Remarks
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for