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 application supports APIs that an add-in needs. For more information, see Office versions and requirement sets.
Requirement set availability
Excel add-ins run across multiple versions of Office, including Office 2016 or later on Windows, and Office on the web, Mac, and iPad. The following table lists the Excel requirement sets, the supported Office client applications, and the minimum builds or versions for those applications where applicable.
Note
To use APIs in any of the numbered requirement sets or ExcelApiOnline, you should reference the production library on the Office.js content delivery network (CDN).
For information about using preview APIs, see the Excel JavaScript preview APIs article.
| Requirement set | Office on the web | Office on Windows
|
Office on Windows
|
Office on Mac | Office on iPad |
|---|---|---|---|---|---|
| Preview | Please use the latest Office version to try preview APIs (you may need to join the Microsoft 365 Insider program). | ||||
| ExcelApiOnline | Latest (see requirement set page) | Not applicable | Not applicable | Not applicable | Not applicable |
| ExcelApi 1.17 | Supported | Version 2302 (Build 16130.20332) | Office 2024: Version 2302 (Build 16130.20332) | Version 16.70 (23021201) | Version 16.70 |
| ExcelApi 1.16 | Supported | Version 2208 (Build 15601.20148) | Office 2024: Version 2208 (Build 15601.20148) | Version 16.64 (22081401) | Version 16.66 |
| ExcelApi 1.15 | Supported | Version 2202 (Build 14931.20132) | Office 2024: Version 2202 (Build 14931.20132) | Version 16.58 (22021501) | Version 16.59 |
| ExcelApi 1.14 | Supported | Version 2108 (Build 14326.20508) | Office 2021: Version 2108 (Build 14326.20508) | Version 16.52 (21080801) | Version 16.53 |
| ExcelApi 1.13 | Supported | Version 2102 (Build 13801.20738) | Office 2021: Version 2102 (Build 13801.20738) | Version 16.50 (21061301) | Version 16.50 |
| ExcelApi 1.12 | Supported | Version 2008 (Build 13127.20408) | Office 2021: Version 2008 (Build 13127.20408) | Version 16.40 (20081000) | Version 16.40 |
| ExcelApi 1.11 | Supported | Version 2002 (Build 12527.20470) | Office 2021: Version 2002 (Build 12527.20470) | Version 16.33 (20011301) | Version 16.35 |
| ExcelApi 1.10 | Supported | Version 1907 (Build 11929.20306) | Office 2021: Version 1907 (Build 11929.20306) | Version 16.30 (19101301) | Version 16.0 |
| ExcelApi 1.9 | Supported | Version 1903 (Build 11425.20204) | Office 2021: Version 1903 (Build 11425.20204) | Version 16.24 (19041401) | Version 16.0 |
| ExcelApi 1.8 | Supported | Version 1808 (Build 10730.20102) | Office 2021: Version 1808 (Build 10730.20102) | Version 16.17 (18090901) | Version 16.0 |
| ExcelApi 1.7 | Supported | Version 1801 (Build 9001.2171) | Office 2019: Version 1801 (Build 9001.2171) | Version 16.9 (18011602) | Version 16.0 |
| ExcelApi 1.6 | Supported | Version 1704 (Build 8201.2001) | Office 2019: Version 1704 (Build 8201.2001) | Version 15.36 (17070200) | Version 15.0 |
| ExcelApi 1.5 | Supported | Version 1703 (Build 8067.2070) | Office 2019: Version 1703 (Build 8067.2070) | Version 15.36 (17070200) | Version 15.0 |
| ExcelApi 1.4 | Supported | Version 1701 (Build 7870.2024) | Office 2019: Version 1701 (Build 7870.2024) | Version 15.36 (17070200) | Version 15.0 |
| ExcelApi 1.3 | Supported | Version 1608 (Build 7369.2055) | Office 2019: Version 1608 (Build 7369.2055) | Version 15.27 | Version 15.0 |
| ExcelApi 1.2 | Supported | Version 1601 (Build 6741.2088) | Office 2019: Version 1601 (Build 6741.2088) | Version 15.22 | Version 15.0 |
| ExcelApi 1.1 | Supported | Version 1509 (Build 4266.1001) | Office 2016: Version 1509 (Build 4266.1001) | Version 15.20 | Version 15.0 |
Office versions and build numbers
For more information about Office versions and build numbers, see:
- Version and build numbers of update channel releases for Microsoft 365 clients
- What version of Office am I using?
How to use Excel requirement sets at runtime and in the manifest
Note
This section assumes you're familiar with the overview of requirement sets at Office versions and requirement sets and Specify Office applications and API requirements.
Requirement sets are named groups of API members. An Office Add-in can perform a runtime check or use requirement sets specified in the manifest to determine whether an Office application supports the APIs that the add-in needs.
Checking for requirement set support at runtime
The following code sample shows how to determine whether the Office application where the add-in is running supports the specified API requirement set.
if (Office.context.requirements.isSetSupported('ExcelApi', '1.3')) {
// Perform actions.
}
else {
// Provide alternate flow/logic.
}
Defining requirement set support in the manifest
You can use the Requirements element in the add-in manifest to specify the minimal requirement sets and/or API methods that your add-in requires to activate. If the Office application or platform doesn't support the requirement sets or API methods that are specified in the Requirements element of the manifest, the add-in won't run in that application or platform, and it won't display in the list of add-ins that are shown in My Add-ins. If your add-in requires a specific requirement set for full functionality, but it can provide value even to users on platforms that do not support the requirement set, we recommend that you check for requirement support at runtime as described above, instead of defining requirement set support in the manifest.
The following code sample shows the Requirements element in an add-in manifest which specifies that the add-in should load in all Office client applications that support ExcelApi requirement set version 1.3 or greater.
<Requirements>
<Sets DefaultMinVersion="1.3">
<Set Name="ExcelApi" MinVersion="1.3"/>
</Sets>
</Requirements>