Información sobre la API de JavaScript para Office

  • Artículo

Un complemento de Office puede usar las API de JavaScript para Office para interactuar con el contenido del documento de Office en el que se ejecuta el complemento.

Acceso a la biblioteca de API de JavaScript de Office

Se puede acceder a la biblioteca de la API de JavaScript de Office a través de la red de entrega de contenido (CDN) de Office JS en: https://appsforoffice.microsoft.com/lib/1.1/hosted/office.js. Para usar las API de JavaScript para Office en cualquiera de las páginas web del complemento, debe hacer referencia a la red CDN en una etiqueta <script> en la etiqueta <head> de la página.

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

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.

Para más información sobre cómo acceder a la biblioteca de API de JavaScript de Office, incluido cómo obtener la característica IntelliSense, consulte Hacer referencia a la biblioteca de la API de JavaScript de Office en la red de entrega de contenido (CDN).

Modelos de API

Las API de JavaScript para Office incluyen dos modelos distintos:

  • Las API específicas de aplicación proporcionan objetos fuertemente tipados que se pueden usar para interactuar con objetos nativos de una aplicación de Office específica. Por ejemplo, puede usar las API de JavaScript de Excel para acceder a hojas de cálculo, rangos, tablas y gráficos, entre otros. Las API específicas de la aplicación están disponibles actualmente para las siguientes aplicaciones de Office.

    Este modelo de API usa promesas y le permite especificar varias operaciones en cada solicitud que envíe a la aplicación de Office. Hacer operaciones por lotes de esta manera puede mejorar considerablemente el rendimiento de complementos en las aplicaciones de Office en la web. Las API específicas de la aplicación se introdujeron con Office 2016.

    Nota:

    También hay una API específica de la aplicación para Visio, pero solo puede usarla en páginas de SharePoint Online para interactuar con diagramas de Visio insertados en la página. Los complementos web de Office no se admiten en Visio.

    Para saber más sobre este modelo de API, consulte Uso del modelo de API específico de la aplicación.

  • Las API comunes se pueden usar para acceder a características como la interfaz de usuario, los cuadros de diálogo y la configuración del cliente, que son comunes a varios tipos de aplicaciones de Office. Este modelo de API usa devoluciones de llamadas, las cuales le permiten especificar solo una operación en cada solicitud enviada a la aplicación de Office. Las API comunes se introdujeron con Office 2013 y se pueden usar para interactuar con cualquier aplicación de Office compatible. Para más información sobre el modelo de objetos de API comunes, que incluye las API para interactuar con Outlook, PowerPoint y Project, consulte Modelo común de objetos de la API de JavaScript.

Nota:

Las funciones personalizadas sin un tiempo de ejecución compartido se ejecutan en un entorno de ejecución solo de JavaScript que prioriza la ejecución de cálculos. Estas funciones usan un modelo de programación ligeramente diferente.

Conjuntos de requisitos de la API

Los conjuntos de requisitos son grupos con nombres de miembros de la API. Los conjuntos de requisitos pueden ser específicos para las aplicaciones de Office, como, por ejemplo, el conjunto de requisitos de ExcelApi 1.7 (un conjunto de API que solo puede usarse en Excel), o comunes para varias aplicaciones, como el conjunto de requisitos de DialogApi 1.1 (un conjunto de API que se puede usar en cualquier aplicación de Office que admita una API de cuadro de diálogo).

El complemento puede usar conjuntos de requisitos para determinar si la aplicación de Office es compatible con los miembros de la API que necesita usar. Para obtener más información, vea Especificar requisitos de la API y aplicaciones de Office.

La compatibilidad del conjunto de requisitos varía en función de la plataforma, de la versión y de la aplicación de Office. Para obtener información detallada sobre las plataformas, los conjuntos de requisitos y las API comunes compatibles con cada aplicación de Office, vea Aplicación cliente de Office y disponibilidad de plataformas para complementos de Office.

Nota:

Si tiene previsto publicar el complemento para AppSource y hacer que esté disponible en la experiencia de Office, asegúrese de que cumple con las Directivas comerciales de certificación de mercado. Por ejemplo, para superar la validación, el complemento debe funcionar en todas las plataformas que sean compatibles con los métodos especificados (para más información, vea la sección 1120.3 y la página de disponibilidad y aplicación del complemento de Office).

Vea también