Excel JavaScript API requirement sets

Requirement sets are named groups of API members. Office Add-ins use requirement sets specified in the manifest or use a runtime check to determine whether an Office host supports APIs that an add-in needs. For more information, see Specify Office hosts and API requirements.

Excel add-ins run across multiple versions of Office, including Office 2016 for Windows, Office for iPad, Office for Mac, and Office Online. The following table lists the Excel requirement sets, the Office host applications that support each requirement set, and the build versions or number for those applications.

Note Any API that is listed as beta is not ready for end-user production. We make them available for developers to try them out in test and development environments. They are not meant to be used against production/business critical documents. For the requirement sets that are marked as Beta, use the specified (or later) version of the Office software and use the Beta library of the CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js. Entires not listed as Beta are generally available and you can continue to use Production CDN library: https://appsforoffice.microsoft.com/lib/1/hosted/office.js.

Requirement set Office 365 for Windows* Office 365 for iPad Office 365 for Mac Office Online Office Online Server
Beta Please visit our beta program page!        
ExcelApi1.7 Version 1801 (Build 9001.2171) or later 2.9 or later 16.9 or later April 2018 Coming soon
ExcelApi1.6 Version 1704 (Build 8201.2001) or later 2.2 or later 15.36 or later April 2017 Coming soon
ExcelApi1.5 Version 1703 (Build 8067.2070) or later 2.2 or later 15.36 or later March 2017 Coming soon
ExcelApi1.4 Version 1701 (Build 7870.2024) or later 2.2 or later 15.36 or later January 2017 Coming soon
ExcelApi1.3 Version 1608 (Build 7369.2055) or later 1.27 or later 15.27 or later September 2016 Version 1608 (Build 7601.6800) or later
ExcelApi1.2 Version 1601 (Build 6741.2088) or later 1.21 or later 15.22 or later January 2016
ExcelApi1.1 Version 1509 (Build 4266.1001) or later 1.19 or later 15.20 or later January 2016

Note The build number for Office 2016 installed via MSI is 16.0.4266.1001. This version only contains the ExcelApi 1.1 requirement set.

For more information about versions, build numbers, and Office Online Server, see:

What's new in Excel JavaScript API 1.7

The Excel JavaScript API requirement set 1.7 features include APIs for charts, events, data validation, worksheets, ranges, document properties, named items, protection options and styles.

Customize charts

With the new chart APIs, you can create additional chart types, add a data series to a chart, set the chart title, add an axis title, add display unit, add a trendline with moving average, change a trendline to linear, and more. The following are some examples:

  • Chart axis - get, set, format and remove axis unit, label and title in a chart.
  • Chart series - add, set, and delete a series in a chart. Change series markers, plot orders and sizing.
  • Chart trendlines - add, get, and format trendlines in a chart.
  • Chart legend - format the legend font in a chart.
  • Chart point - set chart point color.
  • Chart title substring - get and set title substring for a chart.
  • Chart type - option to create more chart types.

Events

Excel events APIs provide a variety of event handlers that allow your add-in to automatically run a designated function when a specific event occurs. You can design that function to perform whatever actions your scenario requires. For a list of events that are currently available, see Work with Events using the Excel JavaScript API.

Customize the appearance of worksheets and ranges

Using the new APIs, you can customize the appearance of worksheets in multiple ways:

  • Freeze panes to keep specific rows or columns visible when you scroll in the worksheet. For example, if the first row in your worksheet contains headers, you might freeze that row so that the column headers will remain visible as you scroll down the worksheet.
  • Set the visibility of gridlines in a worksheet.
  • Modify the worksheet tab color.
  • Add worksheet headings.

You can customize the appearance of ranges in multiple ways:

  • Set the cell style for a range to ensure sure that all cells in the range have consistent formatting. A cell style is a defined set of formatting characteristics, such as fonts and font sizes, number formats, cell borders, and cell shading. Use any of Excel's built-in cell styles or create your own custom cell style.
  • Set the text orientation for a range.
  • Add or modify a hyperlink on a range that links to another location in the workbook or to an external location.

Manage document properties

Using the document properties APIs, you can access built-in document properties and also create and manage custom document properties to store state of the workbook and drive workflow and business logic.

Copy worksheets

Using the worksheet copy APIs, you can copy the data and format from one worksheet to a new worksheet within the same workbook and reduce the amount of data transfer needed.

Handle ranges with ease

Using the various range APIs, you can do things such as get the surrounding region, get a resized range, and more. These APIs should make tasks like range manipulation and addressing much more efficient.

In addition:

  • Workbook and worksheet protection options - use these APIs to protect data in a worksheet and the workbook structure.
  • Update a named item - use this API to update a named item.
  • Get active cell - use this API to get the active cell of a workbook.
Object What is new Description Requirement set
chart Property > chartType Represents the type of the chart. Possible values are: ColumnClustered, ColumnStacked, ColumnStacked100, BarClustered, BarStacked, BarStacked100, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, PieOfPie, etc.. 1.7
chart Property > id The unique id of chart. Read-only. 1.7
chart Property > showAllFieldButtons Represents whether to display all field buttons on a PivotChart. 1.7
chartAreaFormat Relationship > border Represents the border format of chart area, which includes color, linestyle and weight. Read-only. 1.7
chartAxes Method > getItem(type: string, group: string) Returns the specific axis identified by type and group. 1.7
chartAxis Property > axisBetweenCategories Represents whether value axis crosses the category axis between categories. 1.7
chartAxis Property > axisGroup Represents the group for the specified axis. Read-only. Possible values are: Primary, Secondary. 1.7
chartAxis Property > categoryType Returns or sets the category axis type. Possible values are: Automatic, TextAxis, DateAxis. 1.7
chartAxis Property > crosses Represents the specified axis where the other axis crosses. Possible values are: Automatic, Maximum, Minimum, Custom. 1.7
chartAxis Property > crossesAt Represents the specified axis where the other axis crosses at. Read Only. Set to this property should use SetCrossesAt(double) method. Read-only. 1.7
chartAxis Property > customDisplayUnit Represents the custom axis display unit value. Read Only. To set this property, please use the SetCustomDisplayUnit(double) method. Read-only. 1.7
chartAxis Property > displayUnit Represents the axis display unit. Possible values are: None, Hundreds, Thousands, TenThousands, HundredThousands, Millions, TenMillions, HundredMillions, Billions, Trillions, Custom. 1.7
chartAxis Property > height Represents the height, in points, of the chart axis. Null if the axis's not visible. Read-only. 1.7
chartAxis Property > left Represents the distance, in points, from the left edge of the axis to the left of chart area. Null if the axis's not visible. Read-only. 1.7
chartAxis Property > logBase Represents the base of the logarithm when using logarithmic scales. 1.7
chartAxis Property > reversePlotOrder Represents whether Microsoft Excel plots data points from last to first. 1.7
chartAxis Property > scaleType Represents the value axis scale type. Possible values are: Linear, Logarithmic. 1.7
chartAxis Property > showDisplayUnitLabel Represents whether the axis display unit label is visible. 1.7
chartAxis Property > tickLabelSpacing Represents the number of categories or series between tick-mark labels. Can be a value from 1 through 31999 or an empty string for automatic setting. The returned value is always a number. 1.7
chartAxis Property > tickMarkSpacing Represents the number of categories or series between tick marks. 1.7
chartAxis Property > top Represents the distance, in points, from the top edge of the axis to the top of chart area. Null if the axis's not visible. Read-only. 1.7
chartAxis Property > type Represents the axis type. Read-only. Possible values are: Invalid, Category, Value, Series. 1.7
chartAxis Property > visible A boolean value represents the visibility of the axis. 1.7
chartAxis Property > width Represents the width, in points, of the chart axis. Null if the axis's not visible. Read-only. 1.7
chartAxis Relationship > baseTimeUnit Returns or sets the base unit for the specified category axis. 1.7
chartAxis Relationship > majorTickMark Represents the type of major tick mark for the specified axis. 1.7
chartAxis Relationship > majorTimeUnitScale Returns or sets the major unit scale value for the category axis when the CategoryType property is set to TimeScale. 1.7
chartAxis Relationship > minorTickMark Represents the type of minor tick mark for the specified axis. 1.7
chartAxis Relationship > minorTimeUnitScale Returns or sets the minor unit scale value for the category axis when the CategoryType property is set to TimeScale. 1.7
chartAxis Relationship > tickLabelPosition Represents the position of tick-mark labels on the specified axis. 1.7
chartAxis Method > setCategoryNames(sourceData: Range) Sets all the category names for the specified axis. 1.7
chartAxis Method > setCrossesAt(value: double) Set the specified axis where the other axis crosses at. 1.7
chartAxis Method > setCustomDisplayUnit(value: double) Sets the axis display unit to a custom value. 1.7
chartBorder Property > color HTML color code representing the color of borders in the chart. 1.7
chartBorder Property > weight Represents weight of the border, in points. 1.7
chartBorder Relationship > lineStyle Represents the line style of the border. 1.7
chartDataLabel Property > position DataLabelPosition value that represents the position of the data label. Possible values are: None, Center, InsideEnd, InsideBase, OutsideEnd, Left, Right, Top, Bottom, BestFit, Callout. 1.7
chartDataLabel Property > separator String representing the separator used for the data label on a chart. 1.7
chartDataLabel Property > showBubbleSize Boolean value representing if the data label bubble size is visible or not. 1.7
chartDataLabel Property > showCategoryName Boolean value representing if the data label category name is visible or not. 1.7
chartDataLabel Property > showLegendKey Boolean value representing if the data label legend key is visible or not. 1.7
chartDataLabel Property > showPercentage Boolean value representing if the data label percentage is visible or not. 1.7
chartDataLabel Property > showSeriesName Boolean value representing if the data label series name is visible or not. 1.7
chartDataLabel Property > showValue Boolean value representing if the data label value is visible or not. 1.7
chartLegend Property > height Represents the height of the legend on the chart. 1.7
chartLegend Property > left Represents the left of a chart legend. 1.7
chartLegend Property > showShadow Represents if the legend has shadow on the chart. 1.7
chartLegend Property > top Represents the top of a chart legend. 1.7
chartLegend Property > width Represents the width of the legend on the chart. 1.7
chartLegend Relationship > legendEntries Represents a collection of legendEntries in the legend. Read-only. 1.7
chartLegendEntry Property > visible Represents the visible of a chart legend entry. 1.7
chartLegendEntryCollection Property > items A collection of chartLegendEntry objects. Read-only. 1.7
chartLegendEntryCollection Method > getCount() Returns the number of legendEntry in the collection. 1.7
chartLegendEntryCollection Method > getItemAt(index: number) Returns a legendEntry at the given index. 1.7
chartPoint Property > hasDataLabel Represents whether a data point has datalabel. Not applicable for surface charts. 1.7
chartPoint Property > markerBackgroundColor HTML color code representation of the marker background color of data point. E.g. #FF0000 represents Red. 1.7
chartPoint Property > markerForegroundColor HTML color code representation of the marker foreground color of data point. E.g. #FF0000 represents Red. 1.7
chartPoint Property > markerSize Represents marker size of data point. 1.7
chartPoint Property > markerStyle Represents marker style of a chart data point. Possible values are: Invalid, Automatic, None, Square, Diamond, Triangle, X, Star, Dot, Dash, Circle, Plus, Picture. 1.7
chartPoint Relationship > dataLabel Returns the data label of a chart point. Read-only. 1.7
chartPointFormat Relationship > border Represents the border format of a chart data point, which includes color, style and weight information. Read-only. 1.7
chartSeries Property > chartType Represents the chart type of a series. Possible values are: ColumnClustered, ColumnStacked, ColumnStacked100, BarClustered, BarStacked, BarStacked100, LineStacked, LineStacked100, LineMarkers, LineMarkersStacked, LineMarkersStacked100, PieOfPie, etc.. 1.7
chartSeries Property > doughnutHoleSize Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnutExploded charts. 1.7
chartSeries Property > filtered Boolean value representing if the series is filtered or not. Not applicable for surface charts. 1.7
chartSeries Property > gapWidth Represents the gap width of a chart series. Only valid on bar and column charts, as well as 1.7
chartSeries Property > hasDataLabels Boolean value representing if the series has data labels or not. 1.7
chartSeries Property > markerBackgroundColor Represents markers background color of a chart series. 1.7
chartSeries Property > markerForegroundColor Represents markers foreground color of a chart series. 1.7
chartSeries Property > markerSize Represents marker size of a chart series. 1.7
chartSeries Property > markerStyle Represents marker style of a chart series. Possible values are: Invalid, Automatic, None, Square, Diamond, Triangle, X, Star, Dot, Dash, Circle, Plus, Picture. 1.7
chartSeries Property > plotOrder Represents the plot order of a chart series within the chart group. 1.7
chartSeries Property > showShadow Boolean value representing if the series has shadow or not. 1.7
chartSeries Property > smooth Boolean value representing if the series is smooth or not. Only for line and scatter charts. 1.7
chartSeries Relationship > dataLabels Represents a collection of all dataLabels in the series. Read-only. ApiSet.InProgressFeatures.ChartingAPI
chartSeries Relationship > trendlines Represents a collection of trendlines in the series. Read-only. 1.7
chartSeries Method > delete() Deletes the chart series. 1.7
chartSeries Method > setBubbleSizes(sourceData: Range) Set bubble sizes for a chart series. Only works for bubble charts. 1.7
chartSeries Method > setValues(sourceData: Range) Set values for a chart series. For scatter chart, it means Y axis values. 1.7
chartSeries Method > setXAxisValues(sourceData: Range) Set values of X axis for a chart series. Only works for scatter charts. 1.7
chartSeriesCollection Method > add(name: string, index: number) Add a new series to the collection. 1.7
chartTitle Property > height Returns the height, in points, of the chart title. Read-only. Null if chart title's not visible. Read-only. 1.7
chartTitle Property > horizontalAlignment Represents the horizontal alignment for chart title. Possible values are: Center, Left, Justify, Distributed, Right. 1.7
chartTitle Property > left Represents the distance, in points, from the left edge of chart title to the left edge of chart area. Null if chart title's not visible. 1.7
chartTitle Property > position Represents the position of chart title. Possible values are: Top, Automatic, Bottom, Right, Left. 1.7
chartTitle Property > showShadow Represents a boolean value that determines if the chart title has a shadow. 1.7
chartTitle Property > textOrientation Represents the text orientation of chart title. The value should be an integer either from -90 to 90, or 180 for vertically-oriented text. 1.7
chartTitle Property > top Represents the distance, in points, from the top edge of chart title to the top of chart area. Null if chart title's not visible. 1.7
chartTitle Property > verticalAlignment Represents the vertical alignment of chart title. Possible values are: Center, Bottom, Top, Justify, Distributed. 1.7
chartTitle Property > width Returns the width, in points, of the chart title. Read-only. Null if chart title's not visible. Read-only. 1.7
chartTitle Method > setFormula(formula: string) Sets a string value that represents the formula of chart title using A1-style notation. 1.7
chartTitleFormat Relationship > border Represents the border format of chart title, which includes color, linestyle and weight. Read-only. 1.7
chartTrendline Property > backward Represents the number of periods that the trendline extends backward. 1.7
chartTrendline Property > displayEquation True if the equation for the trendline is displayed on the chart. 1.7
chartTrendline Property > displayRSquared True if the R-squared for the trendline is displayed on the chart. 1.7
chartTrendline Property > forward Represents the number of periods that the trendline extends forward. 1.7
chartTrendline Property > intercept Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic values). The returned value is always a number. 1.7
chartTrendline Property > movingAveragePeriod Represents the period of a chart trendline, only for trendline with MovingAverage type. 1.7
chartTrendline Property > name Represents the name of the trendline. Can be set to a string value, or can be set to null value represents automatic values. The returned value is always a string 1.7
chartTrendline Property > polynomialOrder Represents the order of a chart trendline, only for trendline with Polynomial type. 1.7
chartTrendline Property > type Represents the type of a chart trendline. Possible values are: Linear, Exponential, Logarithmic, MovingAverage, Polynomial, Power. 1.7
chartTrendline Relationship > format Represents the formatting of a chart trendline. Read-only. 1.7
chartTrendline Method > delete() Delete the trendline object. 1.7
chartTrendlineCollection Property > items A collection of chartTrendline objects. Read-only. 1.7
chartTrendlineCollection Method > add(type: string) Adds a new trendline to trendline collection. 1.7
chartTrendlineCollection Method > getCount() Returns the number of trendlines in the collection. 1.7
chartTrendlineCollection Method > getItem(index: number) Get trendline object by index, which is the insertion order in items array. 1.7
chartTrendlineFormat Relationship > line Represents chart line formatting. Read-only. 1.7
customFunctionPostProcessAction Property > actionType Transmits additional data to client side, e.g., worksheetId for TableSelectionChangedEvent. Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
customFunctionPostProcessAction Property > operationType Transmits additional data to client side, e.g., worksheetId for TableSelectionChangedEvent. Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
customProperty Property > key Gets the key of the custom property. Read only. Read-only. 1.7
customProperty Property > type Gets the value type of the custom property. Read only. Read-only. Possible values are: Number, Boolean, Date, String, Float. 1.7
customProperty Property > value Gets or sets the value of the custom property. 1.7
customProperty Method > delete() Deletes the custom property. 1.7
customPropertyCollection Property > items A collection of customProperty objects. Read-only. 1.7
customPropertyCollection Method > add(key: string, value: object) Creates a new or sets an existing custom property. 1.7
customPropertyCollection Method > deleteAll() Deletes all custom properties in this collection. 1.7
customPropertyCollection Method > getCount() Gets the count of custom properties. 1.7
customPropertyCollection Method > getItem(key: string) Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist. 1.7
customPropertyCollection Method > getItemOrNullObject(key: string) Gets a custom property object by its key, which is case-insensitive. Returns a null object if the custom property does not exist. 1.7
dataConnectionCollection Property > items A collection of dataConnection objects. Read-only. 1.7
dataConnectionCollection Method > refreshAll() Refreshes all the Data Connections in the collection. 1.7
documentProperties Property > author Gets or sets the author of the workbook. 1.7
documentProperties Property > category Gets or sets the category of the workbook. 1.7
documentProperties Property > comments Gets or sets the comments of the workbook. 1.7
documentProperties Property > company Gets or sets the company of the workbook. 1.7
documentProperties Property > keywords Gets or sets the keywords of the workbook. 1.7
documentProperties Property > lastAuthor Gets the last author of the workbook. Read only. Read-only. 1.7
documentProperties Property > manager Gets or sets the manager of the workbook. 1.7
documentProperties Property > revisionNumber Gets the revision number of the workbook. Read only. 1.7
documentProperties Property > subject Gets or sets the subject of the workbook. 1.7
documentProperties Property > title Gets or sets the title of the workbook. 1.7
documentProperties Relationship > creationDate Gets the creation date of the workbook. Read only. Read-only. 1.7
documentProperties Relationship > custom Gets the collection of custom properties of the workbook. Read only. Read-only. 1.7
listDataValidation Property > source Source of the list for data validation 1.8
namedItem Property > formula Gets or sets the formula of the named item. Formula always starts with a '=' sign. 1.7
namedItem Relationship > arrayValues Returns an object containing values and types of the named item. Read-only. 1.7
namedItemArrayValues Property > types Represents the types for each item in the named item array Read-only. Possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error. 1.7
namedItemArrayValues Property > values Represents the values of each item in the named item array. Read-only. 1.7
range Property > isEntireColumn Represents if the current range is an entire column. Read-only. 1.7
range Property > isEntireRow Represents if the current range is an entire row. Read-only. 1.7
range Property > numberFormatLocal Represents Excel's number format code for the given range as a string in the language of the user. 1.7
range Property > style Represents the style of the current range. This return either null or a string. 1.7
range Method > getAbsoluteResizedRange(numRows: number, numColumns: number) Gets a Range object with the same top-left cell as the current Range object, but with the specified numbers of rows and columns. 1.7
range Method > getImage() Renders the range as a base64-encoded image. 1.7
range Method > getSurroundingRegion() Returns a Range object that represents the surrounding region for the top-left cell in this range. A surrounding region is a range bounded by any combination of blank rows and blank columns relative to this range. 1.7
range Method > showCard() Displays the card for an active cell if it has rich value content. 1.7
rangeFormat Property > textOrientation Gets or sets the text orientation of all the cells within the range. 1.7
rangeFormat Property > useStandardHeight Determines if the row height of the Range object equals the standard height of the sheet. 1.7
rangeFormat Property > useStandardWidth Determines if the columnwidth of the Range object equals the standard width of the sheet. 1.7
rangeHyperlink Property > address Represents the url target for the hyperlink. 1.7
rangeHyperlink Property > document.. Represents the document .. target for the hyperlink. 1.7
rangeHyperlink Property > screenTip Represents the string displayed when hovering over the hyperlink. 1.7
rangeHyperlink Property > textToDisplay Represents the string that is displayed in the top left most cell in the range. 1.7
registerEventPostProcessAction Property > actionType Gets the top border Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
registerEventPostProcessAction Property > message Transmits additional data to client side, e.g., worksheetId for TableSelectionChangedEvent. 1.7
registerEventPostProcessAction Property > messageType Gets the top border Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
registerEventPostProcessAction Property > targetId Gets the top border Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
registerEventPostProcessAction Relationship > controlId Gets the top border Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
showCardPostProcessAction Property > actionType Transmits additional data to client side, e.g., worksheetId for TableSelectionChangedEvent. Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
showCardPostProcessAction Property > column Transmits additional data to client side, e.g., worksheetId for TableSelectionChangedEvent. Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
showCardPostProcessAction Property > row Transmits additional data to client side, e.g., worksheetId for TableSelectionChangedEvent. Possible values are: None, RegisterEvent, UnregisterEvent, CustomFunction, ShowCard. 1.7
style Property > addIndent Indicates if text is automatically indented when the text alignment in a cell is set to equal distribution. 1.7
style Property > autoIndent Indicates if text is automatically indented when the text alignment in a cell is set to equal distribution. 1.7
style Property > builtIn Indicates if the style is a built-in style. Read-only. 1.7
style Property > formulaHidden Indicates if the formula will be hidden when the worksheet is protected. 1.7
style Property > horizontalAlignment Represents the horizontal alignment for the style. Possible values are: General, Left, Center, Right, Fill, Justify, CenterAcrossSelection, Distributed. 1.7
style Property > includeAlignment Indicates if the style includes the AutoIndent, HorizontalAlignment, VerticalAlignment, WrapText, IndentLevel, and TextOrientation properties. 1.7
style Property > includeBorder Indicates if the style includes the Color, ColorIndex, LineStyle, and Weight border properties. 1.7
style Property > includeFont Indicates if the style includes the Background, Bold, Color, ColorIndex, FontStyle, Italic, Name, Size, Strikethrough, Subscript, Superscript, and Underline font properties. 1.7
style Property > includeNumber Indicates if the style includes the NumberFormat property. 1.7
style Property > includePatterns Indicates if the style includes the Color, ColorIndex, InvertIfNegative, Pattern, PatternColor, and PatternColorIndex interior properties. 1.7
style Property > includeProtection Indicates if the style includes the FormulaHidden and Locked protection properties. 1.7
style Property > indentLevel An integer from 0 to 250 that indicates the indent level for the style. 1.7
style Property > locked Indicates if the object is locked when the worksheet is protected. 1.7
style Property > name The name of the style. Read-only. 1.7
style Property > numberFormat The format code of the number format for the style. 1.7
style Property > numberFormatLocal The localized format code of the number format for the style. 1.7
style Property > orientation The text orientation for the style. 1.7
style Property > readingOrder The reading order for the style. Possible values are: Context, LeftToRight, RightToLeft. 1.7
style Property > shrinkToFit Indicates if text automatically shrinks to fit in the available column width. 1.7
style Property > textOrientation The text orientation for the style. 1.7
style Property > verticalAlignment Represents the vertical alignment for the style. Possible values are: Top, Center, Bottom, Justify, Distributed. 1.7
style Property > wrapText Indicates if Microsoft Excel wraps the text in the object. 1.7
style Relationship > borders A Border collection of four Border objects that represent the style of the four borders. Read-only. 1.7
style Relationship > fill The Fill of the style. Read-only. 1.7
style Relationship > font A Font object that represents the font of the style. Read-only. 1.7
style Method > delete() Deletes this style. 1.7
styleCollection Property > items A collection of style objects. Read-only. 1.7
styleCollection Method > add(name: string) Adds a new style to the collection. 1.7
styleCollection Method > getItem(name: string) Gets a style by name. 1.7
tableChangedEventArgs Property > address Gets the address that represents the changed area of a table on a specific worksheet. 1.7
tableChangedEventArgs Property > changeType Gets the change type that represents how the Changed event is triggered. Possible values are: Others, RangeEdited, RowInserted, RowDeleted, ColumnInserted, ColumnDeleted, CellInserted, CellDeleted. 1.7
tableChangedEventArgs Property > source Gets the source of the event. Possible values are: Local, Remote. 1.7
tableChangedEventArgs Property > tableId Gets the id of the table in which the data changed. 1.7
tableChangedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
tableChangedEventArgs Property > worksheetId Gets the id of the worksheet in which the data changed. 1.7
tableSelectionChangedEventArgs Property > address Gets the range address that represents the selected area of the table on a specific worksheet. 1.7
tableSelectionChangedEventArgs Property > isInsideTable Indicates if the selection is inside a table, address will be useless if IsInsideTable is false. 1.7
tableSelectionChangedEventArgs Property > tableId Gets the id of the table in which the selection changed. 1.7
tableSelectionChangedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
tableSelectionChangedEventArgs Property > worksheetId Gets the id of the worksheet in which the selection changed. 1.7
workbook Property > name Gets the workbook name. Read-only. 1.7
workbook Relationship > dataConnections Refreshes all data connections in the workbook. Read-only. 1.7
workbook Relationship > properties Gets the workbook properties. Read-only. 1.7
workbook Relationship > protection Returns workbook protection object for a workbook. Read-only. 1.7
workbook Relationship > styles Represents a collection of styles associated with the workbook. Read-only. 1.7
workbook Method > getActiveCell() Gets the currently active cell from the workbook. 1.7
workbookProtection Property > protected Indicates if the workbook is protected. Read-Only. Read-only. 1.7
workbookProtection Method > protect(password: string) Protects a workbook. Fails if the workbook has been protected. 1.7
workbookProtection Method > unprotect(password: string) Unprotects a workbook. 1.7
worksheet Property > gridlines Gets or sets the worksheet's gridlines flag. 1.7
worksheet Property > headings Gets or sets the worksheet's headings flag. 1.7
worksheet Property > showGridlines Gets or sets the worksheet's gridlines flag. 1.7
worksheet Property > showHeadings Gets or sets the worksheet's headings flag. 1.7
worksheet Property > standardHeight Returns the standard (default) height of all the rows in the worksheet, in points. Read-only. 1.7
worksheet Property > standardWidth Returns or sets the standard (default) width of all the columns in the worksheet. 1.7
worksheet Property > tabColor Gets or sets the worksheet tab color. 1.7
worksheet Relationship > freezePanes Gets an object that can be used to manipulate frozen panes on the worksheet Read-only. 1.7
worksheet Method > copy(positionType: WorksheetPositionType, relativeTo: Worksheet) Copy a worksheet and place it at the specified position. Return the copied worksheet. 1.7
worksheet Method > getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number) Gets the range object beginning at a particular row index and column index, and spanning a certain number of rows and columns. 1.7
worksheetActivatedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
worksheetActivatedEventArgs Property > worksheetId Gets the id of the worksheet that is activated. 1.7
worksheetAddedEventArgs Property > source Gets the source of the event. Possible values are: Local, Remote. 1.7
worksheetAddedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
worksheetAddedEventArgs Property > worksheetId Gets the id of the worksheet that is added to the workbook. 1.7
worksheetChangedEventArgs Property > address Gets the range address that represents the changed area of a specific worksheet. 1.7
worksheetChangedEventArgs Property > changeType Gets the change type that represents how the Changed event is triggered. Possible values are: Others, RangeEdited, RowInserted, RowDeleted, ColumnInserted, ColumnDeleted, CellInserted, CellDeleted. 1.7
worksheetChangedEventArgs Property > source Gets the source of the event. Possible values are: Local, Remote. 1.7
worksheetChangedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
worksheetChangedEventArgs Property > worksheetId Gets the id of the worksheet in which the data changed. 1.7
worksheetDeactivatedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
worksheetDeactivatedEventArgs Property > worksheetId Gets the id of the worksheet that is deactivated. 1.7
worksheetDeletedEventArgs Property > source Gets the source of the event. Possible values are: Local, Remote. 1.7
worksheetDeletedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
worksheetDeletedEventArgs Property > worksheetId Gets the id of the worksheet that is deleted from the workbook. 1.7
worksheetFreezePanes Method > freezeAt(frozenRange: Range or string) Sets the frozen cells in the active worksheet view. 1.7
worksheetFreezePanes Method > freezeColumns(count: number) Freeze the first column(s) of the worksheet in place. 1.7
worksheetFreezePanes Method > freezeRows(count: number) Freeze the top row(s) of the worksheet in place. 1.7
worksheetFreezePanes Method > getLocation() Gets a range that describes the frozen cells in the active worksheet view. 1.7
worksheetFreezePanes Method > getLocationOrNullObject() Gets a range that describes the frozen cells in the active worksheet view. 1.7
worksheetFreezePanes Method > unfreeze() Removes all frozen panes in the worksheet. 1.7
worksheetProtectionOptions Property > allowEditObjects Represents the worksheet protection option of allowing editing objects. 1.7
worksheetProtectionOptions Property > allowEditScenarios Represents the worksheet protection option of allowing editing scenarios. 1.7
worksheetProtectionOptions Relationship > selectionMode Represents the worksheet protection option of selection mode. 1.7
worksheetSelectionChangedEventArgs Property > address Gets the range address that represents the selected area of a specific worksheet. 1.7
worksheetSelectionChangedEventArgs Property > type Gets the type of the event. Possible values are: WorksheetDataChanged, WorksheetSelectionChanged, WorksheetAdded, WorksheetActivated, WorksheetDeactivated, TableDataChanged, TableSelectionChanged, WorksheetDeleted. 1.7
worksheetSelectionChangedEventArgs Property > worksheetId Gets the id of the worksheet in which the selection changed. 1.7

What's new in Excel JavaScript API 1.6

Conditional formatting

Introduces Conditional formating of a range. Allows follwoing types of conditional formatting:

  • Color scale
  • Data bar
  • Icon set
  • Custom

In addiiton: * Returns the range the conditonal format is applied to. * Removal of conditional formatting. * Provides priority and stopifTrue capability * Get collection of all conditional formatting on a given range. * Clears all conditional formats active on the current specified range.

For API details, please refer to the Excel API open specification.

Object What is new Description Requirement set
application Method > suspendApiCalculationUntilNextSync() Suspends calculation until the next "context.sync()" is called. Once set, it is the developer's responsibility to re-calc the workbook, to ensure that any dependencies are propagated. 1.6
cellValueConditionalFormat Relationship > format Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. 1.6
cellValueConditionalFormat Relationship > rule Represents the Rule object on this conditional format. 1.6
colorScaleConditionalFormat Property > threeColorScale If true the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum). Read-only. 1.6
colorScaleConditionalFormat Relationship > criteria The criteria of the color scale. Midpoint is optional when using a two point color scale. 1.6
conditionalCellValueRule Property > formula1 The formula, if required, to evaluate the conditional format rule on. 1.6
conditionalCellValueRule Property > formula2 The formula, if required, to evaluate the conditional format rule on. 1.6
conditionalCellValueRule Property > operator The operator of the text conditional format. Possible values are: Invalid, Between, NotBetween, EqualTo, NotEqualTo, GreaterThan, LessThan, GreaterThanOrEqual, LessThanOrEqual. 1.6
conditionalColorScaleCriteria Relationship > maximum The maximum point Color Scale Criterion. 1.6
conditionalColorScaleCriteria Relationship > midpoint The midpoint Color Scale Criterion if the color scale is a 3-color scale. 1.6
conditionalColorScaleCriteria Relationship > minimum The minimum point Color Scale Criterion. 1.6
conditionalColorScaleCriterion Property > color HTML color code representation of the color scale color. E.g. #FF0000 represents Red. 1.6
conditionalColorScaleCriterion Property > formula A number, a formula, or null (if Type is LowestValue). 1.6
conditionalColorScaleCriterion Property > type What the icon conditional formula should be based on. Possible values are: Invalid, LowestValue, HighestValue, Number, Percent, Formula, Percentile. 1.6
conditionalDataBarNegativeFormat Property > borderColor HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). 1.6
conditionalDataBarNegativeFormat Property > fillColor HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). 1.6
conditionalDataBarNegativeFormat Property > matchPositiveBorderColor Boolean representation of whether or not the negative DataBar has the same border color as the positive DataBar. 1.6
conditionalDataBarNegativeFormat Property > matchPositiveFillColor Boolean representation of whether or not the negative DataBar has the same fill color as the positive DataBar. 1.6
conditionalDataBarPositiveFormat Property > borderColor HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). 1.6
conditionalDataBarPositiveFormat Property > fillColor HTML color code representing the fill color, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). 1.6
conditionalDataBarPositiveFormat Property > gradientFill Boolean representation of whether or not the DataBar has a gradient. 1.6
conditionalDataBarRule Property > formula The formula, if required, to evaluate the databar rule on. 1.6
conditionalDataBarRule Property > type The type of rule for the databar. Possible values are: LowestValue, HighestValue, Number, Percent, Formula, Percentile, Automatic. 1.6
conditionalFormat Property > id The Priority of the Conditional Format within the current ConditionalFormatCollection. Read-only. 1.6
conditionalFormat Property > priority The priority (or index) within the conditional format collection that this conditional format currently exists in. Changing this also 1.6
conditionalFormat Property > stopIfTrue If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. 1.6
conditionalFormat Property > type A type of conditional format. Only one can be set at a time. Read-Only. Read-only. Possible values are: Custom, DataBar, ColorScale, IconSet. 1.6
conditionalFormat Relationship > cellValue Returns the cell value conditional format properties if the current conditional format is a CellValue type. Read-only. 1.6
conditionalFormat Relationship > cellValueOrNullObject Returns the cell value conditional format properties if the current conditional format is a CellValue type. Read-only. 1.6
conditionalFormat Relationship > colorScale Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Read-only. 1.6
conditionalFormat Relationship > colorScaleOrNullObject Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. Read-only. 1.6
conditionalFormat Relationship > custom Returns the custom conditional format properties if the current conditional format is a custom type. Read-only. 1.6
conditionalFormat Relationship > customOrNullObject Returns the custom conditional format properties if the current conditional format is a custom type. Read-only. 1.6
conditionalFormat Relationship > dataBar Returns the data bar properties if the current conditional format is a data bar. Read-only. 1.6
conditionalFormat Relationship > dataBarOrNullObject Returns the data bar properties if the current conditional format is a data bar. Read-only. 1.6
conditionalFormat Relationship > iconSet Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Read-only. 1.6
conditionalFormat Relationship > iconSetOrNullObject Returns the IconSet conditional format properties if the current conditional format is an IconSet type. Read-only. 1.6
conditionalFormat Relationship > preset Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties. Read-only. 1.6
conditionalFormat Relationship > presetOrNullObject Returns the preset criteria conditional format such as above averagebelow averageunique valuescontains blanknonblankerrornoerror properties. Read-only. 1.6
conditionalFormat Relationship > textComparison Returns the specific text conditional format properties if the current conditional format is a text type. Read-only. 1.6
conditionalFormat Relationship > textComparisonOrNullObject Returns the specific text conditional format properties if the current conditional format is a text type. Read-only. 1.6
conditionalFormat Relationship > topBottom Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type. Read-only. 1.6
conditionalFormat Relationship > topBottomOrNullObject Returns the TopBottom conditional format properties if the current conditional format is an TopBottom type. Read-only. 1.6
conditionalFormat Method > delete() Deletes this conditional format. 1.6
conditionalFormat Method > getRange() Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. 1.6
conditionalFormat Method > getRangeOrNullObject() Returns the range the conditonal format is applied to or a null object if the range is discontiguous. Read-only. 1.6
conditionalFormatCollection Property > items A collection of conditionalFormat objects. Read-only. 1.6
conditionalFormatCollection Method > add(type: string) Adds a new conditional format to the collection at the firsttop priority. 1.6
conditionalFormatCollection Method > clearAll() Clears all conditional formats active on the current specified range. 1.6
conditionalFormatCollection Method > getCount() Returns the number of conditional formats in the workbook. Read-only. 1.6
conditionalFormatCollection Method > getItem(id: string) Returns a conditional format for the given ID. 1.6
conditionalFormatCollection Method > getItemAt(index: number) Returns a conditional format at the given index. 1.6
conditionalFormatRule Property > formula The formula, if required, to evaluate the conditional format rule on. 1.6
conditionalFormatRule Property > formulaLocal The formula, if required, to evaluate the conditional format rule on in the user's language. 1.6
conditionalFormatRule Property > formulaR1C1 The formula, if required, to evaluate the conditional format rule on in R1C1-style notation. 1.6
conditionalIconCriterion Property > formula A number or a formula depending on the type. 1.6
conditionalIconCriterion Property > operator GreaterThan or GreaterThanOrEqual for each of the rule type for the Icon conditional format. Possible values are: Invalid, GreaterThan, GreaterThanOrEqual. 1.6
conditionalIconCriterion Relationship > customIcon The custom icon for the current criterion if different from the default IconSet, else null will be returned. 1.6
conditionalIconCriterion Relationship > type What the icon conditional formula should be based on. 1.6
conditionalPresetCriteriaRule Property > criterion The criterion of the conditional format. Possible values are: Invalid, Blanks, NonBlanks, Errors, NonErrors, Yesterday, Today, Tomorrow, LastSevenDays, LastWeek, ThisWeek, NextWeek, LastMonth, ThisMonth, NextMonth, AboveAverage, BelowAverage, EqualOrAboveAverage, EqualOrBelowAverage, OneStdDevAboveAverage, OneStdDevBelowAverage, TwoStdDevAboveAverage, TwoStdDevBelowAverage, ThreeStdDevAboveAverage, ThreeStdDevBelowAverage, UniqueValues, DuplicateValues. 1.6
conditionalRangeBorder Property > color HTML color code representing the color of the border line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). 1.6
conditionalRangeBorder Property > id Represents border identifier. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight. 1.6
conditionalRangeBorder Property > sideIndex Constant value that indicates the specific side of the border. Read-only. Possible values are: EdgeTop, EdgeBottom, EdgeLeft, EdgeRight. 1.6
conditionalRangeBorder Property > style One of the constants of line style specifying the line style for the border. Possible values are: None, Continuous, Dash, DashDot, DashDotDot, Dot, Double, SlantDashDot. 1.6
conditionalRangeBorderCollection Property > count Number of border objects in the collection. Read-only. 1.6
conditionalRangeBorderCollection Property > items A collection of conditionalRangeBorder objects. Read-only. 1.6
conditionalRangeBorderCollection Relationship > bottom Gets the top border Read-only. 1.6
conditionalRangeBorderCollection Relationship > left Gets the top border Read-only. 1.6
conditionalRangeBorderCollection Relationship > right Gets the top border Read-only. 1.6
conditionalRangeBorderCollection Relationship > top Gets the top border Read-only. 1.6
conditionalRangeBorderCollection Method > getItem(index: string) Gets a border object using its name 1.6
conditionalRangeBorderCollection Method > getItemAt(index: number) Gets a border object using its index 1.6
conditionalRangeFill Property > color HTML color code representing the color of the fill, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). 1.6
conditionalRangeFill Method > clear() Resets the fill. 1.6
conditionalRangeFont Property > bold Represents the bold status of font. 1.6
conditionalRangeFont Property > color HTML color code representation of the text color. E.g. #FF0000 represents Red. 1.6
conditionalRangeFont Property > italic Represents the italic status of the font. 1.6
conditionalRangeFont Property > strikethrough Represents the strikethrough status of the font. 1.6
conditionalRangeFont Property > underline Type of underline applied to the font. Possible values are: None, Single, Double. 1.6
conditionalRangeFont Method > clear() Resets the font formats. 1.6
conditionalRangeFormat Property > numberFormat Represents Excel's number format code for the given range. Cleared if null is passed in. 1.6
conditionalRangeFormat Relationship > borders Collection of border objects that apply to the overall conditional format range. Read-only. 1.6
conditionalRangeFormat Relationship > fill Returns the fill object defined on the overall conditional format range. Read-only. 1.6
conditionalRangeFormat Relationship > font Returns the font object defined on the overall conditional format range. Read-only. 1.6
conditionalTextComparisonRule Property > operator The operator of the text conditional format. Possible values are: Invalid, Contains, NotContains, BeginsWith, EndsWith. 1.6
conditionalTextComparisonRule Property > text The Text value of conditional format. 1.6
conditionalTopBottomRule Property > rank The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks. 1.6
conditionalTopBottomRule Property > type Format values based on the top or bottom rank. Possible values are: Invalid, TopItems, TopPercent, BottomItems, BottomPercent. 1.6
customConditionalFormat Relationship > format Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. 1.6
customConditionalFormat Relationship > rule Represents the Rule object on this conditional format. Read-only. 1.6
dataBarConditionalFormat Property > axisColor HTML color code representing the color of the Axis line, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange"). 1.6
dataBarConditionalFormat Property > axisFormat Representation of how the axis is determined for an Excel data bar. Possible values are: Automatic, None, CellMidPoint. 1.6
dataBarConditionalFormat Property > barDirection Represents the direction that the data bar graphic should be based on. Possible values are: Context, LeftToRight, RightToLeft. 1.6
dataBarConditionalFormat Property > showDataBarOnly If true, hides the values from the cells where the data bar is applied. 1.6
dataBarConditionalFormat Relationship > lowerBoundRule The rule for what consistutes the lower bound (and how to calculate it, if applicable) for a data bar. 1.6
dataBarConditionalFormat Relationship > negativeFormat Representation of all values to the left of the axis in an Excel data bar. Read-only. 1.6
dataBarConditionalFormat Relationship > positiveFormat Representation of all values to the right of the axis in an Excel data bar. Read-only. 1.6
dataBarConditionalFormat Relationship > upperBoundRule The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar. 1.6
iconSetConditionalFormat Property > reverseIconOrder If true, reverses the icon orders for the IconSet. Note that this cannot be set if custom icons are used. 1.6
iconSetConditionalFormat Property > showIconOnly If true, hides the values and only shows icons. 1.6
iconSetConditionalFormat Property > style If set, displays the IconSet option for the conditional format. Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes. 1.6
iconSetConditionalFormat Relationship > criteria An array of Criteria and IconSets for the rules and potential custom icons for conditional icons. Note that for the first criterion only the custom icon can be modified, while type, formula and operator will be ignored when set. 1.6
presetCriteriaConditionalFormat Relationship > format Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. 1.6
presetCriteriaConditionalFormat Relationship > rule The rule of the conditional format. 1.6
range Relationship > conditionalFormats Collection of ConditionalFormats that intersect the range. Read-only. 1.6
range Method > calculate() Calculates a range of cells on a worksheet. 1.6
textConditionalFormat Relationship > format Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. 1.6
textConditionalFormat Relationship > rule The rule of the conditional format. 1.6
topBottomConditionalFormat Relationship > format Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties. Read-only. 1.6
topBottomConditionalFormat Relationship > rule The criteria of the TopBottom conditional format. 1.6
workbook Relationship > internalTest For internal use only. Read-only. 1.6
worksheet Method > calculate(markAllDirty: bool) Calculates all cells on a worksheet. 1.6

What's new in Excel JavaScript API 1.5

Custom XML part

  • Addition of custom XML parts collection to workbook object.
  • Get custom XML part using ID
  • Get a new scoped collection of custom XML parts whose namespaces match the given namespace.
  • Get XML string associated with a part.
  • Provide id and namespace of a part.
  • Adds a new custom XML part to the workbook.
  • Set entire XML part.
  • Delete a custom XML part.
  • Delete an attribute with the given name from the element identified by xpath.
  • Query the XML content by xpath.
  • Insert, update and delete attribute.

Reference implementation: Please refer here for a reference implementation that shows how custom XML parts can be used in an add-in.

Others

  • range.getSurroundingRegion() Returns a Range object that represents the surrounding region for this range. A surrounding region is a range bounded by any combination of blank rows and blank columns relative to this range.
  • getNextColumn() and getPreviousColumn(), `getLast() on table column.
  • getActiveWorksheet() on the workbook.
  • getRange(address: string) off of workbook.
  • getBoundingRange(ranges: ) Gets the smallest range object that encompasses the provided ranges. For example, the bounding range between "B2:C5" and "D10:E15" is "B2:E15".
  • getCount() on various collections such as named item, worksheet, table, etc. to get number of items in a collection. workbook.worksheets.getCount()
  • getFirst() and getLast() and get last on various collection such as tworksheet, able column, chart points, range view collection.
  • getNext() and getPrevious() on worksheet, table column collection.
  • getRangeR1C1() Gets the range object beginning at a particular row index and column index, and spanning a certain number of rows and columns.

For API details, please refer to the Excel API open specification.

Object What is new Description Requirement set
customXmlPart Property > id The custom XML part's ID. Read-only. 1.5
customXmlPart Property > namespaceUri The custom XML part's namespace URI. Read-only. 1.5
customXmlPart Method > delete() Deletes the custom XML part. 1.5
customXmlPart Method > getXml() Gets the custom XML part's full XML content. 1.5
customXmlPart Method > setXml(xml: string) Sets the custom XML part's full XML content. 1.5
customXmlPartCollection Property > items A collection of customXmlPart objects. Read-only. 1.5
customXmlPartCollection Method > add(xml: string) Adds a new custom XML part to the workbook. 1.5
customXmlPartCollection Method > getByNamespace(namespaceUri: string) Gets a new scoped collection of custom XML parts whose namespaces match the given namespace. 1.5
customXmlPartCollection Method > getCount() Gets the number of CustomXml parts in the collection. 1.5
customXmlPartCollection Method > getItem(id: string) Gets a custom XML part based on its ID. 1.5
customXmlPartCollection Method > getItemOrNullObject(id: string) Gets a custom XML part based on its ID. 1.5
customXmlPartScopedCollection Property > items A collection of customXmlPartScoped objects. Read-only. 1.5
customXmlPartScopedCollection Method > getCount() Gets the number of CustomXML parts in this collection. 1.5
customXmlPartScopedCollection Method > getItem(id: string) Gets a custom XML part based on its ID. 1.5
customXmlPartScopedCollection Method > getItemOrNullObject(id: string) Gets a custom XML part based on its ID. 1.5
customXmlPartScopedCollection Method > getOnlyItem() If the collection contains exactly one item, this method returns it. 1.5
customXmlPartScopedCollection Method > getOnlyItemOrNullObject() If the collection contains exactly one item, this method returns it. 1.5
workbook Relationship > customXmlParts Represents the collection of custom XML parts contained by this workbook. Read-only. 1.5
worksheet Method > getNext(visibleOnly: bool) Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an error. 1.5
worksheet Method > getNextOrNullObject(visibleOnly: bool) Gets the worksheet that follows this one. If there are no worksheets following this one, this method will return a null object. 1.5
worksheet Method > getPrevious(visibleOnly: bool) Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error. 1.5
worksheet Method > getPreviousOrNullObject(visibleOnly: bool) Gets the worksheet that precedes this one. If there are no previous worksheets, this method will return a null objet. 1.5
worksheetCollection Method > getFirst(visibleOnly: bool) Gets the first worksheet in the collection. 1.5
worksheetCollection Method > getLast(visibleOnly: bool) Gets the last worksheet in the collection. 1.5

What's new in Excel JavaScript API 1.4

The following are the new additions to the Excel JavaScript APIs in requirement set 1.3.

Named item add and new properties

New properties:

  • comment
  • scope worksheet or workbook scoped items
  • worksheet returns the worksheet on which the named item is scoped to.

New methods:

  • add(name: string, reference: Range or string, comment: string)Adds a new name to the collection of the given scope.
  • addFormulaLocal(name: string, formula: string, comment: string) Adds a new name to the collection of the given scope using the user's locale for the formula.

Settings API in in Excel namespace

Setting object represents a key-value pair of a setting persisted to the document. Now, we've added settings related APIs under Excel namespace. This doesn't offer net new functionality - however this make easy to remain in the promise based batched API syntax reduce the dependency on common API for Excel related tasks.

APIs include getItem() to get setting entry via the key, add() to add the specified key:value setting pair to the workbook.

Others

  • Set table column name (prior version only allows reading).
  • Add table column to the end of the table (prior version only allows anywhere but last).
  • Add multiple rows to a table at a time (prior version only allows 1 row at a time).
  • range.getColumnsAfter(count: number) and range.getColumnsBefore(count: number) to get a certain number of columns to the right/left of the current Range object.
  • Get item or null object function: This functionality allows getting object using a key. If the object does not exist, the returned object's isNullObject property will be true. This alows developers to check if an object exists or not without having to handle it thorugh exception handling. Available on worksheet, named-item, binding, chart series, etc.

worksheet.GetItemOrNullObject()

Object What is new Description Requirement set
bindingCollection Method > getCount() Gets the number of bindings in the collection. 1.4
bindingCollection Method > getItemOrNullObject(id: string) Gets a binding object by ID. If the binding object does not exist, will return a null object. 1.4
chartCollection Method > getCount() Returns the number of charts in the worksheet. 1.4
chartCollection Method > getItemOrNullObject(name: string) Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. 1.4
chartPointsCollection Method > getCount() Returns the number of chart points in the series. 1.4
chartSeriesCollection Method > getCount() Returns the number of series in the collection. 1.4
namedItem Property > comment Represents the comment associated with this name. 1.4
namedItem Property > scope Indicates whether the name is scoped to the workbook or to a specific worksheet. Read-only. Possible values are: Equal, Greater, GreaterEqual, Less, LessEqual, NotEqual. 1.4
namedItem Relationship > worksheet Returns the worksheet on which the named item is scoped to. Throws an error if the items is scoped to the workbook instead. Read-only. 1.4
namedItem Relationship > worksheetOrNullObject Returns the worksheet on which the named item is scoped to. Returns a null object if the item is scoped to the workbook instead. Read-only. 1.4
namedItem Method > delete() Deletes the given name. 1.4
namedItem Method > getRangeOrNullObject() Returns the range object that is associated with the name. Returns a null object if the named item's type is not a range. 1.4
namedItemCollection Method > add(name: string, reference: Range or string, comment: string) Adds a new name to the collection of the given scope. 1.4
namedItemCollection Method > addFormulaLocal(name: string, formula: string, comment: string) Adds a new name to the collection of the given scope using the user's locale for the formula. 1.4
namedItemCollection Method > getCount() Gets the number of named items in the collection. 1.4
namedItemCollection Method > getItemOrNullObject(name: string) Gets a nameditem object using its name. If the nameditem object does not exist, will return a null object. 1.4
pivotTableCollection Method > getCount() Gets the number of pivot tables in the collection. 1.4
pivotTableCollection Method > getItemOrNullObject(name: string) Gets a PivotTable by name. If the PivotTable does not exist, will return a null object. 1.4
range Method > getIntersectionOrNullObject(anotherRange: Range or string) Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object. 1.4
range Method > getUsedRangeOrNullObject(valuesOnly: bool) Returns the used range of the given range object. If there are no used cells within the range, this function will return a null object. 1.4
rangeViewCollection Method > getCount() Gets the number of RangeView objects in the collection. 1.4
setting Property > key Returns the key that represents the id of the Setting. Read-only. 1.4
setting Property > value Represents the value stored for this setting. 1.4
setting Method > delete() Deletes the setting. 1.4
settingCollection Property > items A collection of setting objects. Read-only. 1.4
settingCollection Method > add(key: string, value: (any)) Sets or adds the specified setting to the workbook. 1.4
settingCollection Method > getCount() Gets the number of Settings in the collection. 1.4
settingCollection Method > getItem(key: string) Gets a Setting entry via the key. 1.4
settingCollection Method > getItemOrNullObject(key: string) Gets a Setting entry via the key. If the Setting does not exist, will return a null object. 1.4
settingsChangedEventArgs Relationship > settings Gets the Setting object that represents the binding that raised the SettingsChanged event 1.4
tableCollection Method > getCount() Gets the number of tables in the collection. 1.4
tableCollection Method > getItemOrNullObject(key: number or string) Gets a table by Name or ID. If the table does not exist, will return a null object. 1.4
tableColumnCollection Method > getCount() Gets the number of columns in the table. 1.4
tableColumnCollection Method > getItemOrNullObject(key: number or string) Gets a column object by Name or ID. If the column does not exist, will return a null object. 1.4
tableRowCollection Method > getCount() Gets the number of rows in the table. 1.4
workbook Relationship > settings Represents a collection of Settings associated with the workbook. Read-only. 1.4
worksheet Relationship > names Collection of names scoped to the current worksheet. Read-only. 1.4
worksheet Method > getUsedRangeOrNullObject(valuesOnly: bool) The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, this function will return a null object. 1.4
worksheetCollection Method > getCount(visibleOnly: bool) Gets the number of worksheets in the collection. 1.4
worksheetCollection Method > getItemOrNullObject(key: string) Gets a worksheet object using its Name or ID. If the worksheet does not exist, will return a null object. 1.4

What's new in Excel JavaScript API 1.3

The following are the new additions to the Excel JavaScript APIs in requirement set 1.3.

Object What's new Description Requirement set
binding Method > delete() Deletes the binding. 1.3
bindingCollection Method > add(range: Range or string, bindingType: string, id: string) Add a new binding to a particular Range. 1.3
bindingCollection Method > addFromNamedItem(name: string, bindingType: string, id: string) Add a new binding based on a named item in the workbook. 1.3
bindingCollection Method > addFromSelection(bindingType: string, id: string) Add a new binding based on the current selection. 1.3
bindingCollection Method > getItemOrNull(id: string) Gets a binding object by ID. If the binding object does not exist, the return object's isNull property will be true. 1.3
chartCollection Method > getItemOrNull(name: string) Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. 1.3
namedItemCollection Method > getItemOrNull(name: string) Gets a nameditem object using its name. If the nameditem object does not exist, the returned object's isNull property will be true. 1.3
pivotTable Property > name Name of the PivotTable. 1.3
pivotTable Relationship > worksheet The worksheet containing the current PivotTable. Read-only. 1.3
pivotTable Method > refresh() Refreshes the PivotTable. 1.3
pivotTableCollection Property > items A collection of pivotTable objects. Read-only. 1.3
pivotTableCollection Method > getItem(name: string) Gets a PivotTable by name. 1.3
pivotTableCollection Method > getItemOrNull(name: string) Gets a PivotTable by name. If the PivotTable does not exist, the return object's isNull property will be true. 1.3
range Method > getIntersectionOrNull(anotherRange: Range or string) Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, will return a null object. 1.3
range Method > getVisibleView() Represents the visible rows of the current range. 1.3
rangeView Property > cellAddresses Represents the cell addresses of the RangeView. Read-only. 1.3
rangeView Property > columnCount Returns the number of visible columns. Read-only. 1.3
rangeView Property > formulas Represents the formula in A1-style notation. 1.3
rangeView Property > formulasLocal Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, introduced in 1.5)" formula would become "=SUMME(A1; 1,5)" in German. 1.3
rangeView Property > formulasR1C1 Represents the formula in R1C1-style notation. 1.3
rangeView Property > index Returns a value that represents the index of the RangeView. Read-only. 1.3
rangeView Property > numberFormat Represents Excel's number format code for the given cell. 1.3
rangeView Property > rowCount Returns the number of visible rows. Read-only. 1.3
rangeView Property > text Text values of the specified range. The Text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. Read-only. 1.3
rangeView Property > valueTypes Represents the type of data of each cell. Read-only. Possible values are: Unknown, Empty, String, Integer, Double, Boolean, Error. 1.3
rangeView Property > values Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cell that contain an error will return the error string. 1.3
rangeView Relationship > rows Represents a collection of range views associated with the range. Read-only. 1.3
rangeView Method > getRange() Gets the parent range associated with the current RangeView. 1.3
rangeViewCollection Property > items A collection of rangeView objects. Read-only. 1.3
rangeViewCollection Method > getItemAt(index: number) Gets a RangeView Row via it's index. Zero-Indexed. 1.3
setting Property > key Returns the key that represents the id of the Setting. Read-only. 1.3
setting Method > delete() Deletes the setting. 1.3
settingCollection Property > items A collection of setting objects. Read-only. 1.3
settingCollection Method > getItem(key: string) Gets a Setting entry via the key. 1.3
settingCollection Method > getItemOrNull(key: string) Gets a Setting entry via the key. If the Setting does not exist, the returned object's isNull property will be true. 1.3
settingCollection Method > set(key: string, value: string) Sets or adds the specified setting to the workbook. 1.3
settingsChangedEventArgs Relationship > settingCollection Gets the Setting object that represents the binding that raised the SettingsChanged event 1.3
table Property > highlightFirstColumn Indicates whether the first column contains special formatting. 1.3
table Property > highlightLastColumn Indicates whether the last column contains special formatting. 1.3
table Property > showBandedColumns Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier. 1.3
table Property > showBandedRows Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier. 1.3
table Property > showFilterButton Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. 1.3
tableCollection Method > getItemOrNull(key: number or string) Gets a table by Name or ID. If the table does not exist, the return object's isNull property will be true. 1.3
tableColumnCollection Method > getItemOrNull(key: number or string) Gets a column object by Name or ID. If the column does not exist, the returned object's isNull property will be true. 1.3
workbook Relationship > pivotTables Represents a collection of PivotTables associated with the workbook. Read-only. 1.3
workbook Relationship > settings Represents a collection of Settings associated with the workbook. Read-only. 1.3
worksheet Relationship > pivotTables Collection of PivotTables that are part of the worksheet. Read-only. 1.3

What's new in Excel JavaScript API 1.2

The following are the new additions to the Excel JavaScript APIs in requirement set 1.2.

Object What's new Description Requirement set
chart Property > id Gets a chart based on its position in the collection. Read-only. 1.2
chart Relationship > worksheet The worksheet containing the current chart. Read-only. 1.2
chart Method > getImage(height: number, width: number, fittingMode: string) Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions. 1.2
filter Relationship > criteria The currently applied filter on the given column. Read-only. 1.2
filter Method > apply(criteria: FilterCriteria) Apply the given filter criteria on the given column. 1.2
filter Method > applyBottomItemsFilter(count: number) Apply a "Bottom Item" filter to the column for the given number of elements. 1.2
filter Method > applyBottomPercentFilter(percent: number) Apply a "Bottom Percent" filter to the column for the given percentage of elements. 1.2
filter Method > applyCellColorFilter(color: string) Apply a "Cell Color" filter to the column for the given color. 1.2
filter Method > applyCustomFilter(criteria1: string, criteria2: string, oper: string) Apply a "Icon" filter to the column for the given criteria strings. 1.2
filter Method > applyDynamicFilter(criteria: string) Apply a "Dynamic" filter to the column. 1.2
filter Method > applyFontColorFilter(color: string) Apply a "Font Color" filter to the column for the given color. 1.2
filter Method > applyIconFilter(icon: Icon) Apply a "Icon" filter to the column for the given icon. 1.2
filter Method > applyTopItemsFilter(count: number) Apply a "Top Item" filter to the column for the given number of elements. 1.2
filter Method > applyTopPercentFilter(percent: number) Apply a "Top Percent" filter to the column for the given percentage of elements. 1.2
filter Method > applyValuesFilter(values: ()) Apply a "Values" filter to the column for the given values. 1.2
filter Method > clear() Clear the filter on the given column. 1.2
filterCriteria Property > color The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering. 1.2
filterCriteria Property > criterion1 The first criterion used to filter data. Used as an operator in the case of "custom" filtering. 1.2
filterCriteria Property > criterion2 The second criterion used to filter data. Only used as an operator in the case of "custom" filtering. 1.2
filterCriteria Property > dynamicCriteria The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering. Possible values are: Unknown, AboveAverage, AllDatesInPeriodApril, AllDatesInPeriodAugust, AllDatesInPeriodDecember, AllDatesInPeriodFebruray, AllDatesInPeriodJanuary, AllDatesInPeriodJuly, AllDatesInPeriodJune, AllDatesInPeriodMarch, AllDatesInPeriodMay, AllDatesInPeriodNovember, AllDatesInPeriodOctober, AllDatesInPeriodQuarter1, AllDatesInPeriodQuarter2, AllDatesInPeriodQuarter3, AllDatesInPeriodQuarter4, AllDatesInPeriodSeptember, BelowAverage, LastMonth, LastQuarter, LastWeek, LastYear, NextMonth, NextQuarter, NextWeek, NextYear, ThisMonth, ThisQuarter, ThisWeek, ThisYear, Today, Tomorrow, YearToDate, Yesterday. 1.2
filterCriteria Property > filterOn The property used by the filter to determine whether the values should stay visible. Possible values are: BottomItems, BottomPercent, CellColor, Dynamic, FontColor, Values, TopItems, TopPercent, Icon, Custom. 1.2
filterCriteria Property > operator The operator used to combine criterion 1 and 2 when using "custom" filtering. Possible values are: And, Or. 1.2
filterCriteria Property > values The set of values to be used as part of "values" filtering. 1.2
filterCriteria Relationship > icon The icon used to filter cells. Used with "icon" filtering. 1.2
filterDatetime Property > date The date in ISO8601 format used to filter data. 1.2
filterDatetime Property > specificity How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specifity is set to "month", the filter operation will keep all rows with a date in the month of april 2009. Possible values are: Year, Monday, Day, Hour, Minute, Second. 1.2
formatProtection Property > formulaHidden Indicates if Excel hides the formula for the cells in the range. A null value indicates that the entire range doesn't have uniform formula hidden setting. 1.2
formatProtection Property > locked Indicates if Excel locks the cells in the object. A null value indicates that the entire range doesn't have uniform lock setting. 1.2
icon Property > index Represents the index of the icon in the given set. 1.2
icon Property > set Represents the set that the icon is part of. Possible values are: Invalid, ThreeArrows, ThreeArrowsGray, ThreeFlags, ThreeTrafficLights1, ThreeTrafficLights2, ThreeSigns, ThreeSymbols, ThreeSymbols2, FourArrows, FourArrowsGray, FourRedToBlack, FourRating, FourTrafficLights, FiveArrows, FiveArrowsGray, FiveRating, FiveQuarters, ThreeStars, ThreeTriangles, FiveBoxes. 1.2
range Property > columnHidden Represents if all columns of the current range are hidden. 1.2
range Property > formulasR1C1 Represents the formula in R1C1-style notation. 1.2
range Property > hidden Represents if all cells of the current range are hidden. Read-only. 1.2
range Property > rowHidden Represents if all rows of the current range are hidden. 1.2
range Relationship > sort Represents the range sort of the current range. Read-only. 1.2
range Method > merge(across: bool) Merge the range cells into one region in the worksheet. 1.2
range Method > unmerge() Unmerge the range cells into separate cells. 1.2
rangeFormat Property > columnWidth Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned. 1.2
rangeFormat Property > rowHeight Gets or sets the height of all rows in the range. If the row heights are not uniform null will be returned. 1.2
rangeFormat Relationship > protection Returns the format protection object for a range. Read-only. 1.2
rangeFormat Method > autofitColumns() Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. 1.2
rangeFormat Method > autofitRows() Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns. 1.2
rangeReference Property > address Represents the visible rows of the current range. 1.2
rangeSort Method > apply(fields: SortField, matchCase: bool, hasHeaders: bool, orientation: string, method: string) Perform a sort operation. 1.2
sortField Property > ascending Represents whether the sorting is done in an ascending fashion. 1.2
sortField Property > color Represents the color that is the target of the condition if the sorting is on font or cell color. 1.2
sortField Property > dataOption Represents additional sorting options for this field. Possible values are: Normal, TextAsNumber. 1.2
sortField Property > key Represents the column (or row, depending on the sort orientation) that the condition is on. Represented as an offset from the first column (or row). 1.2
sortField Property > sortOn Represents the type of sorting of this condition. Possible values are: Value, CellColor, FontColor, Icon. 1.2
sortField Relationship > icon Represents the icon that is the target of the condition if the sorting is on the cell's icon. 1.2
table Relationship > sort Represents the sorting for the table. Read-only. 1.2
table Relationship > worksheet The worksheet containing the current table. Read-only. 1.2
table Method > clearFilters() Clears all the filters currently applied on the table. 1.2
table Method > convertToRange() Converts the table into a normal range of cells. All data is preserved. 1.2
table Method > reapplyFilters() Reapplies all the filters currently on the table. 1.2
tableColumn Relationship > filter Retrieve the filter applied to the column. Read-only. 1.2
tableSort Property > matchCase Represents whether the casing impacted the last sort of the table. Read-only. 1.2
tableSort Property > method Represents Chinese character ordering method last used to sort the table. Read-only. Possible values are: PinYin, StrokeCount. 1.2
tableSort Relationship > fields Represents the current conditions used to last sort the table. Read-only. 1.2
tableSort Method > apply(fields: SortField, matchCase: bool, method: string) Perform a sort operation. 1.2
tableSort Method > clear() Clears the sorting that is currently on the table. While this doesn't modify the table's ordering, it clears the state of the header buttons. 1.2
tableSort Method > reapply() Reapplies the current sorting parameters to the table. 1.2
workbook Relationship > functions Represents Excel application instance that contains this workbook. Read-only. 1.2
worksheet Relationship > protection Returns sheet protection object for a worksheet. Read-only. 1.2
worksheetProtection Property > protected Indicates if the worksheet is protected. Read-Only. Read-only. 1.2
worksheetProtection Relationship > options Sheet protection options. Read-only. 1.2
worksheetProtection Method > protect(options: WorksheetProtectionOptions) Protects a worksheet. Fails if the worksheet has been protected. 1.2
worksheetProtection Method > unprotect() Unprotects a worksheet. 1.2
worksheetProtectionOptions Property > allowAutoFilter Represents the worksheet protection option of allowing using auto filter feature. 1.2
worksheetProtectionOptions Property > allowDeleteColumns Represents the worksheet protection option of allowing deleting columns. 1.2
worksheetProtectionOptions Property > allowDeleteRows Represents the worksheet protection option of allowing deleting rows. 1.2
worksheetProtectionOptions Property > allowFormatCells Represents the worksheet protection option of allowing formatting cells. 1.2
worksheetProtectionOptions Property > allowFormatColumns Represents the worksheet protection option of allowing formatting columns. 1.2
worksheetProtectionOptions Property > allowFormatRows Represents the worksheet protection option of allowing formatting rows. 1.2
worksheetProtectionOptions Property > allowInsertColumns Represents the worksheet protection option of allowing inserting columns. 1.2
worksheetProtectionOptions Property > allowInsertHyperlinks Represents the worksheet protection option of allowing inserting hyperlinks. 1.2
worksheetProtectionOptions Property > allowInsertRows Represents the worksheet protection option of allowing inserting rows. 1.2
worksheetProtectionOptions Property > allowPivotTables Represents the worksheet protection option of allowing using PivotTable feature. 1.2
worksheetProtectionOptions Property > allowSort Represents the worksheet protection option of allowing using sort feature. 1.2

Excel JavaScript API 1.1

Excel JavaScript API 1.1 is the first version of the API. For details about the API, see the Excel JavaScript API reference topics.

See also

s Represents the worksheet protection option of allowing inserting columns. 1.2 worksheetProtectionOptions Property > allowInsertHyperlinks Represents the worksheet protection option of allowing inserting hyperlinks. 1.2 worksheetProtectionOptions Property > allowInsertRows Represents the worksheet protection option of allowing inserting rows. 1.2 worksheetProtectionOptions Property > allowPivotTables Represents the worksheet protection option of allowing using PivotTable feature. 1.2 worksheetProtectionOptions Property > allowSort Represents the worksheet protection option of allowing using sort feature. 1.2

Excel JavaScript API 1.1

Excel JavaScript API 1.1 is the first version of the API. For details about the API, see the Excel JavaScript API reference topics.

See also