Заметка
Доступ к этой странице требует авторизации. Вы можете попробовать войти в систему или изменить каталог.
Доступ к этой странице требует авторизации. Вы можете попробовать сменить директорию.
ExcelApi 1.19 добавляет возможности для диаграмм и фигур, которые помогают лучше визуализировать данные в Excel. Он также включает обновления функции типов данных, такие как поддержка связанных типов данных, нотация точек и расширенные параметры для базовых значений ячеек.
В следующей таблице представлена краткая сводка по API, а в следующей таблице списка API приведен подробный список.
| Функциональная область | Описание | Соответствующие объекты |
|---|---|---|
| Метки диаграммы | Управление внешним видом меток диаграммы. | ChartDataLabel, ChartDataLabelAnchor, ChartLeaderLines, ChartLeaderLinesFormat |
| Связанные объекты | Добавлена поддержка типов данных, подключенных к Excel из внешних источников. Дополнительные сведения см. в статье Создание значений ячеек связанной сущности. | LinkedEntityDataDomain, LinkedEntityDataDomainCollection, LinkedEntityDataDomainCreateOptions, LinkedEntityIdCulture, LinkedEntityLoadServiceRequest |
Список API
В следующей таблице перечислены API в наборе обязательных api JavaScript для Excel 1.19. Справочную документацию по API для всех API, поддерживаемых набором обязательных api JavaScript для Excel 1.19 или более ранней версии, см. в статье Api Excel в наборе требований 1.19 или более ранней версии.
| Класс | Поля | Описание |
|---|---|---|
| BasicCardLayout | схема | Представляет тип этого макета. |
| BasicCompactLayout | icon | Указывает имя значка, который используется для открытия карта. |
| BasicViewLayouts | карта | Представляет макет этого значения и его свойства в карта представлении. |
| компактный | Представляет макет, используемый при ограниченном пространстве для представления значения. | |
| BooleanCellValue | Макеты | Представляет сведения о макете для представлений этого логического значения. |
| properties | Представляет дополнительные свойства этого логического значения. | |
| поставщик | Представляет сведения, описывающие службу, которая предоставила данные в этом объекте BooleanCellValue. |
|
| referencedValues | Представляет значения ячеек, на которые ссылается .BooleanCellValue.properties |
|
| CardLayoutTwoColumnSection | схема | Представляет тип макета для этого раздела. |
| 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 | Возвращает объект , представляющий форматирование линий диаграммы. |
| DoubleCellValue | Макеты | Представляет сведения о макете для представлений этого двойного значения. |
| numberFormat | Возвращает строку числового формата, используемую для отображения этого значения. | |
| properties | Представляет дополнительные свойства этого двойного значения. | |
| поставщик | Представляет сведения, описывающие службу, которая предоставила данные в этом объекте DoubleCellValue. |
|
| referencedValues | Представляет значения ячеек, на которые ссылается .DoubleCellValue.properties |
|
| JavaScriptCustomFunctionReferenceCellValue | basicType | Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes . |
| basicValue | Представляет значение, возвращаемое для ячейки с этим значением Range.values . |
|
| functionType | Представляет тип FunctionCellValue. |
|
| id | Представляет идентификатор пользовательской функции. | |
| пространство имен | Представляет пространство имен, используемое пользовательской функцией. | |
| type | Представляет тип этого значения ячейки. | |
| 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 объекты. |
| Range | getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) | Возвращает двухмерный массив, инкапсулирующий данные отображения для шрифта, заливки, границ, выравнивания и других свойств каждой ячейки. |
| StringCellValue | Макеты | Представляет сведения о макете для представлений этого строкового значения. |
| properties | Представляет дополнительные свойства этого строкового значения. | |
| поставщик | Представляет сведения, описывающие службу, которая предоставила данные в этом объекте StringCellValue. |
|
| referencedValues | Представляет значения ячеек, на которые ссылается .StringCellValue.properties |
|
| Workbook | getActiveShape() | Возвращает активную фигуру в книге. |
| getActiveShapeOrNullObject() | Возвращает активную фигуру в книге. | |
| linkedEntityDataDomains | Возвращает коллекцию доменов данных связанных сущностей, доступных в книге. | |
| Worksheet | showDataTypeIcons | Указывает, отображаются ли значки типов данных на листе. |