Общие сведения об API JavaScript для Office

  • Статья

Надстройка Office может использовать API JavaScript для Office, чтобы взаимодействовать с содержимым документа Office, в котором запущена надстройка.

Доступ к библиотеке API JavaScript для Office

Доступ к библиотеке API JavaScript для Office можно получить через сеть доставки содержимого (CDN) Office JS по адресу https://appsforoffice.microsoft.com/lib/1/hosted/office.js. Чтобы использовать API JavaScript для Office на любой из веб-страниц надстройки, требуется указать ссылку на CDN в теге <script> тега <head> страницы.

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

Примечание.

Чтобы использовать API предварительных версий, требуется указать ссылку на предварительную версию библиотеки API JavaScript для Office в сети CDN: https://appsforoffice.microsoft.com/lib/beta/hosted/office.js.

Дополнительные сведения о доступе к библиотеке API JavaScript для Office, в том числе о способе получения функции IntelliSense, см. в статье Добавление ссылок на библиотеку API JavaScript для Office из сети доставки содержимого (CDN).

Модели API

API JavaScript для Office включает две модели:

  • API-интерфейсы для определенных приложений предоставляют объекты со строгой типизацией, которые можно использовать для взаимодействия с собственными объектами определенных приложений Office. Например, вы можете использовать API JavaScript для Excel с целью доступа к листам, диапазонам, таблицам, диаграммам и т. д. API для конкретных приложений в настоящее время доступны для следующих приложений Office.

    Эта модель API использует обещания и позволяет указывать несколько операций в каждом запросе, отправляемом в приложение Office. Подобные пакетные операции могут значительно повысить производительность надстроек для веб-приложений Office. API для конкретных приложений появились в Office 2016.

    Примечание.

    Существует также API приложения для Visio, но его можно использовать только на страницах SharePoint Online для взаимодействия со схемами Visio, внедренными в страницу. Веб-надстройки Office не поддерживаются в Visio.

    Дополнительные сведения об этой модели API см. в статье Использование модели API для конкретного приложения.

  • Общие API-интерфейсы можно использовать для доступа к таким компонентам, как пользовательский интерфейс, диалоговые окна и параметры клиентов, общие для нескольких типов приложений Office. Эта модель API использует обратные вызовы, позволяющие указывать только одну операцию в каждом запросе, отправляемом в приложение Office. Общие API появились в Office 2013 и могут использоваться для взаимодействия с любыми поддерживаемыми приложениями Office. Подробнее об объектной модели общих API, включающей API для взаимодействия с Outlook, PowerPoint и Project, см. в статье Объектная модель общих API JavaScript.

Примечание.

Пользовательские функции без общей среды выполнения выполняются в среде выполнения, доступной только для JavaScript , которая приоритезирует выполнение вычислений. Эти функции используют несколько иную модель программирования.

Наборы обязательных элементов API

Наборы обязательных элементов — это именованные группы элементов API. Наборы обязательных элементов могут относиться к конкретному приложению Office, например набор обязательных элементов ExcelApi 1.7 (набор API, который можно использовать только в Excel), или быть общими для нескольких приложений, например набор обязательных элементов DialogApi 1.1 (набор API, который можно использовать в любом приложение Office, поддерживающем API диалоговых окон).

Используя наборы обязательных элементов, надстройка может определять, поддерживает ли приложение Office необходимые элементы API. Дополнительные сведения об этом см. в статье Указание приложений Office и обязательных элементов API.

Поддержка набора обязательных элементов зависит от приложения Office, версии и платформы. Подробные сведения о платформах, наборах обязательных элементов и общих API, поддерживаемых каждым приложением Office, см. в статье Доступность клиентских приложений и платформ для надстроек Office.

Примечание.

Если вы планируете опубликовать надстройку в AppSource и Office, она должна соответствовать Политикам сертификации коммерческого рынка.  Например, она должна работать на всех платформах, поддерживающих определенные вами методы. Дополнительные сведения см. в разделе 1120.3 и на странице с информацией о доступности для платформ и приложений Office.

См. также