Новые возможности API JavaScript для Excel 1.16
В ExcelApi 1.16 добавлены API типов данных. С помощью API типов данных ячейки Excel могут содержать изображения из Интернета, отформатированные числовые значения , которые сохраняют свой формат во время вычислений, и, в частности, карточки сущностей. Карточки сущностей расширяют возможности надстроек Excel за пределами двухмерной сетки. Они отображают значок в ячейке, которая при выборе открывает модальное окно карта в пользовательском интерфейсе Excel. Дополнительные сведения см. в статье Использование карточек с типами данных значений сущностей.
В следующей таблице представлена краткая сводка по API, а в следующей таблице списка API приведен подробный список.
Список 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 | Указывает свойство, которое будет использоваться в качестве main изображения карта. |
sections | Представляет разделы карта. | |
подзаголовок | Представляет спецификацию свойства, которое содержит подзаголовок карта. | |
заголовок | Представляет заголовок карта или спецификацию свойства, которое содержит заголовок карта. | |
CardLayoutTableSection | схема | Представляет тип макета для этого раздела. |
CellValueAttributionAttributes | licenseAddress | Представляет URL-адрес лицензии или источника, описывающий способ использования этого свойства. |
licenseText | Представляет имя лицензии, которая управляет этим свойством. | |
sourceAddress | Представляет URL-адрес источника CellValue . |
|
sourceText | Представляет имя источника CellValue . |
|
CellValueExtraProperties | Записываемый | Указывает, будет ли она CellValue использоваться для перезаписи ячейки. |
writableNote | Представляет объяснение о том, почему CellValue.writable задано значение false. |
|
CellValuePropertyMetadata | приписывание | Представляет сведения об атрибутах, описывающие требования к источнику и лицензии для использования этого свойства. |
excludeFrom | Представляет признаки, из которых исключается это свойство. | |
вложенная метка | Представляет вложенную метку для этого свойства, показанную в представлении карта. | |
CellValuePropertyMetadataExclusions | autoComplete | Значение 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 . |
|
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 . |
См. также
Office Add-ins