excel package

Classes

Excel.Application

Represents the Excel application that manages the workbook.

Excel.Binding

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

Excel.BindingCollection

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

Excel.Chart

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

Excel.ChartAreaFormat

Encapsulates the format properties for the overall chart area.

Excel.ChartAxes

Represents the chart axes.

Excel.ChartAxis

Represents a single axis in a chart.

Excel.ChartAxisFormat

Encapsulates the format properties for the chart axis.

Excel.ChartAxisTitle

Represents the title of a chart axis.

Excel.ChartAxisTitleFormat

Represents the chart axis title formatting.

Excel.ChartCollection

A collection of all the chart objects on a worksheet.

Excel.ChartDataLabelFormat

Encapsulates the format properties for the chart data labels.

Excel.ChartDataLabels

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

Excel.ChartFill

Represents the fill formatting for a chart element.

Excel.ChartFont

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

Excel.ChartGridlines

Represents major or minor gridlines on a chart axis.

Excel.ChartGridlinesFormat

Encapsulates the format properties for chart gridlines.

Excel.ChartLegend

Represents the legend in a chart.

Excel.ChartLegendFormat

Encapsulates the format properties of a chart legend.

Excel.ChartLineFormat

Encapsulates the formatting options for line elements.

Excel.ChartPoint

Represents a point of a series in a chart.

Excel.ChartPointFormat

Represents the formatting object for chart points.

Excel.ChartPointsCollection

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

Excel.ChartSeries

Represents a series in a chart.

Excel.ChartSeriesCollection

Represents a collection of chart series.

Excel.ChartSeriesFormat

Encapsulates the format properties for the chart series

Excel.ChartTitle

Represents a chart title object of a chart.

Excel.ChartTitleFormat

Provides access to the formatting options for a chart title.

Excel.Filter

Manages the filtering of a table's column.

Excel.FormatProtection

Represents the format protection of a range object.

Excel.FunctionResult

An object containing the result of a function-evaluation operation

Excel.Functions

An object for evaluating Excel functions.

Excel.NamedItem

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.

Excel.NamedItemCollection

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

Excel.Range

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.

Excel.RangeBorder

Represents the border of an object.

Excel.RangeBorderCollection

Represents the border objects that make up the range border.

Excel.RangeFill

Represents the background of a range object.

Excel.RangeFont

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

Excel.RangeFormat

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

Excel.RangeSort

Manages sorting operations on Range objects.

Excel.RequestContext

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.

Excel.Table

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

Excel.TableCollection

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

Excel.TableColumn

Represents a column in a table.

Excel.TableColumnCollection

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

Excel.TableRow

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.

Excel.TableRowCollection

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.

Excel.TableSort

Manages sorting operations on Table objects.

Excel.Workbook

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.

Excel.Worksheet

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.

Excel.WorksheetCollection

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

Excel.WorksheetProtection

Represents the protection of a worksheet object.

Interfaces

Excel.BindingDataChangedEventArgs

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

Excel.BindingSelectionChangedEventArgs

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.

Excel.FilterCriteria

Represents the filtering criteria applied to a column.

Excel.FilterDatetime

Represents how to filter a date when filtering on values.

Excel.FiveArrowsGraySet

[ API set: ExcelApi 1.2 ]

Excel.FiveArrowsSet

[ API set: ExcelApi 1.2 ]

Excel.FiveBoxesSet

[ API set: ExcelApi 1.2 ]

Excel.FiveQuartersSet

[ API set: ExcelApi 1.2 ]

Excel.FiveRatingSet

[ API set: ExcelApi 1.2 ]

Excel.FourArrowsGraySet

[ API set: ExcelApi 1.2 ]

Excel.FourArrowsSet

[ API set: ExcelApi 1.2 ]

Excel.FourRatingSet

[ API set: ExcelApi 1.2 ]

Excel.FourRedToBlackSet

[ API set: ExcelApi 1.2 ]

Excel.FourTrafficLightsSet

[ API set: ExcelApi 1.2 ]

Excel.Icon

Represents a cell icon.

Excel.IconCollections

[ API set: ExcelApi 1.2 ]

Excel.Interfaces.AllowEditRangeCollectionData

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

Excel.Interfaces.AllowEditRangeCollectionUpdateData

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

Excel.Interfaces.AllowEditRangeData

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

Excel.Interfaces.AllowEditRangeUpdateData

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

Excel.Interfaces.ApplicationData

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

Excel.Interfaces.ApplicationLoadOptions

Represents the Excel application that manages the workbook.

Excel.Interfaces.ApplicationUpdateData

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

Excel.Interfaces.AutoFilterData

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

Excel.Interfaces.BindingCollectionData

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

Excel.Interfaces.BindingCollectionLoadOptions

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

Excel.Interfaces.BindingCollectionUpdateData

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

Excel.Interfaces.BindingData

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

Excel.Interfaces.BindingLoadOptions

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

Excel.Interfaces.CellValueConditionalFormatData

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

Excel.Interfaces.CellValueConditionalFormatUpdateData

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

Excel.Interfaces.ChartAreaFormatData

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

Excel.Interfaces.ChartAreaFormatLoadOptions

Encapsulates the format properties for the overall chart area.

Excel.Interfaces.ChartAreaFormatUpdateData

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

Excel.Interfaces.ChartAxesData

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

Excel.Interfaces.ChartAxesLoadOptions

Represents the chart axes.

Excel.Interfaces.ChartAxesUpdateData

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

Excel.Interfaces.ChartAxisData

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

Excel.Interfaces.ChartAxisFormatData

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

Excel.Interfaces.ChartAxisFormatLoadOptions

Encapsulates the format properties for the chart axis.

Excel.Interfaces.ChartAxisFormatUpdateData

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

Excel.Interfaces.ChartAxisLoadOptions

Represents a single axis in a chart.

Excel.Interfaces.ChartAxisTitleData

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

Excel.Interfaces.ChartAxisTitleFormatData

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

Excel.Interfaces.ChartAxisTitleFormatLoadOptions

Represents the chart axis title formatting.

Excel.Interfaces.ChartAxisTitleFormatUpdateData

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

Excel.Interfaces.ChartAxisTitleLoadOptions

Represents the title of a chart axis.

Excel.Interfaces.ChartAxisTitleUpdateData

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

Excel.Interfaces.ChartAxisUpdateData

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

Excel.Interfaces.ChartBinOptionsData

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

Excel.Interfaces.ChartBinOptionsUpdateData

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

Excel.Interfaces.ChartBorderData

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

Excel.Interfaces.ChartBorderUpdateData

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

Excel.Interfaces.ChartBoxwhiskerOptionsData

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

Excel.Interfaces.ChartBoxwhiskerOptionsUpdateData

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

Excel.Interfaces.ChartCollectionData

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

Excel.Interfaces.ChartCollectionLoadOptions

A collection of all the chart objects on a worksheet.

Excel.Interfaces.ChartCollectionUpdateData

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

Excel.Interfaces.ChartData

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

Excel.Interfaces.ChartDataLabelData

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

Excel.Interfaces.ChartDataLabelFormatData

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

Excel.Interfaces.ChartDataLabelFormatLoadOptions

Encapsulates the format properties for the chart data labels.

Excel.Interfaces.ChartDataLabelFormatUpdateData

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

Excel.Interfaces.ChartDataLabelsData

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

Excel.Interfaces.ChartDataLabelsLoadOptions

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

Excel.Interfaces.ChartDataLabelsUpdateData

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

Excel.Interfaces.ChartDataLabelUpdateData

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

Excel.Interfaces.ChartDataTableData

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

Excel.Interfaces.ChartDataTableFormatData

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

Excel.Interfaces.ChartDataTableFormatUpdateData

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

Excel.Interfaces.ChartDataTableUpdateData

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

Excel.Interfaces.ChartErrorBarsData

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

Excel.Interfaces.ChartErrorBarsFormatData

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

Excel.Interfaces.ChartErrorBarsFormatUpdateData

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

Excel.Interfaces.ChartErrorBarsUpdateData

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

Excel.Interfaces.ChartFontData

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

Excel.Interfaces.ChartFontLoadOptions

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

Excel.Interfaces.ChartFontUpdateData

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

Excel.Interfaces.ChartFormatStringData

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

Excel.Interfaces.ChartFormatStringUpdateData

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

Excel.Interfaces.ChartGridlinesData

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

Excel.Interfaces.ChartGridlinesFormatData

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

Excel.Interfaces.ChartGridlinesFormatLoadOptions

Encapsulates the format properties for chart gridlines.

Excel.Interfaces.ChartGridlinesFormatUpdateData

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

Excel.Interfaces.ChartGridlinesLoadOptions

Represents major or minor gridlines on a chart axis.

Excel.Interfaces.ChartGridlinesUpdateData

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

Excel.Interfaces.ChartLegendData

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

Excel.Interfaces.ChartLegendEntryCollectionData

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

Excel.Interfaces.ChartLegendEntryCollectionUpdateData

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

Excel.Interfaces.ChartLegendEntryData

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

Excel.Interfaces.ChartLegendEntryUpdateData

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

Excel.Interfaces.ChartLegendFormatData

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

Excel.Interfaces.ChartLegendFormatLoadOptions

Encapsulates the format properties of a chart legend.

Excel.Interfaces.ChartLegendFormatUpdateData

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

Excel.Interfaces.ChartLegendLoadOptions

Represents the legend in a chart.

Excel.Interfaces.ChartLegendUpdateData

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

Excel.Interfaces.ChartLineFormatData

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

Excel.Interfaces.ChartLineFormatLoadOptions

Encapsulates the formatting options for line elements.

Excel.Interfaces.ChartLineFormatUpdateData

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

Excel.Interfaces.ChartLoadOptions

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

Excel.Interfaces.ChartMapOptionsData

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

Excel.Interfaces.ChartMapOptionsUpdateData

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

Excel.Interfaces.ChartPivotOptionsData

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

Excel.Interfaces.ChartPivotOptionsUpdateData

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

Excel.Interfaces.ChartPlotAreaData

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

Excel.Interfaces.ChartPlotAreaFormatData

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

Excel.Interfaces.ChartPlotAreaFormatUpdateData

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

Excel.Interfaces.ChartPlotAreaUpdateData

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

Excel.Interfaces.ChartPointData

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

Excel.Interfaces.ChartPointFormatData

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

Excel.Interfaces.ChartPointFormatLoadOptions

Represents the formatting object for chart points.

Excel.Interfaces.ChartPointFormatUpdateData

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

Excel.Interfaces.ChartPointLoadOptions

Represents a point of a series in a chart.

Excel.Interfaces.ChartPointsCollectionData

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

Excel.Interfaces.ChartPointsCollectionLoadOptions

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

Excel.Interfaces.ChartPointsCollectionUpdateData

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

Excel.Interfaces.ChartPointUpdateData

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

Excel.Interfaces.ChartSeriesCollectionData

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

Excel.Interfaces.ChartSeriesCollectionLoadOptions

Represents a collection of chart series.

Excel.Interfaces.ChartSeriesCollectionUpdateData

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

Excel.Interfaces.ChartSeriesData

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

Excel.Interfaces.ChartSeriesFormatData

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

Excel.Interfaces.ChartSeriesFormatLoadOptions

Encapsulates the format properties for the chart series

Excel.Interfaces.ChartSeriesFormatUpdateData

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

Excel.Interfaces.ChartSeriesLoadOptions

Represents a series in a chart.

Excel.Interfaces.ChartSeriesUpdateData

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

Excel.Interfaces.ChartTitleData

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

Excel.Interfaces.ChartTitleFormatData

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

Excel.Interfaces.ChartTitleFormatLoadOptions

Provides access to the formatting options for a chart title.

Excel.Interfaces.ChartTitleFormatUpdateData

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

Excel.Interfaces.ChartTitleLoadOptions

Represents a chart title object of a chart.

Excel.Interfaces.ChartTitleUpdateData

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

Excel.Interfaces.ChartTrendlineCollectionData

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

Excel.Interfaces.ChartTrendlineCollectionUpdateData

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

Excel.Interfaces.ChartTrendlineData

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

Excel.Interfaces.ChartTrendlineFormatData

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

Excel.Interfaces.ChartTrendlineFormatUpdateData

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

Excel.Interfaces.ChartTrendlineLabelData

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

Excel.Interfaces.ChartTrendlineLabelFormatData

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

Excel.Interfaces.ChartTrendlineLabelFormatUpdateData

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

Excel.Interfaces.ChartTrendlineLabelUpdateData

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

Excel.Interfaces.ChartTrendlineUpdateData

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

Excel.Interfaces.ChartUpdateData

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

Excel.Interfaces.CollectionLoadOptions

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

Excel.Interfaces.ColorScaleConditionalFormatData

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

Excel.Interfaces.ColorScaleConditionalFormatUpdateData

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

Excel.Interfaces.CommentCollectionData

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

Excel.Interfaces.CommentCollectionUpdateData

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

Excel.Interfaces.CommentData

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

Excel.Interfaces.CommentReplyCollectionData

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

Excel.Interfaces.CommentReplyCollectionUpdateData

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

Excel.Interfaces.CommentReplyData

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

Excel.Interfaces.CommentReplyUpdateData

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

Excel.Interfaces.CommentUpdateData

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

Excel.Interfaces.ConditionalDataBarNegativeFormatData

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

Excel.Interfaces.ConditionalDataBarNegativeFormatUpdateData

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

Excel.Interfaces.ConditionalDataBarPositiveFormatData

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

Excel.Interfaces.ConditionalDataBarPositiveFormatUpdateData

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

Excel.Interfaces.ConditionalFormatCollectionData

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

Excel.Interfaces.ConditionalFormatCollectionUpdateData

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

Excel.Interfaces.ConditionalFormatData

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

Excel.Interfaces.ConditionalFormatRuleData

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

Excel.Interfaces.ConditionalFormatRuleUpdateData

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

Excel.Interfaces.ConditionalFormatUpdateData

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

Excel.Interfaces.ConditionalRangeBorderCollectionData

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

Excel.Interfaces.ConditionalRangeBorderCollectionUpdateData

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

Excel.Interfaces.ConditionalRangeBorderData

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

Excel.Interfaces.ConditionalRangeBorderUpdateData

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

Excel.Interfaces.ConditionalRangeFillData

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

Excel.Interfaces.ConditionalRangeFillUpdateData

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

Excel.Interfaces.ConditionalRangeFontData

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

Excel.Interfaces.ConditionalRangeFontUpdateData

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

Excel.Interfaces.ConditionalRangeFormatData

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

Excel.Interfaces.ConditionalRangeFormatUpdateData

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

Excel.Interfaces.CultureInfoData

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

Excel.Interfaces.CustomConditionalFormatData

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

Excel.Interfaces.CustomConditionalFormatUpdateData

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

Excel.Interfaces.CustomPropertyCollectionData

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

Excel.Interfaces.CustomPropertyCollectionUpdateData

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

Excel.Interfaces.CustomPropertyData

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

Excel.Interfaces.CustomPropertyUpdateData

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

Excel.Interfaces.CustomXmlPartCollectionData

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

Excel.Interfaces.CustomXmlPartCollectionUpdateData

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

Excel.Interfaces.CustomXmlPartData

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

Excel.Interfaces.CustomXmlPartScopedCollectionData

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

Excel.Interfaces.CustomXmlPartScopedCollectionUpdateData

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

Excel.Interfaces.DataBarConditionalFormatData

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

Excel.Interfaces.DataBarConditionalFormatUpdateData

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

Excel.Interfaces.DataPivotHierarchyCollectionData

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

Excel.Interfaces.DataPivotHierarchyCollectionUpdateData

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

Excel.Interfaces.DataPivotHierarchyData

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

Excel.Interfaces.DataPivotHierarchyUpdateData

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

Excel.Interfaces.DataValidationData

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

Excel.Interfaces.DataValidationUpdateData

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

Excel.Interfaces.DatetimeFormatInfoData

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

Excel.Interfaces.DocumentPropertiesData

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

Excel.Interfaces.DocumentPropertiesUpdateData

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

Excel.Interfaces.FilterData

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

Excel.Interfaces.FilterLoadOptions

Manages the filtering of a table's column.

Excel.Interfaces.FilterPivotHierarchyCollectionData

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

Excel.Interfaces.FilterPivotHierarchyCollectionUpdateData

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

Excel.Interfaces.FilterPivotHierarchyData

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

Excel.Interfaces.FilterPivotHierarchyUpdateData

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

Excel.Interfaces.FormatProtectionData

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

Excel.Interfaces.FormatProtectionLoadOptions

Represents the format protection of a range object.

Excel.Interfaces.FormatProtectionUpdateData

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

Excel.Interfaces.FunctionResultData

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

Excel.Interfaces.FunctionResultLoadOptions

An object containing the result of a function-evaluation operation

Excel.Interfaces.GeometricShapeData

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

Excel.Interfaces.GroupShapeCollectionData

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

Excel.Interfaces.GroupShapeCollectionUpdateData

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

Excel.Interfaces.HeaderFooterData

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

Excel.Interfaces.HeaderFooterGroupData

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

Excel.Interfaces.HeaderFooterGroupUpdateData

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

Excel.Interfaces.HeaderFooterUpdateData

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

Excel.Interfaces.IconSetConditionalFormatData

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

Excel.Interfaces.IconSetConditionalFormatUpdateData

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

Excel.Interfaces.ImageData

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

Excel.Interfaces.IterativeCalculationData

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

Excel.Interfaces.IterativeCalculationUpdateData

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

Excel.Interfaces.LineData

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

Excel.Interfaces.LineUpdateData

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

Excel.Interfaces.LinkedWorkbookCollectionData

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

Excel.Interfaces.LinkedWorkbookCollectionUpdateData

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

Excel.Interfaces.LinkedWorkbookData

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

Excel.Interfaces.NamedItemArrayValuesData

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

Excel.Interfaces.NamedItemCollectionData

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

Excel.Interfaces.NamedItemCollectionLoadOptions

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

Excel.Interfaces.NamedItemCollectionUpdateData

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

Excel.Interfaces.NamedItemData

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

Excel.Interfaces.NamedItemLoadOptions

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.

Excel.Interfaces.NamedItemUpdateData

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

Excel.Interfaces.NamedSheetViewCollectionData

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

Excel.Interfaces.NamedSheetViewCollectionUpdateData

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

Excel.Interfaces.NamedSheetViewData

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

Excel.Interfaces.NamedSheetViewUpdateData

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

Excel.Interfaces.NumberFormatInfoData

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

Excel.Interfaces.PageBreakCollectionData

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

Excel.Interfaces.PageBreakCollectionUpdateData

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

Excel.Interfaces.PageBreakData

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

Excel.Interfaces.PageLayoutData

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

Excel.Interfaces.PageLayoutUpdateData

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

Excel.Interfaces.PivotFieldCollectionData

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

Excel.Interfaces.PivotFieldCollectionUpdateData

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

Excel.Interfaces.PivotFieldData

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

Excel.Interfaces.PivotFieldUpdateData

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

Excel.Interfaces.PivotHierarchyCollectionData

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

Excel.Interfaces.PivotHierarchyCollectionUpdateData

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

Excel.Interfaces.PivotHierarchyData

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

Excel.Interfaces.PivotHierarchyUpdateData

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

Excel.Interfaces.PivotItemCollectionData

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

Excel.Interfaces.PivotItemCollectionUpdateData

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

Excel.Interfaces.PivotItemData

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

Excel.Interfaces.PivotItemUpdateData

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

Excel.Interfaces.PivotLayoutData

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

Excel.Interfaces.PivotLayoutUpdateData

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

Excel.Interfaces.PivotTableCollectionData

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

Excel.Interfaces.PivotTableCollectionUpdateData

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

Excel.Interfaces.PivotTableData

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

Excel.Interfaces.PivotTableScopedCollectionData

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

Excel.Interfaces.PivotTableScopedCollectionUpdateData

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

Excel.Interfaces.PivotTableStyleCollectionData

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

Excel.Interfaces.PivotTableStyleCollectionUpdateData

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

Excel.Interfaces.PivotTableStyleData

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

Excel.Interfaces.PivotTableStyleUpdateData

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

Excel.Interfaces.PivotTableUpdateData

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

Excel.Interfaces.PresetCriteriaConditionalFormatData

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

Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData

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

Excel.Interfaces.QueryCollectionData

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

Excel.Interfaces.QueryCollectionUpdateData

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

Excel.Interfaces.QueryData

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

Excel.Interfaces.RangeAreasCollectionData

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

Excel.Interfaces.RangeAreasCollectionUpdateData

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

Excel.Interfaces.RangeAreasData

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

Excel.Interfaces.RangeAreasUpdateData

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

Excel.Interfaces.RangeBorderCollectionData

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

Excel.Interfaces.RangeBorderCollectionLoadOptions

Represents the border objects that make up the range border.

Excel.Interfaces.RangeBorderCollectionUpdateData

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

Excel.Interfaces.RangeBorderData

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

Excel.Interfaces.RangeBorderLoadOptions

Represents the border of an object.

Excel.Interfaces.RangeBorderUpdateData

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

Excel.Interfaces.RangeCollectionData

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

Excel.Interfaces.RangeCollectionUpdateData

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

Excel.Interfaces.RangeData

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

Excel.Interfaces.RangeFillData

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

Excel.Interfaces.RangeFillLoadOptions

Represents the background of a range object.

Excel.Interfaces.RangeFillUpdateData

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

Excel.Interfaces.RangeFontData

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

Excel.Interfaces.RangeFontLoadOptions

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

Excel.Interfaces.RangeFontUpdateData

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

Excel.Interfaces.RangeFormatData

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

Excel.Interfaces.RangeFormatLoadOptions

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

Excel.Interfaces.RangeFormatUpdateData

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

Excel.Interfaces.RangeLoadOptions

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.

Excel.Interfaces.RangeUpdateData

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

Excel.Interfaces.RangeViewCollectionData

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

Excel.Interfaces.RangeViewCollectionUpdateData

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

Excel.Interfaces.RangeViewData

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

Excel.Interfaces.RangeViewUpdateData

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

Excel.Interfaces.RemoveDuplicatesResultData

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

Excel.Interfaces.RowColumnPivotHierarchyCollectionData

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

Excel.Interfaces.RowColumnPivotHierarchyCollectionUpdateData

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

Excel.Interfaces.RowColumnPivotHierarchyData

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

Excel.Interfaces.RowColumnPivotHierarchyUpdateData

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

Excel.Interfaces.RuntimeData

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

Excel.Interfaces.RuntimeUpdateData

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

Excel.Interfaces.SettingCollectionData

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

Excel.Interfaces.SettingCollectionUpdateData

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

Excel.Interfaces.SettingData

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

Excel.Interfaces.SettingUpdateData

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

Excel.Interfaces.ShapeCollectionData

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

Excel.Interfaces.ShapeCollectionUpdateData

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

Excel.Interfaces.ShapeData

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

Excel.Interfaces.ShapeFillData

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

Excel.Interfaces.ShapeFillUpdateData

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

Excel.Interfaces.ShapeFontData

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

Excel.Interfaces.ShapeFontUpdateData

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

Excel.Interfaces.ShapeGroupData

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

Excel.Interfaces.ShapeLineFormatData

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

Excel.Interfaces.ShapeLineFormatUpdateData

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

Excel.Interfaces.ShapeUpdateData

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

Excel.Interfaces.SlicerCollectionData

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

Excel.Interfaces.SlicerCollectionUpdateData

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

Excel.Interfaces.SlicerData

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

Excel.Interfaces.SlicerItemCollectionData

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

Excel.Interfaces.SlicerItemCollectionUpdateData

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

Excel.Interfaces.SlicerItemData

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

Excel.Interfaces.SlicerItemUpdateData

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

Excel.Interfaces.SlicerStyleCollectionData

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

Excel.Interfaces.SlicerStyleCollectionUpdateData

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

Excel.Interfaces.SlicerStyleData

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

Excel.Interfaces.SlicerStyleUpdateData

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

Excel.Interfaces.SlicerUpdateData

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

Excel.Interfaces.StyleCollectionData

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

Excel.Interfaces.StyleCollectionUpdateData

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

Excel.Interfaces.StyleData

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

Excel.Interfaces.StyleUpdateData

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

Excel.Interfaces.TableCollectionData

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

Excel.Interfaces.TableCollectionLoadOptions

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

Excel.Interfaces.TableCollectionUpdateData

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

Excel.Interfaces.TableColumnCollectionData

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

Excel.Interfaces.TableColumnCollectionLoadOptions

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

Excel.Interfaces.TableColumnCollectionUpdateData

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

Excel.Interfaces.TableColumnData

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

Excel.Interfaces.TableColumnLoadOptions

Represents a column in a table.

Excel.Interfaces.TableColumnUpdateData

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

Excel.Interfaces.TableData

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

Excel.Interfaces.TableLoadOptions

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

Excel.Interfaces.TableRowCollectionData

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

Excel.Interfaces.TableRowCollectionLoadOptions

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.

Excel.Interfaces.TableRowCollectionUpdateData

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

Excel.Interfaces.TableRowData

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

Excel.Interfaces.TableRowLoadOptions

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.

Excel.Interfaces.TableRowUpdateData

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

Excel.Interfaces.TableScopedCollectionData

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

Excel.Interfaces.TableScopedCollectionUpdateData

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

Excel.Interfaces.TableSortData

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

Excel.Interfaces.TableSortLoadOptions

Manages sorting operations on Table objects.

Excel.Interfaces.TableStyleCollectionData

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

Excel.Interfaces.TableStyleCollectionUpdateData

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

Excel.Interfaces.TableStyleData

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

Excel.Interfaces.TableStyleUpdateData

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

Excel.Interfaces.TableUpdateData

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

Excel.Interfaces.TextConditionalFormatData

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

Excel.Interfaces.TextConditionalFormatUpdateData

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

Excel.Interfaces.TextFrameData

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

Excel.Interfaces.TextFrameUpdateData

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

Excel.Interfaces.TextRangeData

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

Excel.Interfaces.TextRangeUpdateData

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

Excel.Interfaces.TimelineStyleCollectionData

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

Excel.Interfaces.TimelineStyleCollectionUpdateData

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

Excel.Interfaces.TimelineStyleData

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

Excel.Interfaces.TimelineStyleUpdateData

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

Excel.Interfaces.TopBottomConditionalFormatData

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

Excel.Interfaces.TopBottomConditionalFormatUpdateData

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

Excel.Interfaces.WorkbookCreatedData

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

Excel.Interfaces.WorkbookData

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

Excel.Interfaces.WorkbookLoadOptions

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.

Excel.Interfaces.WorkbookProtectionData

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

Excel.Interfaces.WorkbookRangeAreasData

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

Excel.Interfaces.WorkbookUpdateData

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

Excel.Interfaces.WorksheetCollectionData

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

Excel.Interfaces.WorksheetCollectionLoadOptions

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

Excel.Interfaces.WorksheetCollectionUpdateData

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

Excel.Interfaces.WorksheetCustomPropertyCollectionData

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

Excel.Interfaces.WorksheetCustomPropertyCollectionUpdateData

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

Excel.Interfaces.WorksheetCustomPropertyData

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

Excel.Interfaces.WorksheetCustomPropertyUpdateData

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

Excel.Interfaces.WorksheetData

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

Excel.Interfaces.WorksheetLoadOptions

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.

Excel.Interfaces.WorksheetProtectionData

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

Excel.Interfaces.WorksheetProtectionLoadOptions

Represents the protection of a worksheet object.

Excel.Interfaces.WorksheetUpdateData

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

Excel.RangeReference

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

Excel.RunOptions
Excel.SelectionChangedEventArgs

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

Excel.Session
Excel.SortField

Represents a condition in a sorting operation.

Excel.ThreeArrowsGraySet

[ API set: ExcelApi 1.2 ]

Excel.ThreeArrowsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeFlagsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeSignsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeStarsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeSymbols2Set

[ API set: ExcelApi 1.2 ]

Excel.ThreeSymbolsSet

[ API set: ExcelApi 1.2 ]

Excel.ThreeTrafficLights1Set

[ API set: ExcelApi 1.2 ]

Excel.ThreeTrafficLights2Set

[ API set: ExcelApi 1.2 ]

Excel.ThreeTrianglesSet

[ API set: ExcelApi 1.2 ]

Excel.WorksheetProtectionOptions

Represents the options in sheet protection.

Enums

Excel.BindingType
Excel.BorderIndex
Excel.BorderLineStyle
Excel.BorderWeight
Excel.CalculationMode
Excel.CalculationType
Excel.ChartDataLabelPosition
Excel.ChartLegendPosition
Excel.ChartSeriesBy

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".

Excel.ChartType
Excel.ChartUnderlineStyle
Excel.ClearApplyTo
Excel.DeleteShiftDirection
Excel.DynamicFilterCriteria
Excel.ErrorCodes
Excel.FilterDatetimeSpecificity
Excel.FilterOn
Excel.FilterOperator
Excel.HorizontalAlignment
Excel.IconSet
Excel.ImageFittingMode
Excel.InsertShiftDirection

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

Excel.NamedItemType
Excel.RangeUnderlineStyle
Excel.RangeValueType
Excel.SheetVisibility
Excel.SortDataOption
Excel.SortMethod

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

Excel.SortOn

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

Excel.SortOrientation
Excel.VerticalAlignment

Functions

Excel.getDataCommonPostprocess(response, callArgs)
Excel.postprocessBindingDescriptor(response)
Excel.run(batch)

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.

Excel.run(object, batch)

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.

Excel.run(objects, batch)

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

Excel.run(options, batch)

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.

Excel.run(context, batch)

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.

Function Details

Excel.getDataCommonPostprocess(response, callArgs)

export function getDataCommonPostprocess(response: any, callArgs: any): any;

Parameters

response

any

callArgs

any

Returns

any

Excel.postprocessBindingDescriptor(response)

export function postprocessBindingDescriptor(response: any): any;

Parameters

response

any

Returns

any

Excel.run(batch)

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.

export function run<T>(batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

batch

(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(object, batch)

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.

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

object
OfficeExtension.ClientObject

A previously-created API object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".

batch

(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(objects, batch)

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

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

objects

OfficeExtension.ClientObject[]

An array of previously-created API objects. The array will be validated to make sure that all of the objects share the same context. The batch will use this shared RequestContext, which means that any changes applied to these objects will be picked up by "context.sync()".

batch

(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(options, batch)

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.

export function run<T>(options: Excel.RunOptions, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

options
Excel.RunOptions

The additional options for this Excel.run which specify previous objects, whether to delay the request for cell edit, session info, etc.

batch

(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>

Excel.run(context, batch)

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.

export function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;

Parameters

context
OfficeExtension.ClientRequestContext

A previously-created object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()".

batch

(context: Excel.RequestContext) => Promise<T>

A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.

Returns

Promise<T>