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

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

  • Статья

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

Примечание.

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

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

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

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

Список API

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

Класс Поля Описание
Application formatStaleValues Указывает, включен или отключен параметр Формат устаревших значений в параметрах вычисления.
Base64EncodedImage data Строка в кодировке Base64.
type Тип файла изображения в кодировке Base64.
BasicCardLayout схема Представляет тип этого макета.
BasicCompactLayout icon Указывает имя значка, который используется для открытия карта.
BasicViewLayouts карта Представляет макет этого значения и его свойства в карта представлении.
компактный Представляет макет, используемый при ограниченном пространстве для представления значения.
BlockedErrorCellValue errorSubType Представляет тип BlockedErrorCellValue.
BooleanCellValue Макеты Представляет сведения о макете для представлений этого логического значения.
properties Представляет дополнительные свойства этого логического значения.
поставщик Представляет сведения, описывающие службу, которая предоставила данные в этом объекте BooleanCellValue.
referencedValues Представляет значения ячеек, на которые ссылается .BooleanCellValue.properties
type Представляет тип этого значения ячейки.
BusyErrorCellValue errorSubType Представляет тип BusyErrorCellValue.
CalcErrorCellValue errorSubType Представляет тип CalcErrorCellValue.
CardLayoutTwoColumnSection схема Представляет тип макета для этого раздела.
Chart getDataRange() Возвращает источник данных для всей диаграммы.
getDataRangeOrNullObject() Возвращает источник данных для всей диаграммы.
ChartDataLabel geometricShapeType Возвращает или задает тип геометрической фигуры метки данных.
getSubstring(start: number, length?: number) Возвращает подстроку метки данных.
getTailAnchor() Возвращает хвостовую привязку метки данных, которая отображается как залипающая выноска.
setHeight(height: number) Задает высоту метки данных в точках.
setWidth(width: number) Задает ширину метки данных в точках.
showAsStickyCallout Возвращает значение, указывающее, отображается ли метка данных в виде выноски с прикрепленной к точке данных хвостовой привязкой.
ChartDataLabelAnchor left Представляет расстояние (в точках) от привязки до левого края метки данных диаграммы.
top Представляет расстояние (в точках) от привязки до верхнего края метки данных диаграммы.
ChartDataLabels geometricShapeType Возвращает или задает тип геометрической фигуры меток данных.
leaderLines Возвращает объект , представляющий линии-лидеры меток данных.
showAsStickyCallout Возвращает значение, указывающее, отображаются ли метки данных в виде выноски с прикрепленной к точке данных хвостовой привязкой.
showLeaderLines Возвращает или задает значение, указывающее, отображаются ли линии-лидеры для меток данных.
ChartLeaderLines format Представляет форматирование линий-лидеров меток данных в ряде.
ChartLeaderLinesFormat line Возвращает объект , представляющий форматирование линий диаграммы.
Comment assignTask(assignee: Excel.EmailIdentity) Назначает задачу, связанную с комментарием, данному пользователю в качестве назначенного.
getTask() Возвращает задачу, связанную с этим комментарием.
getTaskOrNullObject() Возвращает задачу, связанную с этим комментарием.
CommentReply assignTask(assignee: Excel.EmailIdentity) Назначает задачу, связанную с комментарием, данному пользователю в качестве единственного назначаемого.
getTask() Возвращает задачу, связанную с потоком ответа на комментарий.
getTaskOrNullObject() Возвращает задачу, связанную с потоком ответа на комментарий.
ConnectErrorCellValue errorSubType Представляет тип ConnectErrorCellValue.
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 Возвращает дату и время начала задачи.
DoubleCellValue Макеты Представляет сведения о макете для представлений этого двойного значения.
numberFormat Возвращает строку числового формата, используемую для отображения этого значения.
properties Представляет дополнительные свойства этого двойного значения.
поставщик Представляет сведения, описывающие службу, которая предоставила данные в этом объекте DoubleCellValue.
referencedValues Представляет значения ячеек, на которые ссылается .DoubleCellValue.properties
type Представляет тип этого значения ячейки.
EmailIdentity displayName Представляет отображаемое имя пользователя.
email Представляет адрес электронной почты пользователя.
id Представляет уникальный идентификатор пользователя.
EntityArrayCardLayout arrayProperty Представляет имя свойства, содержащего массив, показанный в карта.
columnsToReport Представляет количество столбцов, которые карта утверждения находятся в массиве.
displayName Представляет имя свойства, содержащего массив, показанный в карта.
firstRowIsHeader Представляет, обрабатывается ли первая строка массива как заголовок.
схема Представляет тип этого макета.
rowsToReport Представляет количество строк, в которых карта утверждения находятся в массиве.
EntityCardLayout схема Представляет тип этого макета.
ExternalCodeServiceObjectCellValue Python_str Представляет выходные данные функции при str() использовании в этом объекте.
Python_type Представляет полное имя типа этого объекта.
Python_typeName Представляет короткое имя типа этого объекта.
basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
language Представляет язык среды выполнения этой внешней службы кода.
предварительный просмотр Представляет значение предварительного просмотра, отображаемое в ячейке.
поставщик Представляет сведения о службе, которая предоставила данные в этом объекте ExternalCodeServiceObjectCellValue.
type Представляет тип этого значения ячейки.
Identity displayName Представляет отображаемое имя пользователя.
id Представляет уникальный идентификатор пользователя.
JavaScriptCustomFunctionReferenceCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
functionType Представляет тип FunctionCellValue.
id Представляет идентификатор пользовательской функции.
пространство имен Представляет пространство имен, используемое пользовательской функцией.
type Представляет тип этого значения ячейки.
LinkedDataType dataProvider Имя поставщика данных для связанного типа данных.
lastRefreshed Дата и время локального часового пояса с момента открытия книги при последнем обновлении связанного типа данных.
name Имя связанного типа данных.
periodicRefreshInterval Частота в секундах, с которой обновляется связанный тип данных, если refreshMode задано значение "Периодический".
refreshMode Механизм, с помощью которого извлекаются данные для связанного типа данных.
requestRefresh() Отправляет запрос на обновление связанного типа данных.
requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode) Отправляет запрос на изменение режима обновления для этого связанного типа данных.
serviceId Уникальный идентификатор связанного типа данных.
supportedRefreshModes Возвращает массив со всеми режимами обновления, поддерживаемыми связанным типом данных.
LinkedDataTypeAddedEventArgs serviceId Уникальный идентификатор нового связанного типа данных.
источник Получает источник события.
type Получает тип события.
LinkedDataTypeCollection getCount() Возвращает количество связанных типов данных в коллекции.
getItem(key: number) Возвращает связанный тип данных по идентификатору службы.
getItemAt(index: number) Возвращает связанный тип данных по индексу в коллекции.
getItemOrNullObject(key: number) Возвращает связанный тип данных по идентификатору.
items Получает загруженные дочерние элементы в этой коллекции.
requestRefreshAll() Отправляет запрос на обновление всех связанных типов данных в коллекции.
LinkedEntityDataDomain dataProvider Возвращает имя поставщика данных для домена данных связанной сущности.
delete() Удаляет этот объект из LinkedEntityDataDomainCollection.
id Возвращает идентификатор домена данных связанной сущности, определенного надстройками Office.
lastRefreshed Возвращает дату и время (в локальном часовом поясе) с момента открытия книги и LinkedEntityCellValue последнего обновления объектов этого домена данных связанной сущности.
loadFunctionId Возвращает идентификатор пользовательской функции, вызываемой по запросу для разрешения или обновления LinkedEntityCellValue объектов домена данных связанной сущности, определенного надстройками Office.
name Возвращает имя домена данных связанной сущности.
periodicRefreshInterval Возвращает частоту в секундах, с которой LinkedEntityCellValue объекты этого домена данных связанной сущности обновляются автоматически.
refresh() Обновляет все LinkedEntityCellValue объекты этого домена данных связанной сущности.
refreshMode Возвращает или задает режим обновления, определяющий, как и когда LinkedEntityCellValue обновляются объекты этого домена данных связанной сущности.
serviceId Возвращает идентификатор службы домена данных связанной сущности.
supportedRefreshModes Возвращает все режимы обновления, поддерживаемые доменом данных связанной сущности.
LinkedEntityDataDomainAddedEventArgs id Возвращает идентификатор домена данных связанной сущности, который был только что добавлен в книгу.
serviceId Возвращает идентификатор службы домена данных связанной сущности, который был только что добавлен в книгу.
источник Получает источник события.
type Получает тип события.
LinkedEntityDataDomainCollection add(options: Excel.LinkedEntityDataDomainCreateOptions) Добавляет в коллекцию объект домена данных связанной сущности, определенный надстройкой Office.
getCount() Возвращает количество доменов данных связанных сущностей в коллекции.
getItem(id: string) Получает домен данных связанной сущности по его id.
getItemAt(index: number) Получает домен данных связанной сущности по индексу в коллекции.
getItemByName(name: string) Получает домен данных связанной сущности по его name.
getItemByNameOrNullObject(name: string) Получает домен данных связанной сущности по его name.
getItemOrNullObject(id: строка) Получает домен данных связанной сущности по его id.
items Получает загруженные дочерние элементы в этой коллекции.
onLinkedEntityDataDomainAdded Происходит при добавлении в книгу нового домена данных связанной сущности.
onRefreshCompleted Происходит при выполнении запроса на обновление LinkedEntityCellValue объектов домена данных связанной сущности.
onRefreshModeChanged Происходит при refreshMode изменении домена данных связанной сущности.
refreshAll() Обновляет все LinkedEntityCellValue объекты всех доменов данных связанных сущностей в этой коллекции.
LinkedEntityDataDomainCreateOptions dataProvider Возвращает или задает имя поставщика данных для домена данных связанной сущности.
id Возвращает или задает идентификатор домена данных связанной сущности.
loadFunctionId Возвращает или задает идентификатор пользовательской функции, которая будет вызываться по запросу для разрешения или обновления LinkedEntityCellValue объектов этого домена данных связанной сущности.
name Возвращает или задает имя домена данных связанной сущности.
periodicRefreshInterval Возвращает или задает частоту (в секундах), с которой LinkedEntityCellValue объекты этого домена данных связанной сущности обновляются автоматически.
supportedRefreshModes Возвращает или задает все режимы обновления, поддерживаемые доменом данных связанной сущности.
LinkedEntityDataDomainRefreshCompletedEventArgs errors Возвращает все ошибки, возникающие при запросе на обновление LinkedEntityCellValue объектов домена данных связанной сущности.
id Возвращает идентификатор домена данных связанной сущности, объекты которого LinkedEntityCellValue были обновлены.
Обновленной Возвращает значение true , LinkedEntityCellValue если объекты домена данных связанной сущности были успешно обновлены, в противном случае возвращает значение false.
serviceId Возвращает идентификатор службы домена данных связанной сущности, объекты которого LinkedEntityCellValue были обновлены.
источник Получает источник события.
type Получает тип события.
LinkedEntityDataDomainRefreshModeChangedEventArgs id Возвращает идентификатор домена данных связанной сущности, режим обновления которого был изменен.
refreshMode Возвращает новый режим обновления домена данных связанной сущности.
serviceId Возвращает идентификатор службы домена данных связанной сущности, режим обновления которого был изменен.
источник Получает источник события.
type Получает тип события.
LinkedEntityIdCulture культура Представляет язык и региональные параметры, используемые для создания LinkedEntityCellValue объекта .
entityId Представляет идентификатор, характерный для службы, используемой LinkedEntityCellValue для создания объекта .
LinkedEntityLoadServiceRequest domainId Представляет домен, относящийся к службе, используемой LinkedEntityCellValue для создания объектов.
Объекты Представляет идентификаторы сущностей и язык и региональные параметры загружаемых LinkedEntityCellValue объектов.
LinkedEntityLoadServiceResult Объекты Представляет загруженные LinkedEntityCellValue объекты.
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 getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) Возвращает двухмерный массив, инкапсулирующий данные отображения для шрифта, заливки, границ, выравнивания и других свойств каждой ячейки.
togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode) Задает режим маршалинга Python в формуле Excel =PY.
RangeAreas
RefErrorCellValue errorSubType Представляет тип RefErrorCellValue.
RefreshModeChangedEventArgs refreshMode Режим обновления связанного типа данных.
serviceId Уникальный идентификатор объекта, режим обновления которого был изменен.
источник Получает источник события.
type Получает тип события.
RefreshRequestCompletedEventArgs Обновленной Указывает, успешно ли выполнен запрос на обновление.
serviceId Уникальный идентификатор объекта, запрос на обновление которого был выполнен.
источник Получает источник события.
type Получает тип события.
Предупреждения Массив, содержащий предупреждения, созданные в запросе на обновление.
SettableCellProperties TextRuns Представляет свойство textRuns.
ShapeCollection addLocalImageReference(address: string) Создает ссылку на локальное изображение, хранящееся в адресе ячейки, и отображает ее в виде плавающей фигуры над ячейками.
addSvg(xml: string) Создает изображение SVG (масштабируемая векторная графика) из строки XML и добавляет его на лист.
Slicer nameInFormula Представляет имя среза, используемое в формуле.
setStyle(style: string | SlicerStyle | BuiltInSlicerStyle) Задает стиль, применяемый к срезу.
slicerStyle Стиль, применяемый к срезу.
StringCellValue Макеты Представляет сведения о макете для представлений этого строкового значения.
properties Представляет дополнительные свойства этого строкового значения.
поставщик Представляет сведения, описывающие службу, которая предоставила данные в этом объекте StringCellValue.
referencedValues Представляет значения ячеек, на которые ссылается .StringCellValue.properties
type Представляет тип этого значения ячейки.
Table clearStyle() Изменяет таблицу для использования стиля таблицы по умолчанию.
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 Представляет тип этого значения ячейки.
ValueErrorCellValue errorSubType Представляет тип ValueErrorCellValue.
Workbook externalCodeServiceTimeout Указывает максимальное время (в секундах), выделенное для формулы, которая зависит от завершения внешней службы кода.
getActiveShape() Возвращает активную фигуру в книге.
getActiveShapeOrNullObject() Возвращает активную фигуру в книге.
linkedDataTypes Возвращает коллекцию связанных типов данных, которые являются частью книги.
linkedEntityDataDomains Возвращает коллекцию доменов данных связанных сущностей, доступных в книге.
localImage Возвращает объект, LocalImage связанный с книгой.
showPivotFieldList Указывает, отображается ли область списка полей сводной таблицы на уровне книги.
задачи Возвращает коллекцию задач, присутствующих в книге.
use1904DateSystem Значение true, если в книге используется система дат 1904.
Worksheet onFiltered Происходит при применении фильтра к определенному листу.
showDataTypeIcons Указывает, отображаются ли значки типов данных на листе.
задачи Возвращает коллекцию задач, присутствующих на листе.
WorksheetCollection addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string) Вставляет указанные листы книги в текущую книгу.
onFiltered Возникает при применении любого фильтра листа в книге.
WorksheetFilteredEventArgs type Получает тип события.
worksheetId Возвращает идентификатор листа, на котором применяется фильтр.

См. также