Referencia a la biblioteca de la API de JavaScript de Office

  • Artículo

La biblioteca de API de JavaScript de Office proporciona las API que el complemento puede usar para interactuar con la aplicación de Office. La manera más sencilla de hacer referencia a la biblioteca es usar la red de entrega de contenido (CDN) agregando la siguiente <script> etiqueta dentro de la sección de la <head> página HTML.

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

Esto descargará y almacenará en caché los archivos de api de JavaScript de Office la primera vez que se cargue el complemento para asegurarse de que usa la implementación más actualizada de Office.js y sus archivos asociados para la versión especificada.

Importante

Debe hacer referencia a la API de JavaScript de Office desde dentro de la <head> sección de la página para asegurarse de que la API se inicializa por completo antes de los elementos del cuerpo.

Control de versiones de API y compatibilidad con versiones anteriores

En el fragmento de código HTML anterior, delante /1/ de en la dirección URL de office.js la red CDN especifica la versión incremental más reciente dentro de la versión 1 de Office.js. Dado que la API de JavaScript de Office mantiene la compatibilidad con versiones anteriores, la versión más reciente seguirá siendo compatible con los miembros de la API que se introdujeron anteriormente en la versión 1. Si necesita actualizar un proyecto existente, consulte Actualizar la versión de la API de JavaScript de Office y los archivos de esquema de manifiesto.

Si tiene previsto publicar el complemento de Office desde AppSource, debe usar esta referencia de CDN. Las referencias locales solo son adecuadas para escenarios internos, de desarrollo y de depuración.

Nota:

Para usar las API preliminares, haga referencia a la versión preliminar de la biblioteca de la API de JavaScript de Office en la red CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Habilitación de IntelliSense para un proyecto de TypeScript

Además de hacer referencia a la API de JavaScript de Office como se describió anteriormente, también puede habilitar el proyecto de complemento IntelliSense para TypeScript mediante las definiciones de tipo de DefinitelyTyped. Para ello, ejecute el siguiente comando en un símbolo del sistema habilitado para Node (o ventana de Git Bash) desde la raíz de la carpeta del proyecto. Debe tener Node.js instalado (que incluya npm).

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

API de versión preliminar

Las nuevas API de JavaScript se introducen primero en "versión preliminar" y, posteriormente, forman parte de un conjunto de requisitos numerados específico después de que se produzcan pruebas suficientes y se adquieran comentarios del usuario.

Nota:

Las API en versión preliminar están sujetas a cambios y no están pensadas para su uso en un entorno de producción. Le recomendamos que solo las pruebe en entornos de desarrollo y pruebas. No use las API en versión preliminar en un entorno de producción o en documentos críticos para la empresa.

Usar las API en versión preliminar:

Referencias de red CDN para otros entornos de Microsoft 365

21Vianet opera y administra un servicio de Office 365 con tecnologías de Microsoft con licencia para proporcionar servicios de Office 365 para China conforme a las leyes y regulaciones locales. Los complementos desarrollados para su uso en este entorno de nube deben usar la red CDN correspondiente. Use https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js en lugar de la referencia de red CDN estándar. Esto garantiza el cumplimiento continuo y proporciona un mejor rendimiento de los complementos.

Vea también