Набор обязательных требований только для API JavaScript для Excel

  • Статья

Набор ExcelApiOnline требований — это специальный набор требований, включающий функции, доступные только для Excel в Интернете. API в этом наборе требований считаются рабочими API (не подверженными незарегистрированному поведению или структурным изменениям) для приложения Excel в Интернете. ExcelApiOnline API-интерфейсы считаются "предварительными" API для других платформ (Windows, Mac, iOS) и не могут поддерживаться ни одной из этих платформ.

Если API в наборе ExcelApiOnline требований поддерживаются на всех платформах, они будут добавлены в следующий выпущенный набор требований (ExcelApi 1.[NEXT]). После того как это новое требование станет общедоступным, эти API-интерфейсы будут удалены из ExcelApiOnline. Это можно рассматривать как аналогичный процесс продвижения API, переходя от предварительной версии к выпуску.

Важно!

ExcelApiOnline — это надмножество последнего нумерованного набора требований.

Важно!

ExcelApiOnline 1.1 — это единственная версия api-интерфейсов, доступных только в сети. Это связано с тем, что Excel в Интернете всегда будет иметь одну версию, доступную пользователям, которая является последней версией.

В следующей таблице представлена краткая сводка по API, в то время как в следующей таблице списка API приведен подробный список текущих ExcelApiOnline API.

Функциональная область Описание Соответствующие объекты
Связанные книги Управление ссылками между книгами, включая поддержку обновления и разрыва ссылок на книги. LinkedWorkbook, LinkedWorkbookCollection
Представления именованных листов Предоставляет программное управление представлениями листов для каждого пользователя. NamedSheetView, NamedSheetViewCollection
События перемещения листа Определите, когда листы перемещаются в коллекции, расположение листа и источник изменения. WorksheetCollection, WorksheetMovedEventArgs
Защита листа Запретить несанкционированным пользователям вносить изменения в указанные диапазоны на листе. WorksheetProtection, AllowEditRange, AllowEditRangeCollection, AllowEditRangeOptions

Так как ExcelApiOnline API поддерживаются только Excel в Интернете, надстройка должна проверка, если набор требований поддерживается перед вызовом этих API. Это позволяет избежать вызова API только в сети на другой платформе.

if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
   // Any API exclusive to the ExcelApiOnline requirement set.
}

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

Важно!

Манифест не может быть указан ExcelApiOnline 1.1 в качестве требования активации. Это недопустимое значение для использования в элементе Set.

Список API

В следующей таблице перечислены API JavaScript для Excel, которые в настоящее время включены в ExcelApiOnline набор требований. Полный список всех API JavaScript для Excel (включая ExcelApiOnline API и ранее выпущенные API) см. в разделе Все API JavaScript для Excel.

Класс Поля Описание
Объект AllowEditRange address Указывает диапазон, связанный с объектом .
delete() Удаляет объект из AllowEditRangeCollection.
isPasswordProtected Указывает, защищен ли объект паролем.
pauseProtection(password?: string) Приостанавливает защиту листа для объекта для пользователя в текущем сеансе.
setPassword(password?: string) Изменяет пароль, связанный с объектом .
заголовок Задает заголовок объекта.
AllowEditRangeCollection add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions) AllowEditRange Добавляет объект на лист.
getCount() Возвращает количество AllowEditRange объектов в коллекции.
getItem(key: string) Возвращает объект по AllowEditRange его заголовку.
getItemAt(index: number) AllowEditRange Возвращает объект по индексу в коллекции.
getItemOrNullObject(key: string) Возвращает объект по AllowEditRange его заголовку.
items Получает загруженные дочерние элементы в этой коллекции.
pauseProtection(password: string) Приостанавливает защиту листа для всех AllowEditRange объектов, найденных на этом листе с заданным паролем для пользователя в текущем сеансе.
AllowEditRangeOptions password Пароль, связанный AllowEditRangeс .
LinkedWorkbook breakLinks() Выполняет запрос на разрыв ссылок, указывающих на связанную книгу.
id Исходный URL-адрес, указывающий на связанную книгу.
refresh() Выполняет запрос на обновление данных, полученных из связанной книги.
LinkedWorkbookCollection breakAllLinks() Разрывает все ссылки на связанные книги.
getItem(key: string) Получает сведения о связанной книге по URL-адресу.
getItemOrNullObject(key: string) Получает сведения о связанной книге по URL-адресу.
items Получает загруженные дочерние элементы в этой коллекции.
refreshAll() Отправляет запрос на обновление всех ссылок книги.
workbookLinksRefreshMode Представляет режим обновления ссылок книги.
NamedSheetView activate() Активирует это представление листа.
delete() Удаляет представление листа с листа.
duplicate(name?: string) Создает копию этого представления листа.
name Возвращает или задает имя представления листа.
NamedSheetViewCollection add(name: string) Создает представление листа с заданным именем.
enterTemporary() Создает и активирует новое временное представление листа.
exit() Выход из текущего активного представления листа.
getActive() Возвращает текущее активное представление листа.
getCount() Возвращает количество представлений листа на этом листе.
getItem(key: string) Возвращает представление листа, используя его имя.
getItemAt(index: number) Возвращает представление листа по индексу в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
TableRowCollection deleteRows(rows: number[] | TableRow[]) Удаление нескольких строк из таблицы.
deleteRowsAt(index: number, count?: number) Удалите указанное количество строк из таблицы, начиная с заданного индекса.
Workbook linkedWorkbooks Возвращает коллекцию связанных книг.
Worksheet NamedSheetViews Возвращает коллекцию представлений листа, присутствующих на листе.
WorksheetProtection allowEditRanges Указывает объект, найденный AllowEditRangeCollection на этом листе.
canPauseProtection Указывает, можно ли приостановить защиту для этого листа.
checkPassword(password?: string) Указывает, можно ли использовать пароль для разблокировки защиты листа.
isPasswordProtected Указывает, защищен ли лист паролем.
isPaused Указывает, приостановлена ли защита листа.
pauseProtection(password?: string) Приостанавливает защиту листа для заданного объекта листа для пользователя в текущем сеансе.
resumeProtection() Возобновляет защиту листа для заданного объекта листа для пользователя в заданном сеансе.
сохраненныепараметры Указывает параметры защиты, сохраненные на листе.
setPassword(password?: string) Изменяет пароль, связанный WorksheetProtection с объектом .
updateOptions(options: Excel.WorksheetProtectionOptions) Измените параметры защиты листа, связанные с WorksheetProtection объектом .
WorksheetProtectionChangedEventArgs allowEditRangesChanged Указывает, изменился ли какой-либо из AllowEditRange объектов.
protectionOptionsChanged Указывает, изменился ли объект WorksheetProtectionOptions .
sheetPasswordChanged Указывает, изменился ли пароль листа.

См. также