Новые возможности API JavaScript для Excel 1.16

  • Статья

В ExcelApi 1.16 добавлены API типов данных. С помощью API типов данных ячейки Excel могут содержать изображения из Интернета, отформатированные числовые значения , которые сохраняют свой формат во время вычислений, и, в частности, карточки сущностей. Карточки сущностей расширяют возможности надстроек Excel за пределами двухмерной сетки. Они отображают значок в ячейке, которая открывает модальное окно карточки в пользовательском интерфейсе Excel при выборе. Дополнительные сведения см. в статье Использование карточек с типами данных значений сущностей.

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

Функциональная область Описание Соответствующие объекты
Типы данных Расширение существующих типов данных Excel, включая поддержку форматированных чисел и веб-изображений. ArrayCellValue, BooleanCellValue, CellValueAttributionAttributes, CellValueProviderAttributes, DoubleCellValue, EmptyCellValue, EntityCellValue, FormattedNumberCellValue, RootReferenceCellValue, StringCellValue, ValueTypeNotAvailableCellValue, WebImageCellValue
Ошибки типов данных Объекты ошибок, поддерживающие расширенные типы данных. BlockedErrorCellValue, BusyErrorCellValue, CalcErrorCellValue, ConnectErrorCellValue, Div0ErrorCellValue, FieldErrorCellValue, GettingDataErrorCellValue, NotAvailableErrorCellValue, NameErrorCellValue, NullErrorCellValue, NumErrorCellValue, PlaceholderErrorCellValue, RefErrorCellValue, SpillErrorCellValue, SpillErrorCellValue, ValueErrorCellValue
Типы данных сущностей и карточки сущностей Сущность — это контейнер для типов данных. Объекты макета карточки управляют отображением карточек сущностей. EntityCellValue, EntityCardLayout, EntityPropertyExtraProperties, EntityViewLayouts, CardLayoutListSection, CardLayoutPropertyReference, CardLayoutSectionStandardProperties, CardLayoutStandardProperties, CardLayoutTableSection

Список API

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

Класс Поля Описание
ArrayCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
Элементы Представляет элементы массива.
referencedValues Представляет значения ячеек, на которые ссылается .ArrayCellValue.elements
type Представляет тип этого значения ячейки.
BlockedErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип BlockedErrorCellValue.
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
BooleanCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
type Представляет тип этого значения ячейки.
BusyErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип BusyErrorCellValue.
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
CalcErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип CalcErrorCellValue.
errorType Представляет тип ErrorCellValue.
functionName Представляет имя функции, вызывающей ошибку.
type Представляет тип этого значения ячейки.
CardLayoutListSection Макет Представляет тип макета для этого раздела.
CardLayoutPropertyReference property Представляет имя свойства, на которое ссылается макет карточки.
CardLayoutSectionStandardProperties Рухнул Указывает, будет ли этот раздел карточки изначально свернут.
Складной Указывает, является ли этот раздел карточки сворачиваемым.
properties Представляет имена свойств в этом разделе.
заголовок Представляет заголовок этого раздела карточки.
CardLayoutStandardProperties mainImage Указывает свойство, которое будет использоваться в качестве основного изображения карточки.
sections Представляет разделы карточки.
Субтитров Представляет спецификацию свойства, которое содержит подзаголовок карточки.
заголовок Представляет название карточки или спецификацию, свойство которой содержит заголовок карточки.
CardLayoutTableSection Макет Представляет тип макета для этого раздела.
CellValueAttributionAttributes licenseAddress Представляет URL-адрес лицензии или источника, описывающий способ использования этого свойства.
licenseText Представляет имя лицензии, которая управляет этим свойством.
sourceAddress Представляет URL-адрес источника CellValue.
sourceText Представляет имя источника CellValue.
CellValueExtraProperties Записываемый Указывает, будет ли она CellValue использоваться для перезаписи ячейки.
writableNote Представляет объяснение о том, почему CellValue.writable задано значение false.
CellValuePropertyMetadata Атрибуции Представляет сведения об атрибутах, описывающие требования к источнику и лицензии для использования этого свойства.
excludeFrom Представляет признаки, из которых исключается это свойство.
вложенная метка Представляет вложенную метку для этого свойства, отображаемую в представлении карточки.
CellValuePropertyMetadataExclusions Автозаполнения Значение True означает, что свойство исключается из свойств, отображаемых автоматическим завершением.
calcCompare Значение True означает, что свойство исключается из свойств, используемых для сравнения значений ячеек во время повторного вычисления.
cardView Значение True означает, что свойство исключается из свойств, отображаемых в представлении карточек.
dotNotation Значение True означает, что свойство исключается из свойств, доступ к которым можно получить с помощью функции FIELDVALUE.
CellValueProviderAttributes description Представляет свойство provider description, которое используется в представлении карточки, если логотип не указан.
logoSourceAddress Представляет URL-адрес, используемый для загрузки изображения, которое будет использоваться в качестве логотипа в представлении карточки.
logoTargetAddress Представляет URL-адрес, который является целевым объектом навигации, если пользователь щелкает элемент логотипа в представлении карточки.
ChangedEventDetail valueAsJsonAfter Представляет тип значения после изменения.
valueAsJsonBefore Представляет тип значения перед изменением.
ChartFill getSolidColor() Возвращает равномерное форматирование цветовой заливки элемента диаграммы.
ConnectErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип ConnectErrorCellValue.
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
Div0ErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
DoubleCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
type Представляет тип этого значения ячейки.
EmptyCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
type Представляет тип этого значения ячейки.
EntityCardLayout Макет Представляет тип этого макета.
EntityCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
Макеты Представляет сведения о макете для представлений этой сущности.
properties Представляет свойства этой сущности и ее метаданные.
Поставщика Представляет сведения, описывающие службу, которая предоставила данные в этом объекте EntityCellValue.
referencedValues Представляет значения ячеек, на которые ссылается .EntityCellValue.properties
text Представляет текст, отображаемый при отображении ячейки с этим значением.
type Представляет тип этого значения ячейки.
EntityCompactLayout icon Указывает имя значка, используемого для открытия карточки.
EntityPropertyExtraProperties Propertymetadata Представляет метаданные о свойстве .
EntityViewLayouts Карте Представляет макет этой сущности в представлении карточки.
Компактный Представляет макет, используемый при ограниченном пространстве для представления сущности.
ExternalErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип ExternalErrorCellValue.
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
FieldErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип FieldErrorCellValue.
errorType Представляет тип ErrorCellValue.
Fieldname Представляет поле, которое не было найдено полем FIELDVALUE.
type Представляет тип этого значения ячейки.
FormattedNumberCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
numberFormat Возвращает строку числового формата, используемую для отображения этого значения.
type Представляет тип этого значения ячейки.
GettingDataErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
LinkedEntityCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
cardLayout Представляет макет этой связанной сущности в представлении карточки.
id Представляет источник службы, предоставив сведения в этом значении.
properties Представляет свойства этой связанной сущности и ее метаданные.
Поставщика Представляет сведения, описывающие службу, которая предоставила данные в этом объекте LinkedEntityCellValue.
text Представляет текст, отображаемый при отображении ячейки с этим значением.
type Представляет тип этого значения ячейки.
LinkedEntityId Культуры Представляет язык и региональные параметры, используемые для создания этого CellValue.
domainId Представляет домен, относящийся к службе, используемой CellValueдля создания .
entityId Представляет идентификатор, относящийся к службе, используемой CellValueдля создания .
serviceId Представляет, какая служба использовалась для создания CellValue.
NameErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
NamedItem valueAsJson Представление значений в этом именованном элементе в формате JSON.
valueAsJsonLocal Представление значений в этом именованном элементе в формате JSON.
NamedItemArrayValues valuesAsJson Представление значений в массиве именованных элементов в формате JSON.
valuesAsJsonLocal Представление значений в массиве именованных элементов в формате JSON.
NotAvailableErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
NullErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
NumErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип NumErrorCellValue.
errorType Представляет тип ErrorCellValue.
functionName Представляет имя функции, вызывающей ошибку.
type Представляет тип этого значения ячейки.
PlaceholderErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorType Представляет тип ErrorCellValue.
конечный объект PlaceholderErrorCellValue используется во время обработки при скачивании данных.
type Представляет тип этого значения ячейки.
Range valuesAsJson Представление значений в ячейках в этом диапазоне в формате JSON.
valuesAsJsonLocal Представление значений в ячейках в этом диапазоне в формате JSON.
RangeView valuesAsJson Представление значений в ячейках в этом диапазоне в формате JSON.
valuesAsJsonLocal Представление значений в ячейках в этом диапазоне в формате JSON.
RefErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип RefErrorCellValue.
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
ReferenceCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
reference Представляет индекс в referencedValues свойствах значений ячеек, таких как EntityCellValue и ArrayCellValue.
type Представляет тип этого значения ячейки.
RootReferenceCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
type Представляет тип этого значения ячейки.
SpillErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
columnCount Представляет количество столбцов, которые будут размыкаться, если бы не было #SPILL! Ошибка.
errorSubType Представляет тип SpillErrorCellValue.
errorType Представляет тип ErrorCellValue.
Rowcount Представляет количество строк, которые могут разлиться, если бы не было #SPILL! Ошибка.
type Представляет тип этого значения ячейки.
StringCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
type Представляет тип этого значения ячейки.
TableColumn valuesAsJson Представление значений в ячейках в этом столбце таблицы в формате JSON.
valuesAsJsonLocal Представление значений в ячейках в этом столбце таблицы в формате JSON.
TableColumnCollection addAsJson(index?: number, values?: CellValue[][], name?: string) Добавляет новый столбец в таблицу.
TableRow valuesAsJson Представление значений в ячейках в этой строке таблицы в формате JSON.
valuesAsJsonLocal Представление значений в ячейках в этой строке таблицы в формате JSON.
TableRowCollection addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean) Добавляет одну или несколько строк в таблицу.
ValueErrorCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
errorSubType Представляет тип ValueErrorCellValue.
errorType Представляет тип ErrorCellValue.
type Представляет тип этого значения ячейки.
ValueTypeNotAvailableCellValue basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
type Представляет тип этого значения ячейки.
WebImageCellValue address Представляет URL-адрес, по которому будет загружено изображение.
altText Представляет альтернативный текст, который можно использовать в сценариях специальных возможностей для описания того, что представляет изображение.
Атрибуции Представляет сведения об атрибуции, описывающие требования к источнику и лицензии для использования этого образа.
basicType Представляет значение, возвращаемое для ячейки с этим значением Range.valueTypes .
basicValue Представляет значение, возвращаемое для ячейки с этим значением Range.values .
Поставщика Представляет сведения, описывающие сущность или физическое лицо, предоставившие изображение.
relatedImagesAddress Представляет URL-адрес веб-страницы с изображениями, которые считаются связанными с этим WebImageCellValue.
type Представляет тип этого значения ячейки.
Workbook getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId) Возвращает на LinkedEntityCellValue основе предоставленного LinkedEntityId.

См. также