Microsoft Office Add-ins API Reference Documentation
Clone or download

README.md

Excel JavaScript API Open Specification

Applies to: Excel 2016, Excel Online, Excel for iOS, Excel for Mac

This page describes the new set of Excel JavaScript APIs that are planned for future releases. It consists of APIs that are in beta stage and others that are still in the design phase. Please review and provide your feedback. One of the best ways you can provide input is to open a new issue in GitHub using the links available below.

Note: The following features are still under design and review phase and not yet available as part of the product. The final design is subject to change. Once the feature is made available, the final specification will be published as part of the master repository.

Note: Any API that is listed as beta is not ready for production usage. They are made available so that developers can 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 Office and use the Beta library of the CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js. Entries 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

Announcements

1.8 was released to GA during Ignite, September 24th, 2018. Check our all the details in our documentation.

New Beta APIs are ready for critique.

What’s new in the Excel JavaScript Beta?

Here is a summary of the APIs and relevant pointers for content. Please give it a try and open issues with your feedback.

Included in this release are more than 400 new APIs for Excel, please refer to a detailed list here.

Feature Area Description Relevant Objects/Articles
Shapes Insert, position and format Images, Geometric Shapes and Text boxes. ShapeCollection Shape GeometricShape Image
New Charts Explore our new supported chart types: maps, box and whisker, waterfall, sunburst, pareto and funnel Chart
Auto Filter Add filters to ranges, sort, etc. Autofilter Range
Areas Finally, on the API we support discontinuous ranges! RangeAreas
Special Cells Get cells containing dates, comments, formulas, etc. within a range. Range
Find Find values or formulas within a range or worksheet. Range Worksheet
Copy Paste Copy values,formats and formulas from one range to the other Range
RangeFormat New RangeFormat Capabilities Range
Workbook Save, Close Save and close workbooks Workbook
Filter Events Get a trigger when users filter a range AutoFilter
Data Change events We added old value/new value information to our change events Range
Insert Workbook Insert one workbook within another Workbook
Calculation Iterative calculation, suspend calculation among other calculation proeprties Application

Give us feedback!

We need it, you want to give it. Feedback is much easier to give now that we're on GitHub. Check out the docs and let us know your thoughts by submitting issues directly in this repository.

For API support, you can post questions to the community on StackOverflow and tag them with [office-js].