excel package

Represents the Excel application that manages the workbook.

Represents an Office.js binding that is defined in the workbook.

Represents the collection of all the binding objects that are part of the workbook.

Represents a cell value conditional format.

Represents a chart object in a workbook. To learn more about the chart object model, see Work with charts using the Excel JavaScript API.

Encapsulates the format properties for the overall chart area.

Represents the chart axes.

Represents a single axis in a chart.

Encapsulates the format properties for the chart axis.

Represents the title of a chart axis.

Represents the chart axis title formatting.

Represents the border formatting of a chart element.

A collection of all the chart objects on a worksheet.

Represents the data label of a chart point.

Encapsulates the format properties for the chart data labels.

Represents a collection of all the data labels on a chart point.

Represents the fill formatting for a chart element.

This object represents the font attributes (such as font name, font size, and color) for a chart object.

Represents the substring in chart related objects that contain text, like a ChartTitle object or ChartAxisTitle object.

Represents major or minor gridlines on a chart axis.

Encapsulates the format properties for chart gridlines.

Represents the legend in a chart.

Represents the legend entry in legendEntryCollection.

Represents a collection of legend entries.

Encapsulates the format properties of a chart legend.

Encapsulates the formatting options for line elements.

This object represents the attributes for a chart plot area.

Represents the format properties for a chart plot area.

Represents a point of a series in a chart.

Represents the formatting object for chart points.

A collection of all the chart points within a series inside a chart.

Represents a series in a chart.

Represents a collection of chart series.

Encapsulates the format properties for the chart series

Represents a chart title object of a chart.

Provides access to the formatting options for a chart title.

This object represents the attributes for a chart trendline object.

Represents a collection of chart trendlines.

Represents the format properties for the chart trendline.

This object represents the attributes for a chart trendline label object.

Encapsulates the format properties for the chart trendline label.

Represents the color scale criteria for conditional formatting.

Represents a conditional format for the negative side of the data bar.

Represents a conditional format for the positive side of the data bar.

An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges.

Represents a collection of all the conditional formats that are overlap the range.

Represents a rule, for all traditional rule/format pairings.

Represents the border of an object.

Represents the border objects that make up range border.

Represents the background of a conditional range object.

This object represents the font attributes (font style, color, etc.) for an object.

A format object encapsulating the conditional formats range's font, fill, borders, and other properties.

Represents a custom conditional format type.

Represents a custom property.

Contains the collection of custom properties.

Represents a custom XML part object in a workbook.

A collection of custom XML parts.

A scoped collection of custom XML parts. A scoped collection is the result of some operation (e.g., filtering by namespace). A scoped collection cannot be scoped any further.

Represents an Excel conditional data bar type.

Represents a collection of all the data connections that are part of the workbook.

Represents the Excel DataPivotHierarchy.

Represents a collection of DataPivotHierarchy items associated with the PivotTable.

Represents the data validation applied to the current range. To learn more about the data validation object model, read Add data validation to Excel ranges.

Represents workbook properties.

Manages the filtering of a table's column.

Represents the Excel FilterPivotHierarchy.

Represents a collection of FilterPivotHierarchy items associated with the PivotTable.

Represents the format protection of a range object.

An object containing the result of a function-evaluation operation

An object for evaluating Excel functions.

Represents an icon set criteria for conditional formatting.

Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names.

Represents an object containing values and types of a named item.

A collection of all the NamedItem objects that are part of the workbook or worksheet, depending on how it was reached.

Represents the Excel PivotField.

Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy.

Represents the Excel PivotHierarchy.

Represents a collection of all the PivotHierarchies that are part of the PivotTable.

Represents the Excel PivotItem.

Represents a collection of all the PivotItems related to their parent PivotField.

Represents the visual layout of the PivotTable.

Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API.

Represents a collection of all the PivotTables that are part of the workbook or worksheet.

Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.

Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells. To learn more about how ranges are used throughout the API, start with Ranges in the Excel JavaScript API.

Represents the border of an object.

Represents the border objects that make up the range border.

Represents the background of a range object.

This object represents the font attributes (font name, font size, color, etc.) for an object.

A format object encapsulating the range's font, fill, borders, alignment, and other properties.

Manages sorting operations on Range objects.

RangeView represents a set of visible cells of the parent range.

Represents a collection of RangeView objects.

The RequestContext object facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the request context is required to get access to the Excel object model from the add-in.

Represents the Excel RowColumnPivotHierarchy.

Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable.

Represents the Excel Runtime class.

Setting represents a key-value pair of a setting persisted to the document (per file, per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password.

Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination.

An object encapsulating a style's format and other properties.

Represents a collection of all the styles.

Represents an Excel table. To learn more about the table object model, read Work with tables using the Excel JavaScript API.

Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.

Represents a column in a table.

Represents a collection of all the columns that are part of the table.

Represents a row in a table.

Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a TableRow object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

Represents a collection of all the rows that are part of the table.

Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a TableRow object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

Manages sorting operations on Table objects.

Represents a specific text conditional format.

Represents a top/bottom conditional format.

Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges. To learn more about the workbook object model, read Work with workbooks using the Excel JavaScript API.

The WorkbookCreated object is the top level object created by Application.CreateWorkbook. A WorkbookCreated object is a special Workbook object.

Represents the protection of a workbook object.

An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet object model, read Work with worksheets using the Excel JavaScript API.

Represents a collection of worksheet objects that are part of the workbook.

Represents the protection of a worksheet object.

Represents the basic type data validation criteria.

Provides information about the binding that raised the data changed event.

Provides information about the selection that raised the selection changed event.

Note*: If multiple, discontiguous cells are selected, Binding.onSelectionChanged only reports row and column information for one selection. Use Worksheet.onSelectionChanged for multiple selected ranges.

Provides information about the chart that raised the activated event.

Provides information about the chart that raised the added event.

Provides information about the chart that raised the deactivated event.

Provides information about the chart that raised the deleted event.

Represents a cell value conditional format rule.

Represents the criteria of the color scale.

Represents a color scale criterion which contains a type, value, and a color.

Represents a rule-type for a data bar.

Represents an icon criterion which contains a type, value, an operator, and an optional custom icon, if not using an icon set.

Represents the preset criteria conditional format rule.

Represents a cell value conditional format rule.

Represents the rule of the top/bottom conditional format.

Represents the custom data validation criteria.

Represents the error alert properties for the data validation.

Represents the user prompt properties for the data validation.

A data validation rule contains different types of data validation. You can only use one of them at a time according the Excel.DataValidationType.

Represents the date data validation criteria.

Represents the filtering criteria applied to a column.

Represents how to filter a date when filtering on values.

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

Represents a cell icon.

[ API set: ExcelApi 1.2 ]

An interface describing the data returned by calling allowEditRangeCollection.toJSON().

An interface for updating data on the AllowEditRangeCollection object, for use in allowEditRangeCollection.set({ ... }).

An interface describing the data returned by calling allowEditRange.toJSON().

An interface for updating data on the AllowEditRange object, for use in allowEditRange.set({ ... }).

An interface describing the data returned by calling application.toJSON().

Represents the Excel application that manages the workbook.

An interface for updating data on the Application object, for use in application.set({ ... }).

An interface describing the data returned by calling autoFilter.toJSON().

An interface describing the data returned by calling bindingCollection.toJSON().

Represents the collection of all the binding objects that are part of the workbook.

An interface for updating data on the BindingCollection object, for use in bindingCollection.set({ ... }).

An interface describing the data returned by calling binding.toJSON().

Represents an Office.js binding that is defined in the workbook.

An interface describing the data returned by calling cellValueConditionalFormat.toJSON().

Represents a cell value conditional format.

An interface for updating data on the CellValueConditionalFormat object, for use in cellValueConditionalFormat.set({ ... }).

An interface describing the data returned by calling chartAreaFormat.toJSON().

Encapsulates the format properties for the overall chart area.

An interface for updating data on the ChartAreaFormat object, for use in chartAreaFormat.set({ ... }).

An interface describing the data returned by calling chartAxes.toJSON().

Represents the chart axes.

An interface for updating data on the ChartAxes object, for use in chartAxes.set({ ... }).

An interface describing the data returned by calling chartAxis.toJSON().

An interface describing the data returned by calling chartAxisFormat.toJSON().

Encapsulates the format properties for the chart axis.

An interface for updating data on the ChartAxisFormat object, for use in chartAxisFormat.set({ ... }).

Represents a single axis in a chart.

An interface describing the data returned by calling chartAxisTitle.toJSON().

An interface describing the data returned by calling chartAxisTitleFormat.toJSON().

Represents the chart axis title formatting.

An interface for updating data on the ChartAxisTitleFormat object, for use in chartAxisTitleFormat.set({ ... }).

Represents the title of a chart axis.

An interface for updating data on the ChartAxisTitle object, for use in chartAxisTitle.set({ ... }).

An interface for updating data on the ChartAxis object, for use in chartAxis.set({ ... }).

An interface describing the data returned by calling chartBinOptions.toJSON().

An interface for updating data on the ChartBinOptions object, for use in chartBinOptions.set({ ... }).

An interface describing the data returned by calling chartBorder.toJSON().

Represents the border formatting of a chart element.

An interface for updating data on the ChartBorder object, for use in chartBorder.set({ ... }).

An interface describing the data returned by calling chartBoxwhiskerOptions.toJSON().

An interface for updating data on the ChartBoxwhiskerOptions object, for use in chartBoxwhiskerOptions.set({ ... }).

An interface describing the data returned by calling chartCollection.toJSON().

A collection of all the chart objects on a worksheet.

An interface for updating data on the ChartCollection object, for use in chartCollection.set({ ... }).

An interface describing the data returned by calling chart.toJSON().

An interface describing the data returned by calling chartDataLabel.toJSON().

An interface describing the data returned by calling chartDataLabelFormat.toJSON().

Encapsulates the format properties for the chart data labels.

An interface for updating data on the ChartDataLabelFormat object, for use in chartDataLabelFormat.set({ ... }).

Represents the data label of a chart point.

An interface describing the data returned by calling chartDataLabels.toJSON().

Represents a collection of all the data labels on a chart point.

An interface for updating data on the ChartDataLabels object, for use in chartDataLabels.set({ ... }).

An interface for updating data on the ChartDataLabel object, for use in chartDataLabel.set({ ... }).

An interface describing the data returned by calling chartDataTable.toJSON().

An interface describing the data returned by calling chartDataTableFormat.toJSON().

An interface for updating data on the ChartDataTableFormat object, for use in chartDataTableFormat.set({ ... }).

An interface for updating data on the ChartDataTable object, for use in chartDataTable.set({ ... }).

An interface describing the data returned by calling chartErrorBars.toJSON().

An interface describing the data returned by calling chartErrorBarsFormat.toJSON().

An interface for updating data on the ChartErrorBarsFormat object, for use in chartErrorBarsFormat.set({ ... }).

An interface for updating data on the ChartErrorBars object, for use in chartErrorBars.set({ ... }).

An interface describing the data returned by calling chartFont.toJSON().

This object represents the font attributes (such as font name, font size, and color) for a chart object.

An interface for updating data on the ChartFont object, for use in chartFont.set({ ... }).

An interface describing the data returned by calling chartFormatString.toJSON().

Represents the substring in chart related objects that contain text, like a ChartTitle object or ChartAxisTitle object.

An interface for updating data on the ChartFormatString object, for use in chartFormatString.set({ ... }).

An interface describing the data returned by calling chartGridlines.toJSON().

An interface describing the data returned by calling chartGridlinesFormat.toJSON().

Encapsulates the format properties for chart gridlines.

An interface for updating data on the ChartGridlinesFormat object, for use in chartGridlinesFormat.set({ ... }).

Represents major or minor gridlines on a chart axis.

An interface for updating data on the ChartGridlines object, for use in chartGridlines.set({ ... }).

An interface describing the data returned by calling chartLegend.toJSON().

An interface describing the data returned by calling chartLegendEntryCollection.toJSON().

Represents a collection of legend entries.

An interface for updating data on the ChartLegendEntryCollection object, for use in chartLegendEntryCollection.set({ ... }).

An interface describing the data returned by calling chartLegendEntry.toJSON().

Represents the legend entry in legendEntryCollection.

An interface for updating data on the ChartLegendEntry object, for use in chartLegendEntry.set({ ... }).

An interface describing the data returned by calling chartLegendFormat.toJSON().

Encapsulates the format properties of a chart legend.

An interface for updating data on the ChartLegendFormat object, for use in chartLegendFormat.set({ ... }).

Represents the legend in a chart.

An interface for updating data on the ChartLegend object, for use in chartLegend.set({ ... }).

An interface describing the data returned by calling chartLineFormat.toJSON().

Encapsulates the formatting options for line elements.

An interface for updating data on the ChartLineFormat object, for use in chartLineFormat.set({ ... }).

Represents a chart object in a workbook. To learn more about the chart object model, see Work with charts using the Excel JavaScript API.

An interface describing the data returned by calling chartMapOptions.toJSON().

An interface for updating data on the ChartMapOptions object, for use in chartMapOptions.set({ ... }).

An interface describing the data returned by calling chartPivotOptions.toJSON().

An interface for updating data on the ChartPivotOptions object, for use in chartPivotOptions.set({ ... }).

An interface describing the data returned by calling chartPlotArea.toJSON().

An interface describing the data returned by calling chartPlotAreaFormat.toJSON().

Represents the format properties for a chart plot area.

An interface for updating data on the ChartPlotAreaFormat object, for use in chartPlotAreaFormat.set({ ... }).

This object represents the attributes for a chart plot area.

An interface for updating data on the ChartPlotArea object, for use in chartPlotArea.set({ ... }).

An interface describing the data returned by calling chartPoint.toJSON().

An interface describing the data returned by calling chartPointFormat.toJSON().

Represents the formatting object for chart points.

An interface for updating data on the ChartPointFormat object, for use in chartPointFormat.set({ ... }).

Represents a point of a series in a chart.

An interface describing the data returned by calling chartPointsCollection.toJSON().

A collection of all the chart points within a series inside a chart.

An interface for updating data on the ChartPointsCollection object, for use in chartPointsCollection.set({ ... }).

An interface for updating data on the ChartPoint object, for use in chartPoint.set({ ... }).

An interface describing the data returned by calling chartSeriesCollection.toJSON().

Represents a collection of chart series.

An interface for updating data on the ChartSeriesCollection object, for use in chartSeriesCollection.set({ ... }).

An interface describing the data returned by calling chartSeries.toJSON().

An interface describing the data returned by calling chartSeriesFormat.toJSON().

Encapsulates the format properties for the chart series

An interface for updating data on the ChartSeriesFormat object, for use in chartSeriesFormat.set({ ... }).

Represents a series in a chart.

An interface for updating data on the ChartSeries object, for use in chartSeries.set({ ... }).

An interface describing the data returned by calling chartTitle.toJSON().

An interface describing the data returned by calling chartTitleFormat.toJSON().

Provides access to the formatting options for a chart title.

An interface for updating data on the ChartTitleFormat object, for use in chartTitleFormat.set({ ... }).

Represents a chart title object of a chart.

An interface for updating data on the ChartTitle object, for use in chartTitle.set({ ... }).

An interface describing the data returned by calling chartTrendlineCollection.toJSON().

Represents a collection of chart trendlines.

An interface for updating data on the ChartTrendlineCollection object, for use in chartTrendlineCollection.set({ ... }).

An interface describing the data returned by calling chartTrendline.toJSON().

An interface describing the data returned by calling chartTrendlineFormat.toJSON().

Represents the format properties for the chart trendline.

An interface for updating data on the ChartTrendlineFormat object, for use in chartTrendlineFormat.set({ ... }).

An interface describing the data returned by calling chartTrendlineLabel.toJSON().

An interface describing the data returned by calling chartTrendlineLabelFormat.toJSON().

Encapsulates the format properties for the chart trendline label.

An interface for updating data on the ChartTrendlineLabelFormat object, for use in chartTrendlineLabelFormat.set({ ... }).

This object represents the attributes for a chart trendline label object.

An interface for updating data on the ChartTrendlineLabel object, for use in chartTrendlineLabel.set({ ... }).

This object represents the attributes for a chart trendline object.

An interface for updating data on the ChartTrendline object, for use in chartTrendline.set({ ... }).

An interface for updating data on the Chart object, for use in chart.set({ ... }).

Provides ways to load properties of only a subset of members of a collection.

An interface describing the data returned by calling colorScaleConditionalFormat.toJSON().

Represents the color scale criteria for conditional formatting.

An interface for updating data on the ColorScaleConditionalFormat object, for use in colorScaleConditionalFormat.set({ ... }).

An interface describing the data returned by calling commentCollection.toJSON().

An interface for updating data on the CommentCollection object, for use in commentCollection.set({ ... }).

An interface describing the data returned by calling comment.toJSON().

An interface describing the data returned by calling commentReplyCollection.toJSON().

An interface for updating data on the CommentReplyCollection object, for use in commentReplyCollection.set({ ... }).

An interface describing the data returned by calling commentReply.toJSON().

An interface for updating data on the CommentReply object, for use in commentReply.set({ ... }).

An interface for updating data on the Comment object, for use in comment.set({ ... }).

An interface describing the data returned by calling conditionalDataBarNegativeFormat.toJSON().

Represents a conditional format for the negative side of the data bar.

An interface for updating data on the ConditionalDataBarNegativeFormat object, for use in conditionalDataBarNegativeFormat.set({ ... }).

An interface describing the data returned by calling conditionalDataBarPositiveFormat.toJSON().

Represents a conditional format for the positive side of the data bar.

An interface for updating data on the ConditionalDataBarPositiveFormat object, for use in conditionalDataBarPositiveFormat.set({ ... }).

An interface describing the data returned by calling conditionalFormatCollection.toJSON().

Represents a collection of all the conditional formats that are overlap the range.

An interface for updating data on the ConditionalFormatCollection object, for use in conditionalFormatCollection.set({ ... }).

An interface describing the data returned by calling conditionalFormat.toJSON().

An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges.

An interface describing the data returned by calling conditionalFormatRule.toJSON().

Represents a rule, for all traditional rule/format pairings.

An interface for updating data on the ConditionalFormatRule object, for use in conditionalFormatRule.set({ ... }).

An interface for updating data on the ConditionalFormat object, for use in conditionalFormat.set({ ... }).

An interface describing the data returned by calling conditionalRangeBorderCollection.toJSON().

Represents the border objects that make up range border.

An interface for updating data on the ConditionalRangeBorderCollection object, for use in conditionalRangeBorderCollection.set({ ... }).

An interface describing the data returned by calling conditionalRangeBorder.toJSON().

Represents the border of an object.

An interface for updating data on the ConditionalRangeBorder object, for use in conditionalRangeBorder.set({ ... }).

An interface describing the data returned by calling conditionalRangeFill.toJSON().

Represents the background of a conditional range object.

An interface for updating data on the ConditionalRangeFill object, for use in conditionalRangeFill.set({ ... }).

An interface describing the data returned by calling conditionalRangeFont.toJSON().

This object represents the font attributes (font style, color, etc.) for an object.

An interface for updating data on the ConditionalRangeFont object, for use in conditionalRangeFont.set({ ... }).

An interface describing the data returned by calling conditionalRangeFormat.toJSON().

A format object encapsulating the conditional formats range's font, fill, borders, and other properties.

An interface for updating data on the ConditionalRangeFormat object, for use in conditionalRangeFormat.set({ ... }).

An interface describing the data returned by calling cultureInfo.toJSON().

An interface describing the data returned by calling customConditionalFormat.toJSON().

Represents a custom conditional format type.

An interface for updating data on the CustomConditionalFormat object, for use in customConditionalFormat.set({ ... }).

An interface describing the data returned by calling customPropertyCollection.toJSON().

Contains the collection of custom properties.

An interface for updating data on the CustomPropertyCollection object, for use in customPropertyCollection.set({ ... }).

An interface describing the data returned by calling customProperty.toJSON().

Represents a custom property.

An interface for updating data on the CustomProperty object, for use in customProperty.set({ ... }).

An interface describing the data returned by calling customXmlPartCollection.toJSON().

A collection of custom XML parts.

An interface for updating data on the CustomXmlPartCollection object, for use in customXmlPartCollection.set({ ... }).

An interface describing the data returned by calling customXmlPart.toJSON().

Represents a custom XML part object in a workbook.

An interface describing the data returned by calling customXmlPartScopedCollection.toJSON().

A scoped collection of custom XML parts. A scoped collection is the result of some operation (e.g., filtering by namespace). A scoped collection cannot be scoped any further.

An interface for updating data on the CustomXmlPartScopedCollection object, for use in customXmlPartScopedCollection.set({ ... }).

An interface describing the data returned by calling dataBarConditionalFormat.toJSON().

Represents an Excel conditional data bar type.

An interface for updating data on the DataBarConditionalFormat object, for use in dataBarConditionalFormat.set({ ... }).

An interface describing the data returned by calling dataPivotHierarchyCollection.toJSON().

Represents a collection of DataPivotHierarchy items associated with the PivotTable.

An interface for updating data on the DataPivotHierarchyCollection object, for use in dataPivotHierarchyCollection.set({ ... }).

An interface describing the data returned by calling dataPivotHierarchy.toJSON().

Represents the Excel DataPivotHierarchy.

An interface for updating data on the DataPivotHierarchy object, for use in dataPivotHierarchy.set({ ... }).

An interface describing the data returned by calling dataValidation.toJSON().

Represents the data validation applied to the current range. To learn more about the data validation object model, read Add data validation to Excel ranges.

An interface for updating data on the DataValidation object, for use in dataValidation.set({ ... }).

An interface describing the data returned by calling datetimeFormatInfo.toJSON().

An interface describing the data returned by calling documentProperties.toJSON().

Represents workbook properties.

An interface for updating data on the DocumentProperties object, for use in documentProperties.set({ ... }).

An interface describing the data returned by calling filter.toJSON().

Manages the filtering of a table's column.

An interface describing the data returned by calling filterPivotHierarchyCollection.toJSON().

Represents a collection of FilterPivotHierarchy items associated with the PivotTable.

An interface for updating data on the FilterPivotHierarchyCollection object, for use in filterPivotHierarchyCollection.set({ ... }).

An interface describing the data returned by calling filterPivotHierarchy.toJSON().

Represents the Excel FilterPivotHierarchy.

An interface for updating data on the FilterPivotHierarchy object, for use in filterPivotHierarchy.set({ ... }).

An interface describing the data returned by calling formatProtection.toJSON().

Represents the format protection of a range object.

An interface for updating data on the FormatProtection object, for use in formatProtection.set({ ... }).

An interface describing the data returned by calling functionResult.toJSON().

An object containing the result of a function-evaluation operation

An interface describing the data returned by calling geometricShape.toJSON().

An interface describing the data returned by calling groupShapeCollection.toJSON().

An interface for updating data on the GroupShapeCollection object, for use in groupShapeCollection.set({ ... }).

An interface describing the data returned by calling headerFooter.toJSON().

An interface describing the data returned by calling headerFooterGroup.toJSON().

An interface for updating data on the HeaderFooterGroup object, for use in headerFooterGroup.set({ ... }).

An interface for updating data on the HeaderFooter object, for use in headerFooter.set({ ... }).

An interface describing the data returned by calling iconSetConditionalFormat.toJSON().

Represents an icon set criteria for conditional formatting.

An interface for updating data on the IconSetConditionalFormat object, for use in iconSetConditionalFormat.set({ ... }).

An interface describing the data returned by calling image.toJSON().

An interface describing the data returned by calling iterativeCalculation.toJSON().

An interface for updating data on the IterativeCalculation object, for use in iterativeCalculation.set({ ... }).

An interface describing the data returned by calling line.toJSON().

An interface for updating data on the Line object, for use in line.set({ ... }).

An interface describing the data returned by calling linkedWorkbookCollection.toJSON().

An interface for updating data on the LinkedWorkbookCollection object, for use in linkedWorkbookCollection.set({ ... }).

An interface describing the data returned by calling linkedWorkbook.toJSON().

An interface describing the data returned by calling namedItemArrayValues.toJSON().

Represents an object containing values and types of a named item.

An interface describing the data returned by calling namedItemCollection.toJSON().

A collection of all the NamedItem objects that are part of the workbook or worksheet, depending on how it was reached.

An interface for updating data on the NamedItemCollection object, for use in namedItemCollection.set({ ... }).

An interface describing the data returned by calling namedItem.toJSON().

Represents a defined name for a range of cells or value. Names can be primitive named objects (as seen in the type below), range object, or a reference to a range. This object can be used to obtain range object associated with names.

An interface for updating data on the NamedItem object, for use in namedItem.set({ ... }).

An interface describing the data returned by calling namedSheetViewCollection.toJSON().

An interface for updating data on the NamedSheetViewCollection object, for use in namedSheetViewCollection.set({ ... }).

An interface describing the data returned by calling namedSheetView.toJSON().

An interface for updating data on the NamedSheetView object, for use in namedSheetView.set({ ... }).

An interface describing the data returned by calling numberFormatInfo.toJSON().

An interface describing the data returned by calling pageBreakCollection.toJSON().

An interface for updating data on the PageBreakCollection object, for use in pageBreakCollection.set({ ... }).

An interface describing the data returned by calling pageBreak.toJSON().

An interface describing the data returned by calling pageLayout.toJSON().

An interface for updating data on the PageLayout object, for use in pageLayout.set({ ... }).

An interface describing the data returned by calling pivotFieldCollection.toJSON().

Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy.

An interface for updating data on the PivotFieldCollection object, for use in pivotFieldCollection.set({ ... }).

An interface describing the data returned by calling pivotField.toJSON().

Represents the Excel PivotField.

An interface for updating data on the PivotField object, for use in pivotField.set({ ... }).

An interface describing the data returned by calling pivotHierarchyCollection.toJSON().

Represents a collection of all the PivotHierarchies that are part of the PivotTable.

An interface for updating data on the PivotHierarchyCollection object, for use in pivotHierarchyCollection.set({ ... }).

An interface describing the data returned by calling pivotHierarchy.toJSON().

Represents the Excel PivotHierarchy.

An interface for updating data on the PivotHierarchy object, for use in pivotHierarchy.set({ ... }).

An interface describing the data returned by calling pivotItemCollection.toJSON().

Represents a collection of all the PivotItems related to their parent PivotField.

An interface for updating data on the PivotItemCollection object, for use in pivotItemCollection.set({ ... }).

An interface describing the data returned by calling pivotItem.toJSON().

Represents the Excel PivotItem.

An interface for updating data on the PivotItem object, for use in pivotItem.set({ ... }).

An interface describing the data returned by calling pivotLayout.toJSON().

Represents the visual layout of the PivotTable.

An interface for updating data on the PivotLayout object, for use in pivotLayout.set({ ... }).

An interface describing the data returned by calling pivotTableCollection.toJSON().

Represents a collection of all the PivotTables that are part of the workbook or worksheet.

An interface for updating data on the PivotTableCollection object, for use in pivotTableCollection.set({ ... }).

An interface describing the data returned by calling pivotTable.toJSON().

Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API.

An interface describing the data returned by calling pivotTableScopedCollection.toJSON().

An interface for updating data on the PivotTableScopedCollection object, for use in pivotTableScopedCollection.set({ ... }).

An interface describing the data returned by calling pivotTableStyleCollection.toJSON().

An interface for updating data on the PivotTableStyleCollection object, for use in pivotTableStyleCollection.set({ ... }).

An interface describing the data returned by calling pivotTableStyle.toJSON().

An interface for updating data on the PivotTableStyle object, for use in pivotTableStyle.set({ ... }).

An interface for updating data on the PivotTable object, for use in pivotTable.set({ ... }).

An interface describing the data returned by calling presetCriteriaConditionalFormat.toJSON().

Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.

An interface for updating data on the PresetCriteriaConditionalFormat object, for use in presetCriteriaConditionalFormat.set({ ... }).

An interface describing the data returned by calling queryCollection.toJSON().

An interface for updating data on the QueryCollection object, for use in queryCollection.set({ ... }).

An interface describing the data returned by calling query.toJSON().

An interface describing the data returned by calling rangeAreasCollection.toJSON().

An interface for updating data on the RangeAreasCollection object, for use in rangeAreasCollection.set({ ... }).

An interface describing the data returned by calling rangeAreas.toJSON().

An interface for updating data on the RangeAreas object, for use in rangeAreas.set({ ... }).

An interface describing the data returned by calling rangeBorderCollection.toJSON().

Represents the border objects that make up the range border.

An interface for updating data on the RangeBorderCollection object, for use in rangeBorderCollection.set({ ... }).

An interface describing the data returned by calling rangeBorder.toJSON().

Represents the border of an object.

An interface for updating data on the RangeBorder object, for use in rangeBorder.set({ ... }).

An interface describing the data returned by calling rangeCollection.toJSON().

An interface for updating data on the RangeCollection object, for use in rangeCollection.set({ ... }).

An interface describing the data returned by calling range.toJSON().

An interface describing the data returned by calling rangeFill.toJSON().

Represents the background of a range object.

An interface for updating data on the RangeFill object, for use in rangeFill.set({ ... }).

An interface describing the data returned by calling rangeFont.toJSON().

This object represents the font attributes (font name, font size, color, etc.) for an object.

An interface for updating data on the RangeFont object, for use in rangeFont.set({ ... }).

An interface describing the data returned by calling rangeFormat.toJSON().

A format object encapsulating the range's font, fill, borders, alignment, and other properties.

An interface for updating data on the RangeFormat object, for use in rangeFormat.set({ ... }).

Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells. To learn more about how ranges are used throughout the API, start with Ranges in the Excel JavaScript API.

An interface for updating data on the Range object, for use in range.set({ ... }).

An interface describing the data returned by calling rangeViewCollection.toJSON().

Represents a collection of RangeView objects.

An interface for updating data on the RangeViewCollection object, for use in rangeViewCollection.set({ ... }).

An interface describing the data returned by calling rangeView.toJSON().

RangeView represents a set of visible cells of the parent range.

An interface for updating data on the RangeView object, for use in rangeView.set({ ... }).

An interface describing the data returned by calling removeDuplicatesResult.toJSON().

An interface describing the data returned by calling rowColumnPivotHierarchyCollection.toJSON().

Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable.

An interface for updating data on the RowColumnPivotHierarchyCollection object, for use in rowColumnPivotHierarchyCollection.set({ ... }).

An interface describing the data returned by calling rowColumnPivotHierarchy.toJSON().

Represents the Excel RowColumnPivotHierarchy.

An interface for updating data on the RowColumnPivotHierarchy object, for use in rowColumnPivotHierarchy.set({ ... }).

An interface describing the data returned by calling runtime.toJSON().

Represents the Excel Runtime class.

An interface for updating data on the Runtime object, for use in runtime.set({ ... }).

An interface describing the data returned by calling settingCollection.toJSON().

Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination.

An interface for updating data on the SettingCollection object, for use in settingCollection.set({ ... }).

An interface describing the data returned by calling setting.toJSON().

Setting represents a key-value pair of a setting persisted to the document (per file, per add-in). These custom key-value pair can be used to store state or lifecycle information needed by the content or task-pane add-in. Note that settings are persisted in the document and hence it is not a place to store any sensitive or protected information such as user information and password.

An interface for updating data on the Setting object, for use in setting.set({ ... }).

An interface describing the data returned by calling shapeCollection.toJSON().

An interface for updating data on the ShapeCollection object, for use in shapeCollection.set({ ... }).

An interface describing the data returned by calling shape.toJSON().

An interface describing the data returned by calling shapeFill.toJSON().

An interface for updating data on the ShapeFill object, for use in shapeFill.set({ ... }).

An interface describing the data returned by calling shapeFont.toJSON().

An interface for updating data on the ShapeFont object, for use in shapeFont.set({ ... }).

An interface describing the data returned by calling shapeGroup.toJSON().

An interface describing the data returned by calling shapeLineFormat.toJSON().

An interface for updating data on the ShapeLineFormat object, for use in shapeLineFormat.set({ ... }).

An interface for updating data on the Shape object, for use in shape.set({ ... }).

An interface describing the data returned by calling slicerCollection.toJSON().

An interface for updating data on the SlicerCollection object, for use in slicerCollection.set({ ... }).

An interface describing the data returned by calling slicer.toJSON().

An interface describing the data returned by calling slicerItemCollection.toJSON().

An interface for updating data on the SlicerItemCollection object, for use in slicerItemCollection.set({ ... }).

An interface describing the data returned by calling slicerItem.toJSON().

An interface for updating data on the SlicerItem object, for use in slicerItem.set({ ... }).

An interface describing the data returned by calling slicerStyleCollection.toJSON().

An interface for updating data on the SlicerStyleCollection object, for use in slicerStyleCollection.set({ ... }).

An interface describing the data returned by calling slicerStyle.toJSON().

An interface for updating data on the SlicerStyle object, for use in slicerStyle.set({ ... }).

An interface for updating data on the Slicer object, for use in slicer.set({ ... }).

An interface describing the data returned by calling styleCollection.toJSON().

Represents a collection of all the styles.

An interface for updating data on the StyleCollection object, for use in styleCollection.set({ ... }).

An interface describing the data returned by calling style.toJSON().

An object encapsulating a style's format and other properties.

An interface for updating data on the Style object, for use in style.set({ ... }).

An interface describing the data returned by calling tableCollection.toJSON().

Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.

An interface for updating data on the TableCollection object, for use in tableCollection.set({ ... }).

An interface describing the data returned by calling tableColumnCollection.toJSON().

Represents a collection of all the columns that are part of the table.

An interface for updating data on the TableColumnCollection object, for use in tableColumnCollection.set({ ... }).

An interface describing the data returned by calling tableColumn.toJSON().

Represents a column in a table.

An interface for updating data on the TableColumn object, for use in tableColumn.set({ ... }).

An interface describing the data returned by calling table.toJSON().

Represents an Excel table. To learn more about the table object model, read Work with tables using the Excel JavaScript API.

An interface describing the data returned by calling tableRowCollection.toJSON().

Represents a collection of all the rows that are part of the table.

Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a TableRow object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

An interface for updating data on the TableRowCollection object, for use in tableRowCollection.set({ ... }).

An interface describing the data returned by calling tableRow.toJSON().

Represents a row in a table.

Note that unlike ranges or columns, which will adjust if new rows or columns are added before them, a TableRow object represents the physical location of the table row, but not the data. That is, if the data is sorted or if new rows are added, a table row will continue to point at the index for which it was created.

An interface for updating data on the TableRow object, for use in tableRow.set({ ... }).

An interface describing the data returned by calling tableScopedCollection.toJSON().

An interface for updating data on the TableScopedCollection object, for use in tableScopedCollection.set({ ... }).

An interface describing the data returned by calling tableSort.toJSON().

Manages sorting operations on Table objects.

An interface describing the data returned by calling tableStyleCollection.toJSON().

An interface for updating data on the TableStyleCollection object, for use in tableStyleCollection.set({ ... }).

An interface describing the data returned by calling tableStyle.toJSON().

An interface for updating data on the TableStyle object, for use in tableStyle.set({ ... }).

An interface for updating data on the Table object, for use in table.set({ ... }).

An interface describing the data returned by calling textConditionalFormat.toJSON().

Represents a specific text conditional format.

An interface for updating data on the TextConditionalFormat object, for use in textConditionalFormat.set({ ... }).

An interface describing the data returned by calling textFrame.toJSON().

An interface for updating data on the TextFrame object, for use in textFrame.set({ ... }).

An interface describing the data returned by calling textRange.toJSON().

An interface for updating data on the TextRange object, for use in textRange.set({ ... }).

An interface describing the data returned by calling timelineStyleCollection.toJSON().

An interface for updating data on the TimelineStyleCollection object, for use in timelineStyleCollection.set({ ... }).

An interface describing the data returned by calling timelineStyle.toJSON().

An interface for updating data on the TimelineStyle object, for use in timelineStyle.set({ ... }).

An interface describing the data returned by calling topBottomConditionalFormat.toJSON().

Represents a top/bottom conditional format.

An interface for updating data on the TopBottomConditionalFormat object, for use in topBottomConditionalFormat.set({ ... }).

An interface describing the data returned by calling workbookCreated.toJSON().

An interface describing the data returned by calling workbook.toJSON().

Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges. To learn more about the workbook object model, read Work with workbooks using the Excel JavaScript API.

An interface describing the data returned by calling workbookProtection.toJSON().

Represents the protection of a workbook object.

An interface describing the data returned by calling workbookRangeAreas.toJSON().

An interface for updating data on the Workbook object, for use in workbook.set({ ... }).

An interface describing the data returned by calling worksheetCollection.toJSON().

Represents a collection of worksheet objects that are part of the workbook.

An interface for updating data on the WorksheetCollection object, for use in worksheetCollection.set({ ... }).

An interface describing the data returned by calling worksheetCustomPropertyCollection.toJSON().

An interface for updating data on the WorksheetCustomPropertyCollection object, for use in worksheetCustomPropertyCollection.set({ ... }).

An interface describing the data returned by calling worksheetCustomProperty.toJSON().

An interface for updating data on the WorksheetCustomProperty object, for use in worksheetCustomProperty.set({ ... }).

An interface describing the data returned by calling worksheet.toJSON().

An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet object model, read Work with worksheets using the Excel JavaScript API.

An interface describing the data returned by calling worksheetProtection.toJSON().

Represents the protection of a worksheet object.

An interface for updating data on the Worksheet object, for use in worksheet.set({ ... }).

Represents the List data validation criteria.

Represents the necessary strings to get/set a hyperlink (XHL) object.

Represents a string reference of the form "SheetName!A1:B5", or a global or local named range.

Provides information about the document that raised the selection changed event.

Provides information about the setting that raised the settings changed event

Represents a condition in a sorting operation.

Subtotals for the Pivot Field.

Provides information about the table that raised the changed event.

Provides information about the table that raised the selection changed event.

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

[ API set: ExcelApi 1.2 ]

Provides information about the worksheet that raised the activated event.

Provides information about the worksheet that raised the added event.

Provides information about the worksheet that raised the calculated event.

Provides information about the worksheet that raised the changed event.

Provides information about the worksheet that raised the deactivated event.

Provides information about the worksheet that raised the deleted event.

Represents the options in sheet protection.

Provides information about the worksheet that raised the selection changed event.

Aggregation function for the DataPivotHierarchy.

Specifies the type of the category axis.

Specifies the unit of time for chart axes and data series.

Specifies whether the series are by rows or by columns. In Excel on desktop, the "auto" option will inspect the source data shape to automatically guess whether the data is by rows or columns. In Excel on the web, "auto" will simply default to "columns".

Represents the horizontal alignment for the specified object.

Represents the vertical alignment for the specified object.

Represents the position of the chart title.

Represents the operator of the text conditional format type.

Represents the format options for a data bar axis.

Represents the data bar direction within a cell.

Represents the types of color criterion for conditional formatting.

Represents the direction for a selection.

Represents the types of icon conditional format.

Represents the criteria of the preset criteria conditional format type.

Represents the types of conditional format values.

Represents the operator for each icon criteria.

Represents the operator of the text conditional format type.

Represents the criteria for the above/below average conditional format type.

Represents the data validation error alert style. The default is Stop.

Represents the data validation operator enum.

Represents the data validation type enum.

Determines the direction in which existing cells will be shifted to accommodate what is being inserted.

The ShowAs calculation function for the DataPivotField.

Represents the sort direction.

Represents the ordering method to be used when sorting Chinese characters.

Represents the part of the cell used as the sorting criteria.

The position of a worksheet relative to another worksheet or the entire worksheet collection.

Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed.

[ API set: ExcelApi 1.8 ]

Executes a batch script that performs actions on the Excel object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Executes a batch script that performs actions on the Excel object model, using the RequestContext of previously-created API objects.

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created API object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.

Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.