Ссылки на библиотеку API JavaScript для Office

Библиотека API JavaScript для Office предоставляет API- интерфейсы, которые надстройка может использовать для взаимодействия с приложением Office. Самый простой способ сослаться на библиотеку — использовать сеть доставки содержимого (CDN), добавив следующий <script> тег в <head> раздел HTML-страницы.

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

Этот подход скачивает и кэширует файлы API JavaScript для Office при первой загрузке надстройки. Это гарантирует, что надстройка использует самую актуальную реализацию Office.js и связанные с ней файлы для указанной версии.

Важно!

Необходимо ссылаться на API JavaScript для Office из <head> раздела страницы, чтобы убедиться, что API полностью инициализирован перед любыми элементами текста.

поведение веб-API Office.js

Office.js заменяет методы Window.history по умолчанию для replaceState и pushState на null. Если надстройка использует эти методы, замените ссылку на библиотеку Office.js следующим обходным решением.

<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://appsforoffice.microsoft.com/lib/1/hosted/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>

Спасибо @stepper и сообществу Stack Overflow за предложение и проверку этого обходного решения.

Управление версиями API и обратная совместимость

В предыдущем фрагменте /1/office.js HTML в URL-адресе CDN указан последний добавочный выпуск в версии 1 Office.js. Так как API JavaScript для Office поддерживает обратную совместимость, последний выпуск продолжает поддерживать члены API, представленные ранее в версии 1.

Если вы планируете опубликовать надстройку Office в Майкрософт Marketplace, необходимо использовать эту ссылку CDN. Используйте локальные ссылки только для внутренних сценариев, сценариев разработки и отладки.

Примечание.

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

Включение IntelliSense для проекта TypeScript

Помимо ссылки на API JavaScript для Office, как описано ранее, можно также включить IntelliSense для проекта надстройки TypeScript с помощью определений типов из DefinitelyTyped. Для этого выполните следующую команду в системной командной строке с поддержкой узла (или окне git bash) из корневой папки проекта. У вас должен быть установлен Node.js (содержащий npm).

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

Предварительная версия API

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

Примечание.

API предварительной версии могут быть изменены и не предназначены для использования в рабочей среде. Рекомендуется использовать их только в тестовой среде и среде разработки. Не используйте API предварительной версии в рабочей среде или в важных деловых документах.

Чтобы использовать API предварительной версии:

Ссылки cdn для других сред Microsoft 365

21Vianet управляет службой Office 365 на основе лицензированных технологий Майкрософт для предоставления Office 365 услуг для Китая в соответствии с местными законами и нормативными актами. Надстройки, разработанные для использования в этой облачной среде, должны использовать соответствующую сеть CDN. Используйте https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.js вместо стандартной ссылки CDN. Это обеспечивает постоянное соответствие требованиям и обеспечивает более высокую производительность надстроек.

См. также

  • Last updated on