Referencia a la biblioteca de la API de JavaScript de Office

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

<head>
    ...
    <script src="https://officeapis.public.onecdn.static.microsoft/1/office.js" type="text/javascript"></script>
</head>

Este enfoque descarga y almacena en caché los archivos API de JavaScript de Office la primera vez que se carga el complemento. Garantiza que el complemento use la implementación más actualizada de Office.js y sus archivos asociados para la versión especificada.

La red CDN usa el officeapis.public.onecdn.static.microsoft dominio como parte del dominio unificado para las aplicaciones y servicios de Microsoft 365.

Comportamiento de API web específico de Office.js

Office.js reemplaza los métodos predeterminados de Window.history de replaceState y pushState con null. Si el complemento se basa en estos métodos, reemplace la referencia de biblioteca de Office.js con la siguiente solución.

<script type="text/javascript">
    // Cache the history method values.
    window._historyCache = {
        replaceState: window.history.replaceState,
        pushState: window.history.pushState
    };
</script>

<script type="text/javascript" src="https://officeapis.public.onecdn.static.microsoft/1/office.js"></script>

<script type="text/javascript">
    // Restore the history method values after loading Office.js
    window.history.replaceState = window._historyCache.replaceState;
    window.history.pushState = window._historyCache.pushState;
</script>

Gracias a @stepper y a la comunidad de Stack Overflow por sugerir y comprobar esta solución alternativa.

Control de versiones de API y compatibilidad con versiones anteriores

En el fragmento HTML anterior, el /1/ anterior office.js en la dirección URL de 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 sigue admitiendo miembros de API que se introdujeron anteriormente en la versión 1.

Si tiene previsto publicar su complemento de Office en Microsoft Marketplace, debe usar esta referencia de CDN. Use referencias locales solo para escenarios internos, de desarrollo y de depuración.

Habilitar IntelliSense para un proyecto de TypeScript

Además de hacer referencia a la API de JavaScript de Office como se ha descrito anteriormente, también puede habilitar IntelliSense para un proyecto de complemento de 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 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

Microsoft presenta por primera vez las nuevas API de JavaScript en "versión preliminar". Después de las pruebas y los comentarios de los usuarios, las API pasan a formar parte de un conjunto de requisitos numerados específico.

Referencias de CDN para otros entornos de Microsoft 365

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

Actualizar puntos de conexión de CDN heredados

Anteriormente, la biblioteca de Office.js se servía desde el https://appsforoffice.microsoft.com/lib/1/hosted/office.js punto de conexión. Para cambiar al nuevo punto de conexión de CDN de Office.js, actualice la referencia de script de Office.js en cada página de complemento de https://appsforoffice.microsoft.com/lib/1/hosted/office.js a https://officeapis.public.onecdn.static.microsoft/1/office.js. El nuevo punto de conexión sirve la misma versión de Office.js actual, pero habilita valores predeterminados seguros adicionales. Antes de cambiar:

• Si el complemento se basa en globales de Microsoft Ajax que Office.js cargado previamente automáticamente, reemplace esa dependencia por una alternativa compatible o cargue y administre la biblioteca necesaria directamente.
• Si el complemento usa ExecuteFunction comandos, registre cada controlador de comandos mediante Office.actions.associate(...).
• Si el complemento o la organización usa una configuración restrictiva de Content Security Policy o Trusted Types, compruebe que se permiten el nuevo punto de conexión y Office.js directiva de Trusted Types.
• Asegúrese de que *.static.microsoft está permitido por todas las listas de permitidos de red aplicables.
• Pruebe el complemento en sus aplicaciones y entornos de Office compatibles, incluida la activación, los comandos y los cuadros de diálogo.

Vea también

• Información sobre la API de JavaScript para Office
• API de JavaScript para Office
• Instrucciones para implementar complementos de Office en nubes de administración pública
• Términos de licencia del software de Microsoft para la biblioteca de API de Microsoft Office JavaScript (Office.js)