Поделиться через

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

Новые API JavaScript для Excel сначала выпускаются в "предварительной версии", а затем становятся частью определенного нумерованного набора обязательных элементов после выполнения достаточного тестирования и получения отзывов пользователей.

Примечание.

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

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

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

Функциональная область Описание Соответствующие объекты
Задачи документа Превратите комментарии в задачи, назначенные пользователям. DocumentTask, DocumentTaskChange, DocumentTaskChangeCollection, DocumentTaskCollection
Стили таблиц Обеспечивает управление шрифтом, границей, цветом заливки и другими аспектами стилей таблиц. Таблица, сводная таблица, срез

Список API

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

Класс Поля Описание
Application formatStaleValues Указывает, включен или отключен параметр Формат устаревших значений в параметрах вычисления.
AutorunEventCompletedOptions allowEvent Указывает, следует ли разрешить продолжение события.
autorunEventType Указывает тип события автозапуска, которое должно быть завершено, если это разрешено.
message Если это указано, указывает необязательное сообщение об ошибке, если событие не может продолжаться.
Base64EncodedImage data Строка в кодировке Base64.
type Тип файла изображения в кодировке Base64.
Chart getDataRange() Возвращает источник данных для всей диаграммы.
getDataRangeOrNullObject() Возвращает источник данных для всей диаграммы.
Comment assignTask(assignee: Excel.EmailIdentity) Назначает задачу, связанную с комментарием, данному пользователю в качестве назначенного.
getTask() Возвращает задачу, связанную с этим комментарием.
getTaskOrNullObject() Возвращает задачу, связанную с этим комментарием.
CommentReply assignTask(assignee: Excel.EmailIdentity) Назначает задачу, связанную с комментарием, данному пользователю в качестве единственного назначаемого.
getTask() Возвращает задачу, связанную с потоком ответа на комментарий.
getTaskOrNullObject() Возвращает задачу, связанную с потоком ответа на комментарий.
DatetimeFormatInfo shortDateTimePattern Возвращает строку формата для короткого значения даты и времени.
DocumentTask assign(assignee: Excel.EmailIdentity) Добавляет заданного пользователя в список назначенных пользователей, присоединенный к задаче.
Назначенных Возвращает коллекцию назначенных задач.
Изменения Возвращает записи об изменениях задачи.
comment Возвращает комментарий, связанный с задачей.
completedBy Возвращает последнего пользователя, завершив задачу.
completedDateTime Возвращает дату и время завершения задачи.
createdBy Возвращает пользователя, создавшего задачу.
createdDateTime Возвращает дату и время создания задачи.
id Возвращает идентификатор задачи.
percentComplete Указывает процент завершения задачи.
приоритет Указывает приоритет задачи.
startAndDueDateTime Указывает дату и время начала и срока выполнения задачи.
заголовок Задает заголовок задачи.
unassign(assignee: Excel.EmailIdentity) Удаляет заданного пользователя из списка назначенных пользователей, присоединенного к задаче.
unassignAll() Удаляет всех пользователей из списка назначенных, присоединенных к задаче.
DocumentTaskChange правопреемник Представляет пользователя, назначенного задаче для assign действия изменения, или пользователя, не назначенного из задачи для unassign действия изменения.
changedBy Представляет удостоверение пользователя, который изменил задачу.
commentId Представляет идентификатор комментария или ответа примечания, к которому привязано изменение задачи.
createdDateTime Представляет дату и время создания записи изменения задачи.
dueDateTime Представляет дату и время выполнения задачи.
id Уникальный guid изменения задачи.
percentComplete Представляет процент завершения задачи.
приоритет Представляет приоритет задачи.
startDateTime Представляет дату и время начала задачи.
заголовок Представляет название задачи.
type Представляет тип действия записи изменения задачи.
undoChangeId DocumentTaskChange.id Представляет свойство, которое было отменено для undo действия изменения.
DocumentTaskChangeCollection getCount() Возвращает количество записей изменений в коллекции для задачи.
getItemAt(index: number) Получает запись изменения задачи с помощью ее индекса в коллекции.
items Получает загруженные дочерние элементы в этой коллекции.
DocumentTaskCollection getCount() Возвращает количество задач в коллекции.
getItem(key: string) Возвращает задачу, используя ее идентификатор.
getItemAt(index: number) Возвращает задачу по индексу в коллекции.
getItemOrNullObject(key: string) Возвращает задачу, используя ее идентификатор.
items Получает загруженные дочерние элементы в этой коллекции.
DocumentTaskSchedule dueDateTime Возвращает дату и время выполнения задачи.
startDateTime Возвращает дату и время начала задачи.
EmailIdentity displayName Представляет отображаемое имя пользователя.
email Представляет адрес электронной почты пользователя.
id Представляет уникальный идентификатор пользователя.
EntityArrayCardLayout arrayProperty Представляет имя свойства, содержащего массив, показанный в карта.
columnsToReport Представляет количество столбцов, которые карта утверждения находятся в массиве.
displayName Представляет имя свойства, содержащего массив, показанный в карта.
firstRowIsHeader Представляет, обрабатывается ли первая строка массива как заголовок.
схема Представляет тип этого макета.
rowsToReport Представляет количество строк, в которых карта утверждения находятся в массиве.
ExternalCodeServiceObjectCellValue Python_str Представляет выходные данные функции при str() использовании в этом объекте.
Python_type Представляет полное имя типа этого объекта.
Python_typeName Представляет короткое имя типа этого объекта.
basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
language Представляет язык среды выполнения этой внешней службы кода.
предварительный просмотр Представляет значение предварительного просмотра, отображаемое в ячейке.
поставщик Представляет сведения о службе, которая предоставила данные в этом объекте ExternalCodeServiceObjectCellValue.
type Представляет тип этого значения ячейки.
Identity displayName Представляет отображаемое имя пользователя.
id Представляет уникальный идентификатор пользователя.
LocalImage getBase64EncodedImageData(cacheUid: string) Возвращает данные изображения в кодировке Base64, хранящиеся в общем кэше образов, с уникальным идентификатором кэша (UID).
LocalImageCellValue altText Представляет альтернативный текст, используемый в сценариях специальных возможностей для описания того, что представляет изображение.
приписывание Представляет сведения об атрибуции, описывающие требования к источнику и лицензии для этого образа.
basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
image Представляет само изображение, кэшированное или закодированное.
поставщик Представляет сведения, описывающие сущность или физическое лицо, предоставившие изображение.
type Представляет тип этого значения ячейки.
LocalImageCellValueCacheId cachedUid Представляет идентификатор пользовательского интерфейса изображения в том виде, в который он отображается в кэше.
NameErrorCellValue errorSubType Представляет тип NameErrorCellValue.
NamedSheetViewCollection getItemOrNullObject(key: string) Возвращает представление листа, используя его имя.
NotAvailableErrorCellValue errorSubType Представляет тип NotAvailableErrorCellValue.
PivotLayout getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>) Получает уникальную ячейку в сводной таблице на основе иерархии данных и элементов строк и столбцов соответствующих иерархий.
PivotStyle Стиль, применяемый к сводной таблице.
setStyle(style: string | PivotTableStyle | BuiltInPivotTableStyle) Задает стиль, применяемый к сводной таблице.
PivotTable autoRefresh Указывает, обновляется ли сводная таблица автоматически при изменении исходных данных.
PythonErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
Query delete() Удаляет запрос и связанное с ним подключение.
refresh() Обновляет запрос.
QueryCollection refreshAll() Обновите все запросы.
Range togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode) Задает режим маршалинга Python в формуле Excel =PY.
RequestContext setInvocation(invocation: { invocationId: number isInSyncExecution: boolean })
ShapeCollection addLocalImageReference(address: string) Создает ссылку на локальное изображение, хранящееся в адресе ячейки, и отображает ее в виде плавающей фигуры над ячейками.
addSvg(xml: string) Создает изображение SVG (масштабируемая векторная графика) из строки XML и добавляет его на лист.
ShapeFont strikethrough Указывает состояние зачеркиния шрифта.
subscript Указывает состояние подстрочного индекса шрифта.
superscript Указывает надстрочный индекс шрифта.
tintAndShade Указывает двойник, который осветляет или затемняет цвет шрифта диапазона.
Slicer nameInFormula Указывает имя среза, используемое в формуле.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle) Задает стиль, применяемый к срезу.
slicerStyle Стиль, применяемый к срезу.
Table altTextDescription Указывает альтернативный текст для специальных возможностей.
altTextTitle Задает сводку для таблицы, например, используемую средствами чтения с экрана.
clearStyle() Изменяет таблицу для использования стиля таблицы по умолчанию.
comment Указывает комментарий, связанный с таблицей.
isActive Возвращает, активна ли таблица в данный момент.
onFiltered Происходит при применении фильтра к определенной таблице.
setStyle(style: string | TableStyle | BuiltInTableStyle) Задает стиль, применяемый к таблице.
источник Извлекает тип источника данных, из которого исходит таблица.
tableStyle Стиль, применяемый к таблице.
TableCollection onFiltered Происходит при применении фильтра к любой таблице в книге или листе.
TableFilteredEventArgs tableId Возвращает идентификатор таблицы, в которой применяется фильтр.
type Получает тип события.
worksheetId Возвращает идентификатор листа, содержащего таблицу.
TimeoutErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип TimeoutErrorCellValue.
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
Window rangeSelection Возвращает выбранный диапазон в окне.
Workbook autorunEventCompleted(AutorunEventCompletedOptions: Excel.AutorunEventCompletedOptions) Уведомляет ведущее приложение о том, что код надстройки завершен в событии автозапуска.
externalCodeServiceTimeout Указывает максимальное время (в секундах), выделенное для формулы, которая зависит от завершения внешней службы кода.
localImage Возвращает объект, LocalImage связанный с книгой.
showPivotFieldList Указывает, отображается ли область списка полей сводной таблицы на уровне книги.
задачи Возвращает коллекцию задач, присутствующих в книге.
use1904DateSystem Значение true, если в книге используется система дат 1904.
Worksheet onFiltered Происходит при применении фильтра к определенному листу.
задачи Возвращает коллекцию задач, присутствующих на листе.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string) Вставляет указанные листы книги в текущую книгу.
onFiltered Возникает при применении любого фильтра листа в книге.
WorksheetFilteredEventArgs type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором применяется фильтр.

См. также

  • Last updated on