PowerPoint JavaScript API requirement sets

Article
10/29/2024

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.

The following table lists the PowerPoint requirement sets, the supported Office client applications, and the minimum builds or versions for those applications where applicable.

Requirement set	Office on the web	Office on Windows Microsoft 365 subscription retail perpetual	Office on Windows volume-licensed perpetual	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).
PowerPointApi 1.6	Supported	Version 2410 (Build 18129.20030)	Not available	Version 16.90 (24101387)	Not available
PowerPointApi 1.5	Supported	Version 2208 (Build 15601.20230)	Office 2024: Version 2208 (Build 15601.20230)	Version 16.64 (22080400)	Not available
PowerPointApi 1.4	Supported	Version 2207 (Build 15330.20122)	Office 2024: Version 2207 (Build 15330.20122)	Version 16.62 (22061100)	Not available
PowerPointApi 1.3	Supported	Version 2111 (Build 14701.20060)	Office 2024: Version 2111 (Build 14701.20060)	Version 16.55 (21111400)	Not available
PowerPointApi 1.2	Supported	Version 2011 (Build 13426.20184)	Office 2021: Version 2011 (Build 13426.20184)	Version 16.43 (20110804)	Not available
PowerPointApi 1.1	Supported	Version 1810 (Build 11001.20074)	Office 2021: Version 1810 (Build 11001.20074)	Version 16.19 (18110915)	Version 2.17

Office versions and build numbers

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

PowerPoint JavaScript API 1.1

PowerPoint JavaScript API 1.1 contains a single API to create a new presentation. For details about the API, see Create a presentation.

PowerPoint JavaScript API 1.2

PowerPoint JavaScript API 1.2 adds support for inserting slides from another PowerPoint presentation into the current presentation and for deleting slides. For details about the APIs, see Insert and delete slides in a PowerPoint presentation.

PowerPoint JavaScript API 1.3

PowerPoint JavaScript API 1.3 adds additional support for adding and deleting slides. It also lets add-ins apply custom metadata tags. For details about the APIs, see Add and delete slides in PowerPoint and Use custom tags for presentations, slides, and shapes in PowerPoint.

PowerPoint JavaScript API 1.4

PowerPoint JavaScript API 1.4 adds additional support for adding, moving, sizing, formatting, and deleting shapes. For more information about using these APIs, see Working with shapes.

PowerPoint JavaScript API 1.5

PowerPoint JavaScript API 1.5 includes APIs to get and manage existing hyperlinks within presentations. For more information, see PowerPoint JavaScript API requirement set 1.5.

PowerPoint JavaScript API 1.6

PowerPoint JavaScript API 1.6 includes APIs to select slides, text ranges, and shapes within presentations. For more information, see PowerPoint JavaScript API requirement set 1.6.

How to use PowerPoint 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('PowerPointApi', '1.1')) {
  // 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 don't 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 PowerPointApi requirement set version 1.1 or greater.

<Requirements>
   <Sets DefaultMinVersion="1.1">
      <Set Name="PowerPointApi" MinVersion="1.1"/>
   </Sets>
</Requirements>

Office Common API requirement sets

Most of the PowerPoint add-in functionality comes from the Common API set. For information about Common API requirement sets, see Office Common API requirement sets.

Share via