Represents anAllowEditRange object found in a worksheet. This object works with worksheet protection properties. When worksheet protection is enabled, anAllowEditRange object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.

Represents the set ofAllowEditRange objects found in a worksheet.AllowEditRange objects work with worksheet protection properties. When worksheet protection is enabled, anAllowEditRange object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.

Represents the Excel application that manages the workbook.

Represents theAutoFilter object. AutoFilter turns the values in Excel column into specific filters based on the cell contents.

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, seeWork 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.

Encapsulates the bin options for histogram charts and pareto charts.

Represents the border formatting of a chart element.

Represents the properties of a box and whisker chart.

A collection of all the chart objects on a worksheet.

Represents the data label of a chart point.

Represents the chart data label anchor.

Encapsulates the format properties for the chart data labels.

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

Represents the data table object of a chart.

Represents the format of a chart data table.

This object represents the attributes for a chart's error bars.

Encapsulates the format properties for chart error bars.

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 aChartTitle object orChartAxisTitle object.

Represents major or minor gridlines on a chart axis.

Encapsulates the format properties for chart gridlines.

Gets an object that represents the formatting of chart leader lines.

Encapsulates the format properties for leader lines.

Represents the legend in a chart.

Represents the legend entry inlegendEntryCollection.

Represents a collection of legend entries.

Encapsulates the format properties of a chart legend.

Encapsulates the formatting options for line elements.

Encapsulates the properties for a region map chart.

Encapsulates the options for the pivot chart.

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 comment in the workbook.

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

Represents a comment reply in the workbook.

Represents a collection of comment reply objects that are part of the comment.

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, readApply 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.

Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.

Represents a custom conditional format type.

Manages settings on custom functions.

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, readAdd data validation to Excel ranges.

Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.

Represents workbook properties.

Represents a task.

Represents a recorded change to the task.

Represents a collection of change records for a task.

Represents a collection of tasks.

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 a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel.

Represents the shape collection inside a shape group.

Represents an icon set criteria for conditional formatting.

Represents an image in the worksheet. To get the correspondingShape object, useImage.shape.

Represents the iterative calculation settings.

Represents a line inside a worksheet. To get the correspondingShape object, useLine.shape.

Represents a linked data type. A linked data type is a data type connected to an online data source.

Represents a collection of linked data types.

Represents a specific category or field of information that shares some common characteristics or attributes. A data domain is linked to a data provider, that acts as the data source forLinkedEntityCellValue objects in the workbook. A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.

Represents a collection ofLinkedEntityDataDomain objects. The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.

Contains information about a linked workbook. If a workbook has links pointing to data in another workbook, the second workbook is linked to the first workbook. In this scenario, the second workbook is called the "linked workbook".

Represents a collection of linked workbook objects.

Provides information about the local image.

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 theNamedItem objects that are part of the workbook or worksheet, depending on how it was reached.

Represents a named sheet view of a worksheet. A sheet view stores the sort and filter rules for a particular worksheet. Every sheet view (even a temporary sheet view) has a unique, worksheet-scoped name that is used to access the view.

Represents the collection of sheet views in the worksheet.

Represents a note in the workbook or worksheet.

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

Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.

Represents layout and print settings that are not dependent on any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area.

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, readWork with PivotTables using the Excel JavaScript API.

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

Represents a scoped collection of PivotTables. The PivotTables are sorted based on the location of the PivotTable's top-left corner. They are ordered top-to-bottom and then left-to-right.

Represents a PivotTable style, which defines style elements by PivotTable region.

Represents a collection of PivotTable styles.

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

Represents a Power Query query.

Represents the collection of queries in the workbook.

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 withRanges in the Excel JavaScript API.

RangeAreas represents a collection of one or more rectangular ranges in the same worksheet. To learn how to use discontiguous ranges, readWork with multiple ranges simultaneously in Excel add-ins.

Contains the collection of cross-workbook level ranges.

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 onRange objects.

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

Represents a collection ofRangeView objects.

Represents the results fromRange.removeDuplicates.

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.

Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. To learn more about the shape object model, readWork with shapes using the Excel JavaScript API.

Represents a collection of all the shapes in the worksheet.

Represents the fill formatting of a shape object.

Represents the font attributes, such as font name, font size, and color, for a shape'sTextRange object.

Represents a shape group inside a worksheet. To get the correspondingShape object, useShapeGroup.shape.

Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.

Represents aSlicer object in the workbook.

Represents a collection of all the slicer objects in the workbook or a worksheet.

Represents a slicer item in a slicer.

Represents a collection of all the slicer item objects in the slicer.

Represents a slicer style, which defines style elements by region of the slicer.

Represents a collection ofSlicerStyle objects.

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, readWork 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, aTableRow 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, aTableRow 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 scoped collection of tables. For each table its top-left corner is considered its anchor location, and the tables are sorted top-to-bottom and then left-to-right.

Manages sorting operations onTable objects.

Represents a table style, which defines the style elements by region of the table.

Represents a collection of table styles.

Represents a specific text conditional format.

Represents the text frame of a shape object.

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

Represents aTimelineStyle, which defines style elements by region in the timeline.

Represents a collection of timeline styles.

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, readWork with workbooks using the Excel JavaScript API.

TheWorkbookCreated object is the top level object created byApplication.CreateWorkbook. AWorkbookCreated object is a special Workbook object.

Represents the protection of a workbook object.

Represents a collection of one or more rectangular ranges in multiple worksheets.

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

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

Represents a worksheet-level custom property.

Contains the collection of worksheet-level custom property.

Represents the protection of a worksheet object.

The interface used to construct optional fields of theAllowEditRange object.

Represents a 2D array of cell values.

The Base64-encoded type and data of an image.

Represents a card layout used for the Boolean, double, and string basic types.

The basic compact layout properties.

Represents the basic type data validation criteria.

Represents layout information for various views of the value and its properties.

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. UseWorksheet.onSelectionChanged for multiple selected ranges.

Represents the value of a cell containing a #BLOCKED! error.

Represents the value of a cell containing a Boolean.

Represents the value of a cell containing a #BUSY! error.

Represents the value of a cell containing a #CALC! error.

Represents a section of a card that is arranged as a list in card view.

Represents a reference to a property used by the card layout.

Properties of a card layout relevant to most card layouts.

Properties of a card layout relevant to most card layouts.

Represents a section of a card that is arranged as a table in card view.

Represents a section of a card that is arranged as two columns in card view.

Represents the properties of a single border returned bygetCellProperties,getRowProperties, andgetColumnProperties, or the border property input parameter ofsetCellProperties,setRowProperties, andsetColumnProperties.

Represents theformat.borders properties ofgetCellProperties,getRowProperties, andgetColumnProperties, or theformat.borders input parameter ofsetCellProperties,setRowProperties, andsetColumnProperties.

Represents the returned properties of getCellProperties.

[API set: ExcelApi 1.9 ]

Specifies which properties to load on theformat.borders object.

Represents theformat.fill properties ofgetCellProperties,getRowProperties, andgetColumnProperties or theformat.fill input parameter ofsetCellProperties,setRowProperties, andsetColumnProperties.

Specifies which properties to load on theformat.fill object.

Represents theformat.font properties ofgetCellProperties,getRowProperties, andgetColumnProperties, or theformat.font input parameter ofsetCellProperties,setRowProperties, andsetColumnProperties.

Specifies which properties to load on theformat.font object.

Represents the returned format properties of getCellProperties or format input parameter of setCellProperties.

[API set: ExcelApi 1.9 ]

Represents which properties to load on the format object.

[API set: ExcelApi 1.9 ]

Represents which cell properties to load, when used as part of a "range.getCellProperties" method.

[API set: ExcelApi 1.9 ]

Represents theformat.protection properties ofgetCellProperties,getRowProperties, andgetColumnProperties, or theformat.protection input parameter ofsetCellProperties,setRowProperties, andsetColumnProperties.

The attribution attributes object represents the set of details that can be used to describe where information came from, if the information comes from a public source.

These extra properties may appear on aCellValue and provide information about thatCellValue, but the extra properties are not part of the value in the cell.

Metadata about a property inEntityCellValue.properties.

Represents the exclusion of a property inEntityCellValue.properties from features of Excel.

The provider attributes object represents the set of details used in card view to provide specified branding information for aCellValue type that supports provider attributes.

Provides information about the details of aWorksheetChangedEvent orTableChangedEvent.

Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet.

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 checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.

Represents the returned properties of getColumnProperties.

[API set: ExcelApi 1.9 ]

Represents which column properties to load, when used as part of a "range.getColumnProperties" method.

[API set: ExcelApi 1.9 ]

Provides information about the comments that raised the comment added event.

Occurs when existing comments are changed.

Provides information about the comments that raised the comment deleted event.

A structure for the comment ID and IDs of its related replies.

Represents the entity that is mentioned in comments.

Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions.

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 value of a cell containing a #CONNECT! error.

Represents the custom data validation criteria.

Represents which custom functions to show or hide in Excel AutoComplete.

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 theExcel.DataValidationType.

Represents the date data validation criteria.

Represents the value of a cell containing a #DIV/0! error.

Represents information about a task's schedule.

Represents the value of a cell containing a double.

Represents information about a user's identity.

Represents an empty cell control. This represents the state where a cell does not have a control.

Represents the value of a cell that's empty and has no formulas or data.

Represents a card layout that is best used for an array.

Represents a card layout that is best used for an entity.

Represents a set of properties without a schema or defined structure.

The compact layout properties for an entity.

Properties used byCellValueAndPropertyMetadata. These properties refer to the metadata and not to aCellValue.

Represents layout information for various views of the entity.

Represents the value of a cell containing an External Code Service Object, such as Python code formula.

Represents the value of a cell containing an #EXTERNAL! error.

Represents the value of a cell containing a #FIELD! error.

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 ]

Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, seeReview guidelines for customizing a number format. In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation.

Provides information about a changed formula during a formula 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 ]

Represents the value of a cell containing a #GETTING_DATA error.

Represents a cell icon.

[API set: ExcelApi 1.2 ]

Represents information about a user's identity.

The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted.

An interface describing the data returned by callingallowEditRangeCollection.toJSON().

Represents the set ofAllowEditRange objects found in a worksheet.AllowEditRange objects work with worksheet protection properties. When worksheet protection is enabled, anAllowEditRange object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.

An interface for updating data on theAllowEditRangeCollection object, for use inallowEditRangeCollection.set({ ... }).

An interface describing the data returned by callingallowEditRange.toJSON().

Represents anAllowEditRange object found in a worksheet. This object works with worksheet protection properties. When worksheet protection is enabled, anAllowEditRange object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.

An interface for updating data on theAllowEditRange object, for use inallowEditRange.set({ ... }).

An interface describing the data returned by callingapplication.toJSON().

Represents the Excel application that manages the workbook.

An interface for updating data on theApplication object, for use inapplication.set({ ... }).

An interface describing the data returned by callingautoFilter.toJSON().

Represents theAutoFilter object. AutoFilter turns the values in Excel column into specific filters based on the cell contents.

An interface describing the data returned by callingbindingCollection.toJSON().

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

An interface for updating data on theBindingCollection object, for use inbindingCollection.set({ ... }).

An interface describing the data returned by callingbinding.toJSON().

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

An interface describing the data returned by callingcellValueConditionalFormat.toJSON().

Represents a cell value conditional format.

An interface for updating data on theCellValueConditionalFormat object, for use incellValueConditionalFormat.set({ ... }).

An interface describing the data returned by callingchartAreaFormat.toJSON().

Encapsulates the format properties for the overall chart area.

An interface for updating data on theChartAreaFormat object, for use inchartAreaFormat.set({ ... }).

An interface describing the data returned by callingchartAxes.toJSON().

Represents the chart axes.

An interface for updating data on theChartAxes object, for use inchartAxes.set({ ... }).

An interface describing the data returned by callingchartAxis.toJSON().

An interface describing the data returned by callingchartAxisFormat.toJSON().

Encapsulates the format properties for the chart axis.

An interface for updating data on theChartAxisFormat object, for use inchartAxisFormat.set({ ... }).

Represents a single axis in a chart.

An interface describing the data returned by callingchartAxisTitle.toJSON().

An interface describing the data returned by callingchartAxisTitleFormat.toJSON().

Represents the chart axis title formatting.

An interface for updating data on theChartAxisTitleFormat object, for use inchartAxisTitleFormat.set({ ... }).

Represents the title of a chart axis.

An interface for updating data on theChartAxisTitle object, for use inchartAxisTitle.set({ ... }).

An interface for updating data on theChartAxis object, for use inchartAxis.set({ ... }).

An interface describing the data returned by callingchartBinOptions.toJSON().

Encapsulates the bin options for histogram charts and pareto charts.

An interface for updating data on theChartBinOptions object, for use inchartBinOptions.set({ ... }).

An interface describing the data returned by callingchartBorder.toJSON().

Represents the border formatting of a chart element.

An interface for updating data on theChartBorder object, for use inchartBorder.set({ ... }).

An interface describing the data returned by callingchartBoxwhiskerOptions.toJSON().

Represents the properties of a box and whisker chart.

An interface for updating data on theChartBoxwhiskerOptions object, for use inchartBoxwhiskerOptions.set({ ... }).

An interface describing the data returned by callingchartCollection.toJSON().

A collection of all the chart objects on a worksheet.

An interface for updating data on theChartCollection object, for use inchartCollection.set({ ... }).

An interface describing the data returned by callingchart.toJSON().

An interface describing the data returned by callingchartDataLabelAnchor.toJSON().

Represents the chart data label anchor.

An interface for updating data on theChartDataLabelAnchor object, for use inchartDataLabelAnchor.set({ ... }).

An interface describing the data returned by callingchartDataLabel.toJSON().

An interface describing the data returned by callingchartDataLabelFormat.toJSON().

Encapsulates the format properties for the chart data labels.

An interface for updating data on theChartDataLabelFormat object, for use inchartDataLabelFormat.set({ ... }).

Represents the data label of a chart point.

An interface describing the data returned by callingchartDataLabels.toJSON().

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

An interface for updating data on theChartDataLabels object, for use inchartDataLabels.set({ ... }).

An interface for updating data on theChartDataLabel object, for use inchartDataLabel.set({ ... }).

An interface describing the data returned by callingchartDataTable.toJSON().

An interface describing the data returned by callingchartDataTableFormat.toJSON().

Represents the format of a chart data table.

An interface for updating data on theChartDataTableFormat object, for use inchartDataTableFormat.set({ ... }).

Represents the data table object of a chart.

An interface for updating data on theChartDataTable object, for use inchartDataTable.set({ ... }).

An interface describing the data returned by callingchartErrorBars.toJSON().

An interface describing the data returned by callingchartErrorBarsFormat.toJSON().

Encapsulates the format properties for chart error bars.

An interface for updating data on theChartErrorBarsFormat object, for use inchartErrorBarsFormat.set({ ... }).

This object represents the attributes for a chart's error bars.

An interface for updating data on theChartErrorBars object, for use inchartErrorBars.set({ ... }).

An interface describing the data returned by callingchartFont.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 theChartFont object, for use inchartFont.set({ ... }).

An interface describing the data returned by callingchartFormatString.toJSON().

Represents the substring in chart related objects that contain text, like aChartTitle object orChartAxisTitle object.

An interface for updating data on theChartFormatString object, for use inchartFormatString.set({ ... }).

An interface describing the data returned by callingchartGridlines.toJSON().

An interface describing the data returned by callingchartGridlinesFormat.toJSON().

Encapsulates the format properties for chart gridlines.

An interface for updating data on theChartGridlinesFormat object, for use inchartGridlinesFormat.set({ ... }).

Represents major or minor gridlines on a chart axis.

An interface for updating data on theChartGridlines object, for use inchartGridlines.set({ ... }).

An interface describing the data returned by callingchartLeaderLines.toJSON().

An interface describing the data returned by callingchartLeaderLinesFormat.toJSON().

Encapsulates the format properties for leader lines.

An interface for updating data on theChartLeaderLinesFormat object, for use inchartLeaderLinesFormat.set({ ... }).

Gets an object that represents the formatting of chart leader lines.

An interface for updating data on theChartLeaderLines object, for use inchartLeaderLines.set({ ... }).

An interface describing the data returned by callingchartLegend.toJSON().

An interface describing the data returned by callingchartLegendEntryCollection.toJSON().

Represents a collection of legend entries.

An interface for updating data on theChartLegendEntryCollection object, for use inchartLegendEntryCollection.set({ ... }).

An interface describing the data returned by callingchartLegendEntry.toJSON().

Represents the legend entry inlegendEntryCollection.

An interface for updating data on theChartLegendEntry object, for use inchartLegendEntry.set({ ... }).

An interface describing the data returned by callingchartLegendFormat.toJSON().

Encapsulates the format properties of a chart legend.

An interface for updating data on theChartLegendFormat object, for use inchartLegendFormat.set({ ... }).

Represents the legend in a chart.

An interface for updating data on theChartLegend object, for use inchartLegend.set({ ... }).

An interface describing the data returned by callingchartLineFormat.toJSON().

Encapsulates the formatting options for line elements.

An interface for updating data on theChartLineFormat object, for use inchartLineFormat.set({ ... }).

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

An interface describing the data returned by callingchartMapOptions.toJSON().

Encapsulates the properties for a region map chart.

An interface for updating data on theChartMapOptions object, for use inchartMapOptions.set({ ... }).

An interface describing the data returned by callingchartPivotOptions.toJSON().

Encapsulates the options for the pivot chart.

An interface for updating data on theChartPivotOptions object, for use inchartPivotOptions.set({ ... }).

An interface describing the data returned by callingchartPlotArea.toJSON().

An interface describing the data returned by callingchartPlotAreaFormat.toJSON().

Represents the format properties for a chart plot area.

An interface for updating data on theChartPlotAreaFormat object, for use inchartPlotAreaFormat.set({ ... }).

This object represents the attributes for a chart plot area.

An interface for updating data on theChartPlotArea object, for use inchartPlotArea.set({ ... }).

An interface describing the data returned by callingchartPoint.toJSON().

An interface describing the data returned by callingchartPointFormat.toJSON().

Represents the formatting object for chart points.

An interface for updating data on theChartPointFormat object, for use inchartPointFormat.set({ ... }).

Represents a point of a series in a chart.

An interface describing the data returned by callingchartPointsCollection.toJSON().

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

An interface for updating data on theChartPointsCollection object, for use inchartPointsCollection.set({ ... }).

An interface for updating data on theChartPoint object, for use inchartPoint.set({ ... }).

An interface describing the data returned by callingchartSeriesCollection.toJSON().

Represents a collection of chart series.

An interface for updating data on theChartSeriesCollection object, for use inchartSeriesCollection.set({ ... }).

An interface describing the data returned by callingchartSeries.toJSON().

An interface describing the data returned by callingchartSeriesFormat.toJSON().

Encapsulates the format properties for the chart series

An interface for updating data on theChartSeriesFormat object, for use inchartSeriesFormat.set({ ... }).

Represents a series in a chart.

An interface for updating data on theChartSeries object, for use inchartSeries.set({ ... }).

An interface describing the data returned by callingchartTitle.toJSON().

An interface describing the data returned by callingchartTitleFormat.toJSON().

Provides access to the formatting options for a chart title.

An interface for updating data on theChartTitleFormat object, for use inchartTitleFormat.set({ ... }).

Represents a chart title object of a chart.

An interface for updating data on theChartTitle object, for use inchartTitle.set({ ... }).

An interface describing the data returned by callingchartTrendlineCollection.toJSON().

Represents a collection of chart trendlines.

An interface for updating data on theChartTrendlineCollection object, for use inchartTrendlineCollection.set({ ... }).

An interface describing the data returned by callingchartTrendline.toJSON().

An interface describing the data returned by callingchartTrendlineFormat.toJSON().

Represents the format properties for the chart trendline.

An interface for updating data on theChartTrendlineFormat object, for use inchartTrendlineFormat.set({ ... }).

An interface describing the data returned by callingchartTrendlineLabel.toJSON().

An interface describing the data returned by callingchartTrendlineLabelFormat.toJSON().

Encapsulates the format properties for the chart trendline label.

An interface for updating data on theChartTrendlineLabelFormat object, for use inchartTrendlineLabelFormat.set({ ... }).

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

An interface for updating data on theChartTrendlineLabel object, for use inchartTrendlineLabel.set({ ... }).

This object represents the attributes for a chart trendline object.

An interface for updating data on theChartTrendline object, for use inchartTrendline.set({ ... }).

An interface for updating data on theChart object, for use inchart.set({ ... }).

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

An interface describing the data returned by callingcolorScaleConditionalFormat.toJSON().

Represents the color scale criteria for conditional formatting.

An interface for updating data on theColorScaleConditionalFormat object, for use incolorScaleConditionalFormat.set({ ... }).

An interface describing the data returned by callingcommentCollection.toJSON().

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

An interface for updating data on theCommentCollection object, for use incommentCollection.set({ ... }).

An interface describing the data returned by callingcomment.toJSON().

Represents a comment in the workbook.

An interface describing the data returned by callingcommentReplyCollection.toJSON().

Represents a collection of comment reply objects that are part of the comment.

An interface for updating data on theCommentReplyCollection object, for use incommentReplyCollection.set({ ... }).

An interface describing the data returned by callingcommentReply.toJSON().

Represents a comment reply in the workbook.

An interface for updating data on theCommentReply object, for use incommentReply.set({ ... }).

An interface for updating data on theComment object, for use incomment.set({ ... }).

An interface describing the data returned by callingconditionalDataBarNegativeFormat.toJSON().

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

An interface for updating data on theConditionalDataBarNegativeFormat object, for use inconditionalDataBarNegativeFormat.set({ ... }).

An interface describing the data returned by callingconditionalDataBarPositiveFormat.toJSON().

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

An interface for updating data on theConditionalDataBarPositiveFormat object, for use inconditionalDataBarPositiveFormat.set({ ... }).

An interface describing the data returned by callingconditionalFormatCollection.toJSON().

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

An interface for updating data on theConditionalFormatCollection object, for use inconditionalFormatCollection.set({ ... }).

An interface describing the data returned by callingconditionalFormat.toJSON().

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

An interface describing the data returned by callingconditionalFormatRule.toJSON().

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

An interface for updating data on theConditionalFormatRule object, for use inconditionalFormatRule.set({ ... }).

An interface for updating data on theConditionalFormat object, for use inconditionalFormat.set({ ... }).

An interface describing the data returned by callingconditionalRangeBorderCollection.toJSON().

Represents the border objects that make up range border.

An interface for updating data on theConditionalRangeBorderCollection object, for use inconditionalRangeBorderCollection.set({ ... }).

An interface describing the data returned by callingconditionalRangeBorder.toJSON().

Represents the border of an object.

An interface for updating data on theConditionalRangeBorder object, for use inconditionalRangeBorder.set({ ... }).

An interface describing the data returned by callingconditionalRangeFill.toJSON().

Represents the background of a conditional range object.

An interface for updating data on theConditionalRangeFill object, for use inconditionalRangeFill.set({ ... }).

An interface describing the data returned by callingconditionalRangeFont.toJSON().

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

An interface for updating data on theConditionalRangeFont object, for use inconditionalRangeFont.set({ ... }).

An interface describing the data returned by callingconditionalRangeFormat.toJSON().

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

An interface for updating data on theConditionalRangeFormat object, for use inconditionalRangeFormat.set({ ... }).

An interface describing the data returned by callingcultureInfo.toJSON().

Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings.

An interface describing the data returned by callingcustomConditionalFormat.toJSON().

Represents a custom conditional format type.

An interface for updating data on theCustomConditionalFormat object, for use incustomConditionalFormat.set({ ... }).

An interface describing the data returned by callingcustomFunctionManager.toJSON().

An interface describing the data returned by callingcustomPropertyCollection.toJSON().

Contains the collection of custom properties.

An interface for updating data on theCustomPropertyCollection object, for use incustomPropertyCollection.set({ ... }).

An interface describing the data returned by callingcustomProperty.toJSON().

Represents a custom property.

An interface for updating data on theCustomProperty object, for use incustomProperty.set({ ... }).

An interface describing the data returned by callingcustomXmlPartCollection.toJSON().

A collection of custom XML parts.

An interface for updating data on theCustomXmlPartCollection object, for use incustomXmlPartCollection.set({ ... }).

An interface describing the data returned by callingcustomXmlPart.toJSON().

Represents a custom XML part object in a workbook.

An interface describing the data returned by callingcustomXmlPartScopedCollection.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 theCustomXmlPartScopedCollection object, for use incustomXmlPartScopedCollection.set({ ... }).

An interface describing the data returned by callingdataBarConditionalFormat.toJSON().

Represents an Excel conditional data bar type.

An interface for updating data on theDataBarConditionalFormat object, for use indataBarConditionalFormat.set({ ... }).

An interface describing the data returned by callingdataPivotHierarchyCollection.toJSON().

Represents a collection of DataPivotHierarchy items associated with the PivotTable.

An interface for updating data on theDataPivotHierarchyCollection object, for use indataPivotHierarchyCollection.set({ ... }).

An interface describing the data returned by callingdataPivotHierarchy.toJSON().

Represents the Excel DataPivotHierarchy.

An interface for updating data on theDataPivotHierarchy object, for use indataPivotHierarchy.set({ ... }).

An interface describing the data returned by callingdataValidation.toJSON().

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

An interface for updating data on theDataValidation object, for use indataValidation.set({ ... }).

An interface describing the data returned by callingdatetimeFormatInfo.toJSON().

Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.

An interface describing the data returned by callingdocumentProperties.toJSON().

Represents workbook properties.

An interface for updating data on theDocumentProperties object, for use indocumentProperties.set({ ... }).

An interface describing the data returned by callingdocumentTaskChangeCollection.toJSON().

Represents a collection of change records for a task.

An interface for updating data on theDocumentTaskChangeCollection object, for use indocumentTaskChangeCollection.set({ ... }).

An interface describing the data returned by callingdocumentTaskChange.toJSON().

Represents a recorded change to the task.

An interface describing the data returned by callingdocumentTaskCollection.toJSON().

Represents a collection of tasks.

An interface for updating data on theDocumentTaskCollection object, for use indocumentTaskCollection.set({ ... }).

An interface describing the data returned by callingdocumentTask.toJSON().

Represents a task.

An interface for updating data on theDocumentTask object, for use indocumentTask.set({ ... }).

An interface describing the data returned by callingfilter.toJSON().

Manages the filtering of a table's column.

An interface describing the data returned by callingfilterPivotHierarchyCollection.toJSON().

Represents a collection of FilterPivotHierarchy items associated with the PivotTable.

An interface for updating data on theFilterPivotHierarchyCollection object, for use infilterPivotHierarchyCollection.set({ ... }).

An interface describing the data returned by callingfilterPivotHierarchy.toJSON().

Represents the Excel FilterPivotHierarchy.

An interface for updating data on theFilterPivotHierarchy object, for use infilterPivotHierarchy.set({ ... }).

An interface describing the data returned by callingformatProtection.toJSON().

Represents the format protection of a range object.

An interface for updating data on theFormatProtection object, for use informatProtection.set({ ... }).

An interface describing the data returned by callingfunctionResult.toJSON().

An object containing the result of a function-evaluation operation

An interface describing the data returned by callinggeometricShape.toJSON().

Represents a geometric shape inside a worksheet. A geometric shape can be a rectangle, block arrow, equation symbol, flowchart item, star, banner, callout, or any other basic shape in Excel.

An interface describing the data returned by callinggroupShapeCollection.toJSON().

Represents the shape collection inside a shape group.

An interface for updating data on theGroupShapeCollection object, for use ingroupShapeCollection.set({ ... }).

An interface describing the data returned by callingheaderFooter.toJSON().

An interface describing the data returned by callingheaderFooterGroup.toJSON().

An interface for updating data on theHeaderFooterGroup object, for use inheaderFooterGroup.set({ ... }).

An interface for updating data on theHeaderFooter object, for use inheaderFooter.set({ ... }).

An interface describing the data returned by callingiconSetConditionalFormat.toJSON().

Represents an icon set criteria for conditional formatting.

An interface for updating data on theIconSetConditionalFormat object, for use iniconSetConditionalFormat.set({ ... }).

An interface describing the data returned by callingimage.toJSON().

Represents an image in the worksheet. To get the correspondingShape object, useImage.shape.

An interface describing the data returned by callingiterativeCalculation.toJSON().

Represents the iterative calculation settings.

An interface for updating data on theIterativeCalculation object, for use initerativeCalculation.set({ ... }).

An interface describing the data returned by callingline.toJSON().

Represents a line inside a worksheet. To get the correspondingShape object, useLine.shape.

An interface for updating data on theLine object, for use inline.set({ ... }).

An interface describing the data returned by callinglinkedDataTypeCollection.toJSON().

Represents a collection of linked data types.

An interface for updating data on theLinkedDataTypeCollection object, for use inlinkedDataTypeCollection.set({ ... }).

An interface describing the data returned by callinglinkedDataType.toJSON().

Represents a linked data type. A linked data type is a data type connected to an online data source.

An interface describing the data returned by callinglinkedEntityDataDomainCollection.toJSON().

Represents a collection ofLinkedEntityDataDomain objects. The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.

An interface for updating data on theLinkedEntityDataDomainCollection object, for use inlinkedEntityDataDomainCollection.set({ ... }).

An interface describing the data returned by callinglinkedEntityDataDomain.toJSON().

Represents a specific category or field of information that shares some common characteristics or attributes. A data domain is linked to a data provider, that acts as the data source forLinkedEntityCellValue objects in the workbook. A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.

An interface for updating data on theLinkedEntityDataDomain object, for use inlinkedEntityDataDomain.set({ ... }).

An interface describing the data returned by callinglinkedWorkbookCollection.toJSON().

Represents a collection of linked workbook objects.

An interface for updating data on theLinkedWorkbookCollection object, for use inlinkedWorkbookCollection.set({ ... }).

An interface describing the data returned by callinglinkedWorkbook.toJSON().

Contains information about a linked workbook. If a workbook has links pointing to data in another workbook, the second workbook is linked to the first workbook. In this scenario, the second workbook is called the "linked workbook".

An interface describing the data returned by callingnamedItemArrayValues.toJSON().

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

An interface describing the data returned by callingnamedItemCollection.toJSON().

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

An interface for updating data on theNamedItemCollection object, for use innamedItemCollection.set({ ... }).

An interface describing the data returned by callingnamedItem.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 theNamedItem object, for use innamedItem.set({ ... }).

An interface describing the data returned by callingnamedSheetViewCollection.toJSON().

Represents the collection of sheet views in the worksheet.

An interface for updating data on theNamedSheetViewCollection object, for use innamedSheetViewCollection.set({ ... }).

An interface describing the data returned by callingnamedSheetView.toJSON().

Represents a named sheet view of a worksheet. A sheet view stores the sort and filter rules for a particular worksheet. Every sheet view (even a temporary sheet view) has a unique, worksheet-scoped name that is used to access the view.

An interface for updating data on theNamedSheetView object, for use innamedSheetView.set({ ... }).

An interface describing the data returned by callingnoteCollection.toJSON().

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

An interface for updating data on theNoteCollection object, for use innoteCollection.set({ ... }).

An interface describing the data returned by callingnote.toJSON().

Represents a note in the workbook or worksheet.

An interface for updating data on theNote object, for use innote.set({ ... }).

An interface describing the data returned by callingnumberFormatInfo.toJSON().

Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings.

An interface describing the data returned by callingpageBreakCollection.toJSON().

An interface for updating data on thePageBreakCollection object, for use inpageBreakCollection.set({ ... }).

An interface describing the data returned by callingpageBreak.toJSON().

An interface describing the data returned by callingpageLayout.toJSON().

Represents layout and print settings that are not dependent on any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area.

An interface for updating data on thePageLayout object, for use inpageLayout.set({ ... }).

An interface describing the data returned by callingpivotFieldCollection.toJSON().

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

An interface for updating data on thePivotFieldCollection object, for use inpivotFieldCollection.set({ ... }).

An interface describing the data returned by callingpivotField.toJSON().

Represents the Excel PivotField.

An interface for updating data on thePivotField object, for use inpivotField.set({ ... }).

An interface describing the data returned by callingpivotHierarchyCollection.toJSON().

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

An interface for updating data on thePivotHierarchyCollection object, for use inpivotHierarchyCollection.set({ ... }).

An interface describing the data returned by callingpivotHierarchy.toJSON().

Represents the Excel PivotHierarchy.

An interface for updating data on thePivotHierarchy object, for use inpivotHierarchy.set({ ... }).

An interface describing the data returned by callingpivotItemCollection.toJSON().

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

An interface for updating data on thePivotItemCollection object, for use inpivotItemCollection.set({ ... }).

An interface describing the data returned by callingpivotItem.toJSON().

Represents the Excel PivotItem.

An interface for updating data on thePivotItem object, for use inpivotItem.set({ ... }).

An interface describing the data returned by callingpivotLayout.toJSON().

Represents the visual layout of the PivotTable.

An interface for updating data on thePivotLayout object, for use inpivotLayout.set({ ... }).

An interface describing the data returned by callingpivotTableCollection.toJSON().

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

An interface for updating data on thePivotTableCollection object, for use inpivotTableCollection.set({ ... }).

An interface describing the data returned by callingpivotTable.toJSON().

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

An interface describing the data returned by callingpivotTableScopedCollection.toJSON().

Represents a scoped collection of PivotTables. The PivotTables are sorted based on the location of the PivotTable's top-left corner. They are ordered top-to-bottom and then left-to-right.

An interface for updating data on thePivotTableScopedCollection object, for use inpivotTableScopedCollection.set({ ... }).

An interface describing the data returned by callingpivotTableStyleCollection.toJSON().

Represents a collection of PivotTable styles.

An interface for updating data on thePivotTableStyleCollection object, for use inpivotTableStyleCollection.set({ ... }).

An interface describing the data returned by callingpivotTableStyle.toJSON().

Represents a PivotTable style, which defines style elements by PivotTable region.

An interface for updating data on thePivotTableStyle object, for use inpivotTableStyle.set({ ... }).

An interface for updating data on thePivotTable object, for use inpivotTable.set({ ... }).

An interface describing the data returned by callingpresetCriteriaConditionalFormat.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 thePresetCriteriaConditionalFormat object, for use inpresetCriteriaConditionalFormat.set({ ... }).

An interface describing the data returned by callingqueryCollection.toJSON().

Represents the collection of queries in the workbook.

An interface for updating data on theQueryCollection object, for use inqueryCollection.set({ ... }).

An interface describing the data returned by callingquery.toJSON().

Represents a Power Query query.

An interface for updating data on theQuery object, for use inquery.set({ ... }).

An interface describing the data returned by callingrangeAreasCollection.toJSON().

Contains the collection of cross-workbook level ranges.

An interface for updating data on theRangeAreasCollection object, for use inrangeAreasCollection.set({ ... }).

An interface describing the data returned by callingrangeAreas.toJSON().

RangeAreas represents a collection of one or more rectangular ranges in the same worksheet. To learn how to use discontiguous ranges, readWork with multiple ranges simultaneously in Excel add-ins.

An interface for updating data on theRangeAreas object, for use inrangeAreas.set({ ... }).

An interface describing the data returned by callingrangeBorderCollection.toJSON().

Represents the border objects that make up the range border.

An interface for updating data on theRangeBorderCollection object, for use inrangeBorderCollection.set({ ... }).

An interface describing the data returned by callingrangeBorder.toJSON().

Represents the border of an object.

An interface for updating data on theRangeBorder object, for use inrangeBorder.set({ ... }).

An interface describing the data returned by callingrangeCollection.toJSON().

An interface for updating data on theRangeCollection object, for use inrangeCollection.set({ ... }).

An interface describing the data returned by callingrange.toJSON().

An interface describing the data returned by callingrangeFill.toJSON().

Represents the background of a range object.

An interface for updating data on theRangeFill object, for use inrangeFill.set({ ... }).

An interface describing the data returned by callingrangeFont.toJSON().

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

An interface for updating data on theRangeFont object, for use inrangeFont.set({ ... }).

An interface describing the data returned by callingrangeFormat.toJSON().

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

An interface for updating data on theRangeFormat object, for use inrangeFormat.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 withRanges in the Excel JavaScript API.

An interface for updating data on theRange object, for use inrange.set({ ... }).

An interface describing the data returned by callingrangeViewCollection.toJSON().

Represents a collection ofRangeView objects.

An interface for updating data on theRangeViewCollection object, for use inrangeViewCollection.set({ ... }).

An interface describing the data returned by callingrangeView.toJSON().

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

An interface for updating data on theRangeView object, for use inrangeView.set({ ... }).

An interface describing the data returned by callingremoveDuplicatesResult.toJSON().

Represents the results fromRange.removeDuplicates.

An interface describing the data returned by callingrowColumnPivotHierarchyCollection.toJSON().

Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable.

An interface for updating data on theRowColumnPivotHierarchyCollection object, for use inrowColumnPivotHierarchyCollection.set({ ... }).

An interface describing the data returned by callingrowColumnPivotHierarchy.toJSON().

Represents the Excel RowColumnPivotHierarchy.

An interface for updating data on theRowColumnPivotHierarchy object, for use inrowColumnPivotHierarchy.set({ ... }).

An interface describing the data returned by callingruntime.toJSON().

Represents the Excel Runtime class.

An interface for updating data on theRuntime object, for use inruntime.set({ ... }).

An interface describing the data returned by callingsettingCollection.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 theSettingCollection object, for use insettingCollection.set({ ... }).

An interface describing the data returned by callingsetting.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 theSetting object, for use insetting.set({ ... }).

An interface describing the data returned by callingshapeCollection.toJSON().

Represents a collection of all the shapes in the worksheet.

An interface for updating data on theShapeCollection object, for use inshapeCollection.set({ ... }).

An interface describing the data returned by callingshape.toJSON().

An interface describing the data returned by callingshapeFill.toJSON().

Represents the fill formatting of a shape object.

An interface for updating data on theShapeFill object, for use inshapeFill.set({ ... }).

An interface describing the data returned by callingshapeFont.toJSON().

Represents the font attributes, such as font name, font size, and color, for a shape'sTextRange object.

An interface for updating data on theShapeFont object, for use inshapeFont.set({ ... }).

An interface describing the data returned by callingshapeGroup.toJSON().

Represents a shape group inside a worksheet. To get the correspondingShape object, useShapeGroup.shape.

An interface describing the data returned by callingshapeLineFormat.toJSON().

Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.

An interface for updating data on theShapeLineFormat object, for use inshapeLineFormat.set({ ... }).

Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc. To learn more about the shape object model, readWork with shapes using the Excel JavaScript API.

An interface for updating data on theShape object, for use inshape.set({ ... }).

An interface describing the data returned by callingslicerCollection.toJSON().

Represents a collection of all the slicer objects in the workbook or a worksheet.

An interface for updating data on theSlicerCollection object, for use inslicerCollection.set({ ... }).

An interface describing the data returned by callingslicer.toJSON().

An interface describing the data returned by callingslicerItemCollection.toJSON().

Represents a collection of all the slicer item objects in the slicer.

An interface for updating data on theSlicerItemCollection object, for use inslicerItemCollection.set({ ... }).

An interface describing the data returned by callingslicerItem.toJSON().

Represents a slicer item in a slicer.

An interface for updating data on theSlicerItem object, for use inslicerItem.set({ ... }).

Represents aSlicer object in the workbook.

An interface describing the data returned by callingslicerStyleCollection.toJSON().

Represents a collection ofSlicerStyle objects.

An interface for updating data on theSlicerStyleCollection object, for use inslicerStyleCollection.set({ ... }).

An interface describing the data returned by callingslicerStyle.toJSON().

Represents a slicer style, which defines style elements by region of the slicer.

An interface for updating data on theSlicerStyle object, for use inslicerStyle.set({ ... }).

An interface for updating data on theSlicer object, for use inslicer.set({ ... }).

An interface describing the data returned by callingstyleCollection.toJSON().

Represents a collection of all the styles.

An interface for updating data on theStyleCollection object, for use instyleCollection.set({ ... }).

An interface describing the data returned by callingstyle.toJSON().

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

An interface for updating data on theStyle object, for use instyle.set({ ... }).

An interface describing the data returned by callingtableCollection.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 theTableCollection object, for use intableCollection.set({ ... }).

An interface describing the data returned by callingtableColumnCollection.toJSON().

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

An interface for updating data on theTableColumnCollection object, for use intableColumnCollection.set({ ... }).

An interface describing the data returned by callingtableColumn.toJSON().

Represents a column in a table.

An interface for updating data on theTableColumn object, for use intableColumn.set({ ... }).

An interface describing the data returned by callingtable.toJSON().

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

An interface describing the data returned by callingtableRowCollection.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, aTableRow 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 theTableRowCollection object, for use intableRowCollection.set({ ... }).

An interface describing the data returned by callingtableRow.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, aTableRow 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 theTableRow object, for use intableRow.set({ ... }).

An interface describing the data returned by callingtableScopedCollection.toJSON().

Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location, and the tables are sorted top-to-bottom and then left-to-right.

An interface for updating data on theTableScopedCollection object, for use intableScopedCollection.set({ ... }).

An interface describing the data returned by callingtableSort.toJSON().

Manages sorting operations onTable objects.

An interface describing the data returned by callingtableStyleCollection.toJSON().

Represents a collection of table styles.

An interface for updating data on theTableStyleCollection object, for use intableStyleCollection.set({ ... }).

An interface describing the data returned by callingtableStyle.toJSON().

Represents a table style, which defines the style elements by region of the table.

An interface for updating data on theTableStyle object, for use intableStyle.set({ ... }).

An interface for updating data on theTable object, for use intable.set({ ... }).

An interface describing the data returned by callingtextConditionalFormat.toJSON().

Represents a specific text conditional format.

An interface for updating data on theTextConditionalFormat object, for use intextConditionalFormat.set({ ... }).

An interface describing the data returned by callingtextFrame.toJSON().

Represents the text frame of a shape object.

An interface for updating data on theTextFrame object, for use intextFrame.set({ ... }).

An interface describing the data returned by callingtextRange.toJSON().

Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.

An interface for updating data on theTextRange object, for use intextRange.set({ ... }).

An interface describing the data returned by callingtimelineStyleCollection.toJSON().

Represents a collection of timeline styles.

An interface for updating data on theTimelineStyleCollection object, for use intimelineStyleCollection.set({ ... }).

An interface describing the data returned by callingtimelineStyle.toJSON().

Represents aTimelineStyle, which defines style elements by region in the timeline.

An interface for updating data on theTimelineStyle object, for use intimelineStyle.set({ ... }).

An interface describing the data returned by callingtopBottomConditionalFormat.toJSON().

Represents a top/bottom conditional format.

An interface for updating data on theTopBottomConditionalFormat object, for use intopBottomConditionalFormat.set({ ... }).

An interface describing the data returned by callingworkbookCreated.toJSON().

An interface describing the data returned by callingworkbook.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, readWork with workbooks using the Excel JavaScript API.

An interface describing the data returned by callingworkbookProtection.toJSON().

Represents the protection of a workbook object.

An interface describing the data returned by callingworkbookRangeAreas.toJSON().

Represents a collection of one or more rectangular ranges in multiple worksheets.

An interface for updating data on theWorkbook object, for use inworkbook.set({ ... }).

An interface describing the data returned by callingworksheetCollection.toJSON().

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

An interface for updating data on theWorksheetCollection object, for use inworksheetCollection.set({ ... }).

An interface describing the data returned by callingworksheetCustomPropertyCollection.toJSON().

Contains the collection of worksheet-level custom property.

An interface for updating data on theWorksheetCustomPropertyCollection object, for use inworksheetCustomPropertyCollection.set({ ... }).

An interface describing the data returned by callingworksheetCustomProperty.toJSON().

Represents a worksheet-level custom property.

An interface for updating data on theWorksheetCustomProperty object, for use inworksheetCustomProperty.set({ ... }).

An interface describing the data returned by callingworksheet.toJSON().

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

An interface describing the data returned by callingworksheetProtection.toJSON().

Represents the protection of a worksheet object.

An interface for updating data on theWorksheet object, for use inworksheet.set({ ... }).

Represents a reference to a JavaScript custom function.

The argument that is passed to the event handler after a new linked data type is added to the workbook.

Represents a value whose properties derive from a service.

Provides information about the identity of the linked entity data domain that was just added to the workbook.

Represents options that are used to create theLinkedEntityDataDomain object being added to theLinkedEntityDataDomainCollection.

Provides information about the linked entity data domain whoseLinkedEntityCellValue objects were refreshed.

Provides information about the linked entity data domain whose refresh mode was changed.

The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.

Represents the entity ID and culture for aLinkedEntityCellValue object.

Represents a request to@linkedEntityLoadService custom function to loadLinkedEntityCellValue objects.

Represents the result of a request to@linkedEntityLoadService custom function to loadLinkedEntityCellValue objects.

Represents the List data validation criteria.

Represents the value of a cell containing a locally stored or generated image.

The UID of a previously cached image.

Represents the result of a query that resulted in multiple cell controls. If the result has multiple controls, then they can't be represented as a single result.

Represents the value of a cell containing a #NAME? error.

Represents the value of a cell containing a #N/A! error.

Represents the value of a cell containing a #NULL! error.

Represents the value of a cell containing a #NUM! error.

Represents the options in page layout margins.

Represents page zoom properties.

Configurable template for a date filter to apply to a PivotField. Thecondition defines what criteria need to be set in order for the filter to operate.

An interface representing all PivotFilters currently applied to a given PivotField.

Configurable template for a label filter to apply to a PivotField. Thecondition defines what criteria need to be set in order for the filter to operate.

Configurable template for a manual filter to apply to a PivotField. Thecondition defines what criteria need to be set in order for the filter to operate.

Configurable template for a value filter to apply to a PivotField. Thecondition defines what criteria need to be set in order for the filter to operate.

Represents the value of a cell containing a #BUSY! error. This type of error is used as a placeholder while the value of a cell is downloaded.

Represents the value of a cell containing a #PYTHON! error.

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.

Represents a sequence of one or more characters that share the same font attributes in a cell. Can be used as thetextRuns properties ofgetCellProperties or thetextRuns input parameter ofsetCellProperties.

Represents a reference intoreferencedValues. One scenario for using this reference is to avoid duplicating cell value objects (such as anEntityCellValue). Define a cell value object once inreferencedValues, and then refer to that cell value from many places by using aReferenceCellValue where the duplicated value would have appeared.

Represents the value of a cell containing a #REF! error.

Represents information about a newly added linked data type, such as source and ID.

The argument that is passed to the event handler upon completion of refresh request to an external service or link.

Represents the replace criteria to be used.

Represents a reference to the value which containsreferencedValues.

Represents the returned properties of getRowProperties.

[API set: ExcelApi 1.9 ]

Represents which row properties to load, when used as part of a "range.getRowProperties" method.

[API set: ExcelApi 1.9 ]

Represents the search criteria to be used.

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

Represents the input parameter of setCellProperties.

[API set: ExcelApi 1.9 ]

Represents the input parameter of setColumnProperties.

[API set: ExcelApi 1.9 ]

Represents the input parameter of setRowProperties.

[API set: ExcelApi 1.9 ]

Provides information about the setting that raised the settings changed event

Provides information about the shape that raised the activated event.

Provides information about the shape that raised the deactivated event.

Represents a condition in a sorting operation.

Represents the value of a cell containing a #SPILL! error.

Represents the value of a cell containing a string.

Subtotals for the Pivot Field.

Provides information about the table that raised the added event.

Provides information about the table that raised the changed event.

Provides information about the table that raised the deleted event.

Provides information about the table that raised the filter applied 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 ]

Represents the value of a cell containing a #TIMEOUT! error.

Represents an unknown cell control. This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.

Represents the value of a cell containing a #VALUE! error.

Represents the value of a cell containing a type of value which cannot be serialized. For example, an #UNKNOWN! error which represents a type of rich value not known to this version of Excel.

Represents the value of a cell containing an image downloaded from the internet.

Provides information about the workbook that raised the activated event.

Provides information about the workbook'sonAutoSaveSettingChanged event.

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 column-sorted event and its related worksheet.

Provides information about the worksheet that raised the deactivated event.

Provides information about the worksheet that raised the deleted event.

Provides information about the worksheet that raised the filter applied event.

Provides information about the worksheet format change event.

Provides information about the worksheet and formulas that raised the formula changed event.

Notifies when a worksheet is moved within a workbook.

If a worksheet is moved from one position within the workbook to another via the Excel UI, then this API will trigger an event. Note that if the position of a worksheet changes as a result of moving a different worksheet, then this event won't trigger for both position changes. This event only triggers for the primary worksheet move, and not any worksheet position changes that occur as a result of that primary move.

Provides information about the worksheet whose name has changed.

Provides information about the worksheet that raised the protection status changed event, which fires when the protection status is updated in a worksheet.

Represents the options in sheet protection.

Provides information about the worksheet's row hidden change event.

Provides information about the row-sorted event and its related worksheet.

Represents the worksheet search criteria to be used.

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

Provides information about the left-clicked/tapped event and its related worksheet.

Provides information about the worksheet whose visibility has changed.

Represents the layout of a card in card view.

Represents the layout of a section of a card in card view.

Represents an interactable control inside of a cell.

Represents the value in a cell.

Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type.

Represents the layout used when there is limited space to represent the entity.

Represents the value of a property.

Represents a cell value which contains an error.

Represents a cell value which can be evaluated as a function.

Represents the value in a cell.

Aggregation function for theDataPivotHierarchy.

The behavior types when AutoFill is used on a range in the workbook.

The file type represented by the Base64 encoding.

Represents types of #BLOCKED! errors.

Represents a built-in PivotTable style

Represents a built-in slicer style.

Represents a built-in table style.

Represents types of #BUSY! errors.

Represents types of #CALC! errors.

Represents the state of calculation across the entire Excel application.

Represents the type of cell control.

Represents the types of theCellValue object.

Specifies the type of the category axis.

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

Specifies the bin type of a histogram chart or pareto chart series.

Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart.

Specifies the data source type of the chart series.

Represents which parts of the error bar to include.

Represents the range type for error bars.

Represents the gradient style of a chart series. This is only applicable for region map charts.

Represents the gradient style type of a chart series. This is only applicable for region map charts.

Represents the mapping level of a chart series. This only applies to region map charts.

Represents the region level of a chart series layout. This only applies to region map charts.

Represents the region projection type of a chart series layout. This only applies to region map charts.

Represents the parent label strategy of the chart series layout. This only applies to treemap charts

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 dimensions when getting values from chart series.

Represents the horizontal alignment for the specified object.

Represents the vertical alignment for the specified object.

Represents the position of the chart title.

Specifies the close behavior forWorkbook.close.

Represents how the comments in the event were changed.

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 types of #CONNECT! errors.

Represents a command type ofDataConnection.

Represents the data validation error alert style. The default isStop.

Represents the data validation operator enum.

Represents the data validation type enum.

Enum representing all accepted conditions by which a date filter can be applied. Used to configure the type of PivotFilter that is applied to the field.

Represents the type of change recorded in the task change record.

Types of entity card layouts.

The list of icons available forEntityCompactLayout. An icon displays in the Excel UI, either to the left of the title in a cell that contains an entity card, or to the left of the title of a referenced entity inside an entity card. Selecting the icon opens the entity card.

Represents the types of theErrorCellValue object.

Represents types of #EXTERNAL! errors.

Represents types of #FIELD! errors.

Represents the types of theFunctionCellValue object.

Specifies the shape type for aGeometricShape object.

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

Enum representing all accepted conditions by which a label filter can be applied. Used to configure the type of PivotFilter that is applied to the field.PivotFilter.criteria.exclusive can be set totrue to invert many of these conditions.

Representation of a refresh mode.

Represents the refresh mode setting for theLinkedEntityCellValue objects of aLinkedEntityDataDomain.

An enum that specifies the query load to destination.

Represents types of #NAME? errors.

Represents types of #N/A! errors.

Represents a category of number formats.

Represents types of #NUM! errors.

The format of the image.

Represents the axis from which to get the PivotItems.

Represents the criteria for the top/bottom values filter.

A simple enum that represents a type of filter for a PivotField.

Represents the DateTime Grouping condition.

Specifies the way that an object is attached to its underlying cells.

Specifies what an =PY formula returns, such as an Excel value or a Python object.

An enum that specifies the query load error message.

Represents the types of theReferenceValue object.

Represents types of #REF! errors.

Specifies the save behavior forWorkbook.save.

Specifies the search direction.

Determines the type of automatic sizing allowed.

Specifies a shape's fill type.

The type of underline applied to a font.

The dash style for a line.

The style for a line.

Specifies which part of the shape retains its position when the shape is scaled.

Specifies whether the shape is scaled relative to its original or current size.

Specifies the horizontal alignment for the text frame in a shape.

Specifies the horizontal overflow for the text frame in a shape.

Specifies the orientation for the text frame in a shape.

Specifies the reading order for the text frame in a shape.

Specifies the vertical alignment for the text frame in a shape.

Specifies the vertical overflow for the text frame in a shape.

Specifies the type of a shape.

Specifies where in the z-order a shape should be moved relative to other shapes.

The ShowAs calculation function for the DataPivotField.

Specifies the slicer sort behavior forSlicer.sortBy.

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.

Represents types of #SPILL! errors.

Represents types of #TIMEOUT! errors.

A simple enum for top/bottom filters to select whether to filter by the top N or bottom N percent, number, or sum of values.

Represents types of #VALUE! errors.

Enum representing all accepted conditions by which a value filter can be applied. Used to configure the type of PivotFilter that is applied to the field.PivotFilter.exclusive can be set totrue to invert many of these conditions.

Represents the refresh mode of the workbook links.

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.