excel package
Excel. |
Represents an |
Excel. |
Represents the set of |
Excel. |
Represents the Excel application that manages the workbook. |
Excel. |
Represents the |
Excel. |
Represents an Office.js binding that is defined in the workbook. |
Excel. |
Represents the collection of all the binding objects that are part of the workbook. |
Excel. |
Represents a cell value conditional format. |
Excel. |
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. |
Encapsulates the format properties for the overall chart area. |
Excel. |
Represents the chart axes. |
Excel. |
Represents a single axis in a chart. |
Excel. |
Encapsulates the format properties for the chart axis. |
Excel. |
Represents the title of a chart axis. |
Excel. |
Represents the chart axis title formatting. |
Excel. |
Encapsulates the bin options for histogram charts and pareto charts. |
Excel. |
Represents the border formatting of a chart element. |
Excel. |
Represents the properties of a box and whisker chart. |
Excel. |
A collection of all the chart objects on a worksheet. |
Excel. |
Represents the data label of a chart point. |
Excel. |
Encapsulates the format properties for the chart data labels. |
Excel. |
Represents a collection of all the data labels on a chart point. |
Excel. |
Represents the data table object of a chart. |
Excel. |
Represents the format of a chart data table. |
Excel. |
This object represents the attributes for a chart's error bars. |
Excel. |
Encapsulates the format properties for chart error bars. |
Excel. |
Represents the fill formatting for a chart element. |
Excel. |
This object represents the font attributes (such as font name, font size, and color) for a chart object. |
Excel. |
Represents the substring in chart related objects that contain text, like a |
Excel. |
Represents major or minor gridlines on a chart axis. |
Excel. |
Encapsulates the format properties for chart gridlines. |
Excel. |
Represents the legend in a chart. |
Excel. |
Represents the legend entry in |
Excel. |
Represents a collection of legend entries. |
Excel. |
Encapsulates the format properties of a chart legend. |
Excel. |
Encapsulates the formatting options for line elements. |
Excel. |
Encapsulates the properties for a region map chart. |
Excel. |
Encapsulates the options for the pivot chart. |
Excel. |
This object represents the attributes for a chart plot area. |
Excel. |
Represents the format properties for a chart plot area. |
Excel. |
Represents a point of a series in a chart. |
Excel. |
Represents the formatting object for chart points. |
Excel. |
A collection of all the chart points within a series inside a chart. |
Excel. |
Represents a series in a chart. |
Excel. |
Represents a collection of chart series. |
Excel. |
Encapsulates the format properties for the chart series |
Excel. |
Represents a chart title object of a chart. |
Excel. |
Provides access to the formatting options for a chart title. |
Excel. |
This object represents the attributes for a chart trendline object. |
Excel. |
Represents a collection of chart trendlines. |
Excel. |
Represents the format properties for the chart trendline. |
Excel. |
This object represents the attributes for a chart trendline label object. |
Excel. |
Encapsulates the format properties for the chart trendline label. |
Excel. |
Represents the color scale criteria for conditional formatting. |
Excel. |
Represents a comment in the workbook. |
Excel. |
Represents a collection of comment objects that are part of the workbook. |
Excel. |
Represents a comment reply in the workbook. |
Excel. |
Represents a collection of comment reply objects that are part of the comment. |
Excel. |
Represents a conditional format for the negative side of the data bar. |
Excel. |
Represents a conditional format for the positive side of the data bar. |
Excel. |
An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges. |
Excel. |
Represents a collection of all the conditional formats that are overlap the range. |
Excel. |
Represents a rule, for all traditional rule/format pairings. |
Excel. |
Represents the border of an object. |
Excel. |
Represents the border objects that make up range border. |
Excel. |
Represents the background of a conditional range object. |
Excel. |
This object represents the font attributes (font style, color, etc.) for an object. |
Excel. |
A format object encapsulating the conditional formats range's font, fill, borders, and other properties. |
Excel. |
Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. |
Excel. |
Represents a custom conditional format type. |
Excel. |
Represents a custom property. |
Excel. |
Contains the collection of custom properties. |
Excel. |
Represents a custom XML part object in a workbook. |
Excel. |
A collection of custom XML parts. |
Excel. |
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. |
Excel. |
Represents an Excel conditional data bar type. |
Excel. |
Represents a collection of all the data connections that are part of the workbook. |
Excel. |
Represents the Excel DataPivotHierarchy. |
Excel. |
Represents a collection of DataPivotHierarchy items associated with the PivotTable. |
Excel. |
Represents the data validation applied to the current range. To learn more about the data validation object model, read Add data validation to Excel ranges. |
Excel. |
Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. |
Excel. |
Represents workbook properties. |
Excel. |
Represents a task. |
Excel. |
Represents a recorded change to the task. |
Excel. |
Represents a collection of change records for a task. |
Excel. |
Represents a collection of tasks. |
Excel. |
Manages the filtering of a table's column. |
Excel. |
Represents the Excel FilterPivotHierarchy. |
Excel. |
Represents a collection of FilterPivotHierarchy items associated with the PivotTable. |
Excel. |
Represents the format protection of a range object. |
Excel. |
An object containing the result of a function-evaluation operation |
Excel. |
An object for evaluating Excel functions. |
Excel. |
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. |
Excel. |
Represents the shape collection inside a shape group. |
Excel. |
|
Excel. |
|
Excel. |
Represents an icon set criteria for conditional formatting. |
Excel. |
Represents an image in the worksheet. To get the corresponding |
Excel. |
Represents the iterative calculation settings. |
Excel. |
Represents a line inside a worksheet. To get the corresponding |
Excel. |
Represents a linked data type. A linked data type is a data type connected to an online data source. |
Excel. |
Represents a collection of linked data types. |
Excel. |
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". |
Excel. |
Represents a collection of linked workbook objects. |
Excel. |
Provides information about the local image. |
Excel. |
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. |
Represents an object containing values and types of a named item. |
Excel. |
A collection of all the |
Excel. |
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. |
Excel. |
Represents the collection of sheet views in the worksheet. |
Excel. |
Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. |
Excel. |
|
Excel. |
|
Excel. |
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. |
Excel. |
Represents the Excel PivotField. |
Excel. |
Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy. |
Excel. |
Represents the Excel PivotHierarchy. |
Excel. |
Represents a collection of all the PivotHierarchies that are part of the PivotTable. |
Excel. |
Represents the Excel PivotItem. |
Excel. |
Represents a collection of all the PivotItems related to their parent PivotField. |
Excel. |
Represents the visual layout of the PivotTable. |
Excel. |
Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API. |
Excel. |
Represents a collection of all the PivotTables that are part of the workbook or worksheet. |
Excel. |
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. |
Excel. |
Represents a PivotTable style, which defines style elements by PivotTable region. |
Excel. |
Represents a collection of PivotTable styles. |
Excel. |
Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror. |
Excel. |
Represents a Power Query query. |
Excel. |
Represents the collection of queries in the workbook. |
Excel. |
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. |
|
Excel. |
Contains the collection of cross-workbook level ranges. |
Excel. |
Represents the border of an object. |
Excel. |
Represents the border objects that make up the range border. |
Excel. |
|
Excel. |
Represents the background of a range object. |
Excel. |
This object represents the font attributes (font name, font size, color, etc.) for an object. |
Excel. |
A format object encapsulating the range's font, fill, borders, alignment, and other properties. |
Excel. |
Manages sorting operations on |
Excel. |
RangeView represents a set of visible cells of the parent range. |
Excel. |
Represents a collection of |
Excel. |
Represents the results from |
Excel. |
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. |
Represents the Excel RowColumnPivotHierarchy. |
Excel. |
Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable. |
Excel. |
Represents the Excel Runtime class. |
Excel. |
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. |
Excel. |
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. |
Excel. |
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, read Work with shapes using the Excel JavaScript API. |
Excel. |
Represents a collection of all the shapes in the worksheet. |
Excel. |
Represents the fill formatting of a shape object. |
Excel. |
Represents the font attributes, such as font name, font size, and color, for a shape's |
Excel. |
Represents a shape group inside a worksheet. To get the corresponding |
Excel. |
Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. |
Excel. |
Represents a |
Excel. |
Represents a collection of all the slicer objects in the workbook or a worksheet. |
Excel. |
Represents a slicer item in a slicer. |
Excel. |
Represents a collection of all the slicer item objects in the slicer. |
Excel. |
Represents a slicer style, which defines style elements by region of the slicer. |
Excel. |
Represents a collection of |
Excel. |
An object encapsulating a style's format and other properties. |
Excel. |
Represents a collection of all the styles. |
Excel. |
Represents an Excel table. To learn more about the table object model, read Work with tables using the Excel JavaScript API. |
Excel. |
Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. |
Excel. |
Represents a column in a table. |
Excel. |
Represents a collection of all the columns that are part of the table. |
Excel. |
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 |
Excel. |
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 |
Excel. |
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. |
Excel. |
Manages sorting operations on |
Excel. |
Represents a table style, which defines the style elements by region of the table. |
Excel. |
Represents a collection of table styles. |
Excel. |
Represents a specific text conditional format. |
Excel. |
Represents the text frame of a shape object. |
Excel. |
Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. |
Excel. |
Represents a |
Excel. |
Represents a collection of timeline styles. |
Excel. |
Represents a top/bottom conditional format. |
Excel. |
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. |
The |
Excel. |
Represents the protection of a workbook object. |
Excel. |
Represents a collection of one or more rectangular ranges in multiple worksheets. |
Excel. |
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. |
Represents a collection of worksheet objects that are part of the workbook. |
Excel. |
Represents a worksheet-level custom property. |
Excel. |
Contains the collection of worksheet-level custom property. |
Excel. |
|
Excel. |
Represents the protection of a worksheet object. |
Excel. |
The interface used to construct optional fields of the |
Excel. |
Represents a 2D array of cell values. |
Excel. |
The Base64-encoded type and data of an image. |
Excel. |
Represents the basic type data validation criteria. |
Excel. |
Provides information about the binding that raised the data changed event. |
Excel. |
Provides information about the selection that raised the selection changed event. Note*: If multiple, discontiguous cells are selected, |
Excel. |
Represents the value of a cell containing a #BLOCKED! error. |
Excel. |
Represents the value of a cell containing a boolean. |
Excel. |
Represents the value of a cell containing a #BUSY! error. |
Excel. |
Represents the value of a cell containing a #CALC! error. |
Excel. |
Represents a section of a card that is arranged as a list in card view. |
Excel. |
Represents a reference to a property used by the card layout. |
Excel. |
Properties of a card layout relevant to most card layouts. |
Excel. |
Properties of a card layout relevant to most card layouts. |
Excel. |
Represents a section of a card that is arranged as a table in card view. |
Excel. |
Represents the properties of a single border returned by |
Excel. |
Represents the |
Excel. |
Represents the returned properties of getCellProperties. |
Excel. |
Specifies which properties to load on the |
Excel. |
Represents the |
Excel. |
Specifies which properties to load on the |
Excel. |
Represents the |
Excel. |
Specifies which properties to load on the |
Excel. |
Represents the returned format properties of getCellProperties or format input parameter of setCellProperties. |
Excel. |
Represents which properties to load on the format object. |
Excel. |
Represents which cell properties to load, when used as part of a "range.getCellProperties" method. |
Excel. |
Represents the |
Excel. |
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. |
Excel. |
These extra properties may appear on a |
Excel. |
Metadata about a property in |
Excel. |
Represents the exclusion of a property in |
Excel. |
The provider attributes object represents the set of details used in card view to provide specified branding information for a |
Excel. |
Provides information about the details of a |
Excel. |
Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet. |
Excel. |
Provides information about the chart that raised the activated event. |
Excel. |
Provides information about the chart that raised the added event. |
Excel. |
Provides information about the chart that raised the deactivated event. |
Excel. |
Provides information about the chart that raised the deleted event. |
Excel. |
Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell. [ API set: ExcelApi BETA (PREVIEW ONLY) ] |
Excel. |
Represents the returned properties of getColumnProperties. |
Excel. |
Represents which column properties to load, when used as part of a "range.getColumnProperties" method. |
Excel. |
Provides information about the comments that raised the comment added event. |
Excel. |
Occurs when existing comments are changed. |
Excel. |
Provides information about the comments that raised the comment deleted event. |
Excel. |
A structure for the comment ID and IDs of its related replies. |
Excel. |
Represents the entity that is mentioned in comments. |
Excel. |
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. |
Excel. |
Represents a cell value conditional format rule. |
Excel. |
Represents the criteria of the color scale. |
Excel. |
Represents a color scale criterion which contains a type, value, and a color. |
Excel. |
Represents a rule-type for a data bar. |
Excel. |
Represents an icon criterion which contains a type, value, an operator, and an optional custom icon, if not using an icon set. |
Excel. |
Represents the preset criteria conditional format rule. |
Excel. |
Represents a cell value conditional format rule. |
Excel. |
Represents the rule of the top/bottom conditional format. |
Excel. |
Represents the value of a cell containing a #CONNECT! error. |
Excel. |
Represents the custom data validation criteria. |
Excel. |
Represents the error alert properties for the data validation. |
Excel. |
Represents the user prompt properties for the data validation. |
Excel. |
A data validation rule contains different types of data validation. You can only use one of them at a time according the |
Excel. |
Represents the date data validation criteria. |
Excel. |
Represents the value of a cell containing a #DIV/0! error. |
Excel. |
Represents information about a task's schedule. |
Excel. |
Represents the value of a cell containing a double. |
Excel. |
Represents information about a user's identity. |
Excel. |
Represents an empty cell control. This represents the state where a cell does not have a control. [ API set: ExcelApi BETA (PREVIEW ONLY) ] |
Excel. |
Represents the value of a cell that's empty and has no formulas or data. |
Excel. |
Represents a card layout that is best used for an array. |
Excel. |
Represents a card layout that is best used for an entity. |
Excel. |
Represents a set of properties without a schema or defined structure. |
Excel. |
The compact layout properties for an entity. |
Excel. |
Properties used by |
Excel. |
Represents layout information for various views of the entity. |
Excel. |
Represents the value of a cell containing an External Code Service Object, such as Python code formula. |
Excel. |
Represents the value of a cell containing an #EXTERNAL! error. |
Excel. |
Represents the value of a cell containing a #FIELD! error. |
Excel. |
Represents the filtering criteria applied to a column. |
Excel. |
Represents how to filter a date when filtering on values. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see Review 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. |
Excel. |
Provides information about a changed formula during a formula changed event. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents the value of a cell containing a #GETTING_DATA error. |
Excel. |
Represents a cell icon. |
Excel. |
|
Excel. |
Represents information about a user's identity. |
Excel. |
The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the set of |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel application that manages the workbook. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the collection of all the binding objects that are part of the workbook. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an Office.js binding that is defined in the workbook. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a cell value conditional format. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties for the overall chart area. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the chart axes. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties for the chart axis. |
Excel. |
An interface for updating data on the |
Excel. |
Represents a single axis in a chart. |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the chart axis title formatting. |
Excel. |
An interface for updating data on the |
Excel. |
Represents the title of a chart axis. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the bin options for histogram charts and pareto charts. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the border formatting of a chart element. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the properties of a box and whisker chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
A collection of all the chart objects on a worksheet. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties for the chart data labels. |
Excel. |
An interface for updating data on the |
Excel. |
Represents the data label of a chart point. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the data labels on a chart point. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the format of a chart data table. |
Excel. |
An interface for updating data on the |
Excel. |
Represents the data table object of a chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties for chart error bars. |
Excel. |
An interface for updating data on the |
Excel. |
This object represents the attributes for a chart's error bars. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
This object represents the font attributes (such as font name, font size, and color) for a chart object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the substring in chart related objects that contain text, like a |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties for chart gridlines. |
Excel. |
An interface for updating data on the |
Excel. |
Represents major or minor gridlines on a chart axis. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of legend entries. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the legend entry in |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties of a chart legend. |
Excel. |
An interface for updating data on the |
Excel. |
Represents the legend in a chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the formatting options for line elements. |
Excel. |
An interface for updating data on the |
Excel. |
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. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the properties for a region map chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the options for the pivot chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the format properties for a chart plot area. |
Excel. |
An interface for updating data on the |
Excel. |
This object represents the attributes for a chart plot area. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the formatting object for chart points. |
Excel. |
An interface for updating data on the |
Excel. |
Represents a point of a series in a chart. |
Excel. |
An interface describing the data returned by calling |
Excel. |
A collection of all the chart points within a series inside a chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of chart series. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties for the chart series |
Excel. |
An interface for updating data on the |
Excel. |
Represents a series in a chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Provides access to the formatting options for a chart title. |
Excel. |
An interface for updating data on the |
Excel. |
Represents a chart title object of a chart. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of chart trendlines. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the format properties for the chart trendline. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Encapsulates the format properties for the chart trendline label. |
Excel. |
An interface for updating data on the |
Excel. |
This object represents the attributes for a chart trendline label object. |
Excel. |
An interface for updating data on the |
Excel. |
This object represents the attributes for a chart trendline object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
Provides ways to load properties of only a subset of members of a collection. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the color scale criteria for conditional formatting. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of comment objects that are part of the workbook. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a comment in the workbook. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of comment reply objects that are part of the comment. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a comment reply in the workbook. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a conditional format for the negative side of the data bar. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a conditional format for the positive side of the data bar. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the conditional formats that are overlap the range. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a rule, for all traditional rule/format pairings. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the border objects that make up range border. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the border of an object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the background of a conditional range object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
This object represents the font attributes (font style, color, etc.) for an object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
A format object encapsulating the conditional formats range's font, fill, borders, and other properties. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a custom conditional format type. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Contains the collection of custom properties. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a custom property. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
A collection of custom XML parts. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a custom XML part object in a workbook. |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an Excel conditional data bar type. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of DataPivotHierarchy items associated with the PivotTable. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel DataPivotHierarchy. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the data validation applied to the current range. To learn more about the data validation object model, read Add data validation to Excel ranges. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents workbook properties. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of change records for a task. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a recorded change to the task. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of tasks. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a task. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Manages the filtering of a table's column. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of FilterPivotHierarchy items associated with the PivotTable. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel FilterPivotHierarchy. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the format protection of a range object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An object containing the result of a function-evaluation operation |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the shape collection inside a shape group. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
|
Excel. |
An interface for updating data on the |
Excel. |
|
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an icon set criteria for conditional formatting. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an image in the worksheet. To get the corresponding |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the iterative calculation settings. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a line inside a worksheet. To get the corresponding |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of linked data types. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a linked data type. A linked data type is a data type connected to an online data source. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of linked workbook objects. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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". |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an object containing values and types of a named item. |
Excel. |
An interface describing the data returned by calling |
Excel. |
A collection of all the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the collection of sheet views in the worksheet. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. |
Excel. |
An interface describing the data returned by calling |
Excel. |
|
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
|
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the PivotFields that are part of a PivotTable's hierarchy. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel PivotField. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the PivotHierarchies that are part of the PivotTable. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel PivotHierarchy. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the PivotItems related to their parent PivotField. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel PivotItem. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the visual layout of the PivotTable. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the PivotTables that are part of the workbook or worksheet. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an Excel PivotTable. To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API. |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of PivotTable styles. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a PivotTable style, which defines style elements by PivotTable region. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the collection of queries in the workbook. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a Power Query query. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Contains the collection of cross-workbook level ranges. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
|
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the border objects that make up the range border. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the border of an object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
|
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the background of a range object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
This object represents the font attributes (font name, font size, color, etc.) for an object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
A format object encapsulating the range's font, fill, borders, alignment, and other properties. |
Excel. |
An interface for updating data on the |
Excel. |
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. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
RangeView represents a set of visible cells of the parent range. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the results from |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of RowColumnPivotHierarchy items associated with the PivotTable. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel RowColumnPivotHierarchy. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the Excel Runtime class. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the shapes in the worksheet. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the fill formatting of a shape object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the font attributes, such as font name, font size, and color, for a shape's |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a shape group inside a worksheet. To get the corresponding |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape. |
Excel. |
An interface for updating data on the |
Excel. |
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, read Work with shapes using the Excel JavaScript API. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the slicer objects in the workbook or a worksheet. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the slicer item objects in the slicer. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a slicer item in a slicer. |
Excel. |
An interface for updating data on the |
Excel. |
Represents a |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a slicer style, which defines style elements by region of the slicer. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the styles. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An object encapsulating a style's format and other properties. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of all the columns that are part of the table. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a column in a table. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents an Excel table. To learn more about the table object model, read Work with tables using the Excel JavaScript API. |
Excel. |
An interface describing the data returned by calling |
Excel. |
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 |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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 |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Manages sorting operations on |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of table styles. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a table style, which defines the style elements by region of the table. |
Excel. |
An interface for updating data on the |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a specific text conditional format. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents the text frame of a shape object. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of timeline styles. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a top/bottom conditional format. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
An interface describing the data returned by calling |
Excel. |
Represents the protection of a workbook object. |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of one or more rectangular ranges in multiple worksheets. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a collection of worksheet objects that are part of the workbook. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Contains the collection of worksheet-level custom property. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
Represents a worksheet-level custom property. |
Excel. |
An interface for updating data on the |
Excel. |
An interface describing the data returned by calling |
Excel. |
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. |
An interface describing the data returned by calling |
Excel. |
Represents the protection of a worksheet object. |
Excel. |
An interface for updating data on the |
Excel. |
The argument that is passed to the event handler after a new linked data type is added to the workbook. |
Excel. |
Represents a value whose properties derive from a service. |
Excel. |
The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value. |
Excel. |
Represents the List data validation criteria. |
Excel. |
Represents the value of a cell containing a locally stored or generated image. |
Excel. |
The UID of a previously cached image. |
Excel. |
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. [ API set: ExcelApi BETA (PREVIEW ONLY) ] |
Excel. |
Represents the value of a cell containing a #NAME? error. |
Excel. |
Represents the value of a cell containing a #N/A! error. |
Excel. |
Represents the value of a cell containing a #NULL! error. |
Excel. |
Represents the value of a cell containing a #NUM! error. |
Excel. |
Represents the options in page layout margins. |
Excel. |
Represents page zoom properties. |
Excel. |
Configurable template for a date filter to apply to a PivotField. The |
Excel. |
An interface representing all PivotFilters currently applied to a given PivotField. |
Excel. |
Configurable template for a label filter to apply to a PivotField. The |
Excel. |
Configurable template for a manual filter to apply to a PivotField. The |
Excel. |
Configurable template for a value filter to apply to a PivotField. The |
Excel. |
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. |
Excel. |
Represents the value of a cell containing a #PYTHON! error. |
Excel. |
Represents the necessary strings to get/set a hyperlink (XHL) object. |
Excel. |
Represents a string reference of the form "SheetName!A1:B5", or a global or local named range. |
Excel. |
|
Excel. |
Represents a reference into |
Excel. |
Represents the value of a cell containing a #REF! error. |
Excel. |
Represents information about a newly added linked data type, such as source and ID. |
Excel. |
The argument that is passed to the event handler upon completion of refresh request to an external service or link. |
Excel. |
Represents the replace criteria to be used. |
Excel. |
Represents a reference to the value which contains |
Excel. |
Represents the returned properties of getRowProperties. |
Excel. |
Represents which row properties to load, when used as part of a "range.getRowProperties" method. |
Excel. |
|
Excel. |
Represents the search criteria to be used. |
Excel. |
Provides information about the document that raised the selection changed event. |
Excel. |
|
Excel. |
Represents the input parameter of setCellProperties. |
Excel. |
Represents the input parameter of setColumnProperties. |
Excel. |
Represents the input parameter of setRowProperties. |
Excel. |
Provides information about the setting that raised the settings changed event |
Excel. |
Provides information about the shape that raised the activated event. |
Excel. |
Provides information about the shape that raised the deactivated event. |
Excel. |
|
Excel. |
Represents a condition in a sorting operation. |
Excel. |
Represents the value of a cell containing a #SPILL! error. |
Excel. |
Represents the value of a cell containing a string. |
Excel. |
Subtotals for the Pivot Field. |
Excel. |
Provides information about the table that raised the added event. |
Excel. |
Provides information about the table that raised the changed event. |
Excel. |
Provides information about the table that raised the deleted event. |
Excel. |
Provides information about the table that raised the filter applied event. |
Excel. |
Provides information about the table that raised the selection changed event. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents the value of a cell containing a #TIMEOUT! error. |
Excel. |
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. [ API set: ExcelApi BETA (PREVIEW ONLY) ] |
Excel. |
Represents the value of a cell containing a #VALUE! error. |
Excel. |
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. |
Excel. |
Represents the value of a cell containing an image downloaded from the internet. |
Excel. |
Provides information about the workbook that raised the activated event. |
Excel. |
Provides information about the workbook's |
Excel. |
Provides information about the worksheet that raised the activated event. |
Excel. |
Provides information about the worksheet that raised the added event. |
Excel. |
Provides information about the worksheet that raised the calculated event. |
Excel. |
Provides information about the worksheet that raised the changed event. |
Excel. |
Provides information about the column-sorted event and its related worksheet. |
Excel. |
Provides information about the worksheet that raised the deactivated event. |
Excel. |
Provides information about the worksheet that raised the deleted event. |
Excel. |
Provides information about the worksheet that raised the filter applied event. |
Excel. |
Provides information about the worksheet format change event. |
Excel. |
Provides information about the worksheet and formulas that raised the formula changed event. |
Excel. |
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. |
Excel. |
Provides information about the worksheet whose name has changed. |
Excel. |
Provides information about the worksheet that raised the protection status changed event, which fires when the protection status is updated in a worksheet. |
Excel. |
Represents the options in sheet protection. |
Excel. |
Provides information about the worksheet's row hidden change event. |
Excel. |
Provides information about the row-sorted event and its related worksheet. |
Excel. |
Represents the worksheet search criteria to be used. |
Excel. |
Provides information about the worksheet that raised the selection changed event. |
Excel. |
Provides information about the left-clicked/tapped event and its related worksheet. |
Excel. |
Provides information about the worksheet whose visibility has changed. |
Excel. |
Represents the layout of a card in card view. |
Excel. |
Represents the layout of a section of a card in card view. |
Excel. |
Represents an interactable control inside of a cell. [ API set: ExcelApi BETA (PREVIEW ONLY) ] |
Excel. |
Represents the value in a cell. |
Excel. |
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. |
Excel. |
Represents the layout used when there is limited space to represent the entity. |
Excel. |
Represents the value of a property. |
Excel. |
Represents a cell value which contains an error. |
Excel. |
Represents the value in a cell. |
Excel. |
Aggregation function for the |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
The behavior types when AutoFill is used on a range in the workbook. |
Excel. |
The file type represented by the Base64 encoding. |
Excel. |
|
Excel. |
Represents types of #BLOCKED! errors. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents a built-in PivotTable style |
Excel. |
Represents a built-in slicer style. |
Excel. |
|
Excel. |
Represents a built-in table style. |
Excel. |
Represents types of #BUSY! errors. |
Excel. |
Represents types of #CALC! errors. |
Excel. |
|
Excel. |
Represents the state of calculation across the entire Excel application. |
Excel. |
|
Excel. |
Represents the type of cell control. |
Excel. |
Represents the types of the |
Excel. |
Specifies the type of the category axis. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Specifies the unit of time for chart axes and data series. |
Excel. |
|
Excel. |
Specifies the bin type of a histogram chart or pareto chart series. |
Excel. |
Represents the quartile calculation type of chart series layout. Only applies to a box and whisker chart. |
Excel. |
|
Excel. |
|
Excel. |
Specifies the data source type of the chart series. |
Excel. |
|
Excel. |
Represents which parts of the error bar to include. |
Excel. |
Represents the range type for error bars. |
Excel. |
Represents the gradient style of a chart series. This is only applicable for region map charts. |
Excel. |
Represents the gradient style type of a chart series. This is only applicable for region map charts. |
Excel. |
|
Excel. |
|
Excel. |
Represents the mapping level of a chart series. This only applies to region map charts. |
Excel. |
Represents the region level of a chart series layout. This only applies to region map charts. |
Excel. |
Represents the region projection type of a chart series layout. This only applies to region map charts. |
Excel. |
|
Excel. |
Represents the parent label strategy of the chart series layout. This only applies to treemap charts |
Excel. |
|
Excel. |
|
Excel. |
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. |
Represents the dimensions when getting values from chart series. |
Excel. |
|
Excel. |
Represents the horizontal alignment for the specified object. |
Excel. |
Represents the vertical alignment for the specified object. |
Excel. |
|
Excel. |
Represents the position of the chart title. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Specifies the close behavior for |
Excel. |
Represents how the comments in the event were changed. |
Excel. |
Represents the operator of the text conditional format type. |
Excel. |
Represents the format options for a data bar axis. |
Excel. |
Represents the data bar direction within a cell. |
Excel. |
Represents the types of color criterion for conditional formatting. |
Excel. |
Represents the direction for a selection. |
Excel. |
Represents the types of icon conditional format. |
Excel. |
Represents the criteria of the preset criteria conditional format type. |
Excel. |
Represents the types of conditional format values. |
Excel. |
|
Excel. |
Represents the operator for each icon criteria. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents the operator of the text conditional format type. |
Excel. |
Represents the criteria for the above/below average conditional format type. |
Excel. |
Represents types of #CONNECT! errors. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents a command type of |
Excel. |
Represents the data validation error alert style. The default is |
Excel. |
Represents the data validation operator enum. |
Excel. |
Represents the data validation type enum. |
Excel. |
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. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents the type of change recorded in the task change record. |
Excel. |
|
Excel. |
Types of entity card layouts. |
Excel. |
The list of icons available for |
Excel. |
Represents the types of the |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents types of #EXTERNAL! errors. |
Excel. |
Represents types of #FIELD! errors. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Specifies the shape type for a |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Determines the direction in which existing cells will be shifted to accommodate what is being inserted. |
Excel. |
|
Excel. |
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. |
Excel. |
Representation of a refresh mode. |
Excel. |
|
Excel. |
An enum that specifies the query load to destination. |
Excel. |
|
Excel. |
|
Excel. |
Represents types of #NAME? errors. |
Excel. |
Represents types of #N/A! errors. |
Excel. |
Represents a category of number formats. |
Excel. |
Represents types of #NUM! errors. |
Excel. |
|
Excel. |
|
Excel. |
The format of the image. |
Excel. |
Represents the axis from which to get the PivotItems. |
Excel. |
Represents the criteria for the top/bottom values filter. |
Excel. |
A simple enum that represents a type of filter for a PivotField. |
Excel. |
|
Excel. |
Represents the DateTime Grouping condition. |
Excel. |
Specifies the way that an object is attached to its underlying cells. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
An enum that specifies the query load error message. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents the types of the |
Excel. |
Represents types of #REF! errors. |
Excel. |
|
Excel. |
|
Excel. |
Specifies the save behavior for |
Excel. |
Specifies the search direction. |
Excel. |
Determines the type of automatic sizing allowed. |
Excel. |
Specifies a shape's fill type. |
Excel. |
The type of underline applied to a font. |
Excel. |
The dash style for a line. |
Excel. |
The style for a line. |
Excel. |
Specifies which part of the shape retains its position when the shape is scaled. |
Excel. |
Specifies whether the shape is scaled relative to its original or current size. |
Excel. |
Specifies the horizontal alignment for the text frame in a shape. |
Excel. |
Specifies the horizontal overflow for the text frame in a shape. |
Excel. |
Specifies the orientation for the text frame in a shape. |
Excel. |
Specifies the reading order for the text frame in a shape. |
Excel. |
Specifies the vertical alignment for the text frame in a shape. |
Excel. |
Specifies the vertical overflow for the text frame in a shape. |
Excel. |
Specifies the type of a shape. |
Excel. |
Specifies where in the z-order a shape should be moved relative to other shapes. |
Excel. |
|
Excel. |
The ShowAs calculation function for the DataPivotField. |
Excel. |
Specifies the slicer sort behavior for |
Excel. |
Represents the sort direction. |
Excel. |
|
Excel. |
Represents the ordering method to be used when sorting Chinese characters. |
Excel. |
Represents the part of the cell used as the sorting criteria. |
Excel. |
|
Excel. |
|
Excel. |
|
Excel. |
Represents types of #SPILL! errors. |
Excel. |
|
Excel. |
Represents types of #TIMEOUT! errors. |
Excel. |
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. |
Excel. |
Represents types of #VALUE! errors. |
Excel. |
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. |
Excel. |
|
Excel. |
Represents the refresh mode of the workbook links. |
Excel. |
The position of a worksheet relative to another worksheet or the entire worksheet collection. |
Excel. |
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. |
Excel. |
|
Excel. |
|
Excel. |
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. |
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. |
Executes a batch script that performs actions on the Excel object model, using the RequestContext of previously-created API objects. |
Excel. |
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. |
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. |
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.
export function createWorkbook(base64?: string): Promise<void>;
Parameters
- base64
-
string
Returns
Promise<void>
Examples
const myFile = <HTMLInputElement>document.getElementById("file");
const reader = new FileReader();
reader.onload = (event) => {
Excel.run((context) => {
// Remove the metadata before the base64-encoded string.
const startIndex = reader.result.toString().indexOf("base64,");
const mybase64 = reader.result.toString().substr(startIndex + 7);
Excel.createWorkbook(mybase64);
return context.sync();
});
};
// Read in the file as a data URL so we can parse the base64-encoded string.
reader.readAsDataURL(myFile.files[0]);
export function getDataCommonPostprocess(response: any, callArgs: any): any;
Parameters
- response
-
any
- callArgs
-
any
Returns
any
export function postprocessBindingDescriptor(response: any): any;
Parameters
- response
-
any
Returns
any
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>
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>
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
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>
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>
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
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>
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: