Entendendo a API JavaScript do Office

  • Artigo

Um suplemento do Office pode usar as APIs JavaScript para Office para interagir com o conteúdo no documento do Office no qual o documento está sendo executado.

Acessando a biblioteca da API JavaScript do Office

A biblioteca da API JavaScript do Office pode ser acessada por meio da CDN (rede de entrega de conteúdo) do Office JS em: https://appsforoffice.microsoft.com/lib/1/hosted/office.js. Para usar as APIs JavaScript para Office em qualquer uma das páginas da Web do seu suplemento, você deve fazer referência à CDN em uma tag <script> na tag <head> da página.

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

Observação

Para usar APIs de visualização, faça referência à versão de visualização da biblioteca da API JavaScript do Office na CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Para obter mais informações sobre como acessar a biblioteca da API JavaScript do Office, incluindo como obter o IntelliSense, consulte Fazendo referência à biblioteca da API JavaScript do Office a partir de sua CDN (rede de distribuição de conteúdo).

Modelos de API

A API JavaScript do Office inclui dois modelos diferentes:

  • As APIs específicas do aplicativo fornecem objetos fortemente tipados que podem ser usados para interagir com objetos que são nativos de um aplicativo específico do Office. Por exemplo, você pode usar as APIs JavaScript do Excel para acessar planilhas, intervalos, tabelas, gráficos e mais. As APIs específicas do aplicativo estão disponíveis atualmente para os seguintes aplicativos do Office.

    Esse modelo de API usa promessas e permite que você especifique várias operações em cada solicitação enviada ao aplicativo do Office. Dessa maneira, operações de envio em lote podem melhorar significativamente o desempenho do suplemento em aplicativos do Office na Web. APIs específicas do aplicativo foram introduzidas com o Office 2016.

    Observação

    Há também uma API específica do aplicativo para o Visio, mas você pode usá-la apenas em páginas do SharePoint Online para interagir com diagramas do Visio que foram inseridos na página. Não há suporte para suplementos web do Office no Visio.

    Confira Usando o modelo de API específico do aplicativo para saber mais sobre esse modelo de API.

  • As APIs Comuns pode ser usada para acessar recursos como interface de usuário, caixas de diálogo e configurações de cliente, que são comuns entre vários tipos de aplicativos do Office. Esse modelo de API usa retornos de chamada, que permitem especificar apenas uma operação em cada solicitação enviada ao aplicativo do Office. As APIs comuns foram introduzidas com o Office 2013 e podem ser usadas para interagir com todos os aplicativos do Office com suporte. Para saber mais sobre o modelo de objeto da API Comum, que inclui APIs para interagir com o Outlook, o PowerPoint e o Project, confira Modelo de objeto da API JavaScript comum.

Observação

Funções personalizadas sem uma execução de runtime compartilhado em um runtime somente JavaScript que prioriza a execução de cálculos. Essas funções usam um modelo de programação ligeiramente diferente.

Conjuntos de requisitos da API

Os conjuntos de requisitos são grupos nomeados de membros da API. Os conjuntos de requisitos podem ser específicos para os aplicativos do Office, como o conjunto de requisitos ExcelApi 1.7 (um conjunto de APIs que só podem ser usadas no Excel) ou comuns a vários aplicativos, como o conjunto de requisitos DialogApi 1.1 (um conjunto de APIs que podem ser usadas em qualquer aplicativo do Office que forneça suporte à API de Caixa de Diálogo).

Seu suplemento pode usar conjuntos de requisitos para determinar se o aplicativo do Office oferece suporte aos membros da API necessários. Para saber mais sobre isso, confira Especificar requisitos de API e aplicativos do Office.

O suporte a um conjunto de requisitos varia de acordo com o aplicativo do Office, a versão e a plataforma. Para obter informações detalhadas sobre as plataformas, os conjuntos de requisitos e as APIs comuns compatíveis com cada aplicativo do Office, confira Disponibilidade de aplicativo e plataforma do cliente Office para Suplementos do Office.

Observação

Se você planeja publicar o seu suplemento no AppSource e disponibilizá-lo na experiência do Office, certifique-se de que está em conformidade com as políticas de certificação do Marketplace Comercial. Por exemplo, para passar na validação, o suplemento deve funcionar em todas as plataformas com suporte para os métodos definidos (saiba mais na seção 1120.3 e na página de aplicativo e disponibilidade do Suplemento do Office).

Confira também