Partager via

Référencement de la bibliothèque de l’API JavaScript Office

  • Article

La bibliothèque d’API JavaScript Office fournit les API que votre complément peut utiliser pour interagir avec l’application Office. Le moyen le plus simple de référencer la bibliothèque consiste à utiliser le réseau de distribution de contenu (CDN) en ajoutant la balise suivante <script> dans la <head> section de votre page HTML.

<head>
    ...
    <script src="https://appsforoffice.microsoft.com/lib/1.1/hosted/office.js" type="text/javascript"></script>
</head>

Cette opération permet de télécharger et de mettre en cache les fichiers d’API JavaScript Office la première fois que votre complément est chargé pour vous assurer qu’il utilise l’implémentation la plus récente de Office.js et ses fichiers associés pour la version spécifiée.

Importante

Vous devez référencer l’API JavaScript Office à partir de la <head> section de la page pour vous assurer que l’API est entièrement initialisée avant tout élément body.

Gestion des versions des API et compatibilité descendante

Dans l’extrait de code HTML précédent, le /1.1/ devant dans office.js l’URL CDN spécifie la dernière version incrémentielle dans la version 1 de Office.js. Étant donné que l’API JavaScript Office maintient la compatibilité descendante, la dernière version continuera à prendre en charge les membres d’API qui ont été introduits précédemment dans la version 1.

Si vous envisagez de publier votre complément Office à partir d’AppSource, vous devez utiliser cette référence CDN. Les références locales sont adaptées uniquement au développement interne et au débogage des scénarios.

Remarque

Pour utiliser les API destinées à la prévisualisation, référencez la version d’évaluation de la bibliothèque de l’interface API JavaScript Office dans le CDN : https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Activation d’IntelliSense pour un projet TypeScript

En plus de référencer l’API JavaScript Office comme décrit précédemment, vous pouvez également activer le projet de complément IntelliSense pour TypeScript à l’aide des définitions de type de DefinitelyTyped. Pour ce faire, exécutez la commande suivante dans une invite système prenant en charge Node (ou une fenêtre git bash) à partir de la racine de votre dossier de projet. Node.js doit être installé (qui inclut npm).

npm install --save-dev @types/office-js

API en préversion

Les nouvelles API JavaScript sont d’abord introduites en « préversion », puis font partie d’un ensemble de conditions requises numérotées spécifiques une fois que des tests suffisants ont été effectués et que les commentaires des utilisateurs ont été obtenus.

Remarque

L’aperçu API peut être modifiés et n’est pas destinés à utiliser dans un environnement de production. Nous vous recommandons de les tester uniquement dans les environnements de test et de développement. N’utilisez pas un aperçu d’API dans un environnement de production ou dans les documents commerciaux importants.

Pour utiliser les API disponibles en préversion :

Références CDN pour d’autres environnements Microsoft 365

21Vianet exploite et gère un service Office 365 alimenté par des technologies Microsoft sous licence pour fournir des services Office 365 pour la Chine conformes aux lois et réglementations locales. Les compléments développés pour une utilisation dans cet environnement cloud doivent utiliser le CDN correspondant. Utilisez https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js au lieu de la référence CDN standard. Cela garantit une conformité continue et offre de meilleures performances de complément.

Voir aussi