Edit

Share via

What's new in Excel JavaScript API 1.16

  • Article

The ExcelApi 1.16 added the data types APIs. With the data types APIs, Excel cells can contain images from the web, formatted number values that retain their format throughout calculations, and most notably, entity cards. Entity cards extend the potential of Excel add-ins beyond a 2-dimensional grid. They display an icon within a cell that opens a card modal window in the Excel UI when selected. To learn more, see Use cards with entity value data types.

The following table provides a concise summary of the APIs, while the subsequent API list table gives a detailed list.

Feature area Description Relevant objects
Data types An extension of existing Excel data types, including support for formatted numbers and web images. ArrayCellValue, BooleanCellValue, CellValueAttributionAttributes, CellValueProviderAttributes, DoubleCellValue, EmptyCellValue, EntityCellValue, FormattedNumberCellValue, RootReferenceCellValue, StringCellValue, ValueTypeNotAvailableCellValue, WebImageCellValue
Data types errors Error objects that support expanded data types. BlockedErrorCellValue, BusyErrorCellValue, CalcErrorCellValue, ConnectErrorCellValue, Div0ErrorCellValue, FieldErrorCellValue, GettingDataErrorCellValue, NotAvailableErrorCellValue, NameErrorCellValue, NullErrorCellValue, NumErrorCellValue, PlaceholderErrorCellValue, RefErrorCellValue, SpillErrorCellValue, ValueErrorCellValue
Entity data types and entity cards An entity is a container for data types. Card layout objects manage the display of entity cards. EntityCellValue, EntityCardLayout, EntityPropertyExtraProperties, EntityViewLayouts, CardLayoutListSection, CardLayoutPropertyReference, CardLayoutSectionStandardProperties, CardLayoutStandardProperties, CardLayoutTableSection

API list

The following table lists the APIs in Excel JavaScript API requirement set 1.16. To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.16 or earlier, see Excel APIs in requirement set 1.16 or earlier.

Class Fields Description
ArrayCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
elements Represents the elements of the array.
referencedValues Represents the cell values which are referenced within ArrayCellValue.elements.
type Represents the type of this cell value.
BlockedErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of BlockedErrorCellValue.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
BooleanCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
type Represents the type of this cell value.
BusyErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of BusyErrorCellValue.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
CalcErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of CalcErrorCellValue.
errorType Represents the type of ErrorCellValue.
functionName Represents the name of the function causing the error.
type Represents the type of this cell value.
CardLayoutListSection layout Represents the type of layout for this section.
CardLayoutPropertyReference property Represents the name of the property referenced by the card layout.
CardLayoutSectionStandardProperties collapsed Represents whether this section of the card is initially collapsed.
collapsible Represents whether this section of the card is collapsible.
properties Represents the names of the properties in this section.
title Represents the title of this section of the card.
CardLayoutStandardProperties mainImage Specifies a property which will be used as the main image of the card.
sections Represents the sections of the card.
subTitle Represents a specification of which property contains the subtitle of the card.
title Represents the title of the card or the specification of which property contains the title of the card.
CardLayoutTableSection layout Represents the type of layout for this section.
CellValueAttributionAttributes licenseAddress Represents a URL to a license or source that describes how this property can be used.
licenseText Represents a name for the license that governs this property.
sourceAddress Represents a URL to the source of the CellValue.
sourceText Represents a name for the source of the CellValue.
CellValueExtraProperties writable Represents whether this CellValue will be used to overwrite a cell.
writableNote Represents an explanation about why CellValue.writable is specified as false.
CellValuePropertyMetadata attribution Represents attribution information to describe the source and license requirements for using this property.
excludeFrom Represents which features this property is excluded from.
sublabel Represents the sublabel for this property shown in card view.
CellValuePropertyMetadataExclusions autoComplete True represents that the property is excluded from the properties shown by auto complete.
calcCompare True represents that the property is excluded from the properties used to compare cell values during recalc.
cardView True represents that the property is excluded from the properties shown by card view.
dotNotation True represents that the property is excluded from the properties which can be accessed via the FIELDVALUE function.
CellValueProviderAttributes description Represents the provider description property that is used in card view if no logo is specified.
logoSourceAddress Represents a URL used to download an image that will be used as a logo in card view.
logoTargetAddress Represents a URL that is the navigation target if the user clicks on the logo element in card view.
ChangedEventDetail valueAsJsonAfter Represents the type of value after the change.
valueAsJsonBefore Represents the type of value before the change.
ChartFill getSolidColor() Gets the uniform color fill formatting of a chart element.
ConnectErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of ConnectErrorCellValue.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
Div0ErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
DoubleCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
type Represents the type of this cell value.
EmptyCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
type Represents the type of this cell value.
EntityCardLayout layout Represents the type of this layout.
EntityCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
layouts Represents layout information for views of this entity.
properties Represents the properties of this entity and their metadata.
provider Represents information that describes the service that provided the data in this EntityCellValue.
referencedValues Represents the cell values which are referenced within EntityCellValue.properties.
text Represents the text shown when a cell with this value is rendered.
type Represents the type of this cell value.
EntityCompactLayout icon Specifies the name of the icon which is used to open the card.
EntityPropertyExtraProperties propertyMetadata Represents metadata about the property.
EntityViewLayouts card Represents the layout of this entity in card view.
compact Represents the layout used when there is limited space to represent the entity.
ExternalErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of ExternalErrorCellValue.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
FieldErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of FieldErrorCellValue.
errorType Represents the type of ErrorCellValue.
fieldName Represents the field which was not found by FIELDVALUE.
type Represents the type of this cell value.
FormattedNumberCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
numberFormat Returns the number format string that is used to display this value.
type Represents the type of this cell value.
GettingDataErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
LinkedEntityCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
id Represents the service source that provided the information in this value.
layouts Represents layout information for views of this linked entity.
properties Represents the properties of this linked entity and their metadata.
provider Represents information that describes the service that provided data in this LinkedEntityCellValue.
text Represents the text shown when a cell with this value is rendered.
type Represents the type of this cell value.
LinkedEntityId culture Represents which language culture was used to create this CellValue.
domainId Represents a domain specific to a service used to create the CellValue.
entityId Represents an identifier specific to a service used to create the CellValue.
serviceId Represents which service was used to create the CellValue.
NameErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
NamedItem valueAsJson A JSON representation of the values in this named item.
valueAsJsonLocal A JSON representation of the values in this named item.
NamedItemArrayValues valuesAsJson A JSON representation of the values in this named item array.
valuesAsJsonLocal A JSON representation of the values in this named item array.
NotAvailableErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
NullErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
NumErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of NumErrorCellValue.
errorType Represents the type of ErrorCellValue.
functionName Represents the name of the function causing the error.
type Represents the type of this cell value.
PlaceholderErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorType Represents the type of ErrorCellValue.
target PlaceholderErrorCellValue is used during processing, while data is downloaded.
type Represents the type of this cell value.
Range valuesAsJson A JSON representation of the values in the cells in this range.
valuesAsJsonLocal A JSON representation of the values in the cells in this range.
RangeView valuesAsJson A JSON representation of the values in the cells in this range.
valuesAsJsonLocal A JSON representation of the values in the cells in this range.
RefErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of RefErrorCellValue.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
ReferenceCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
reference Represents the index into the referencedValues properties of cell values such as EntityCellValue and ArrayCellValue.
type Represents the type of this cell value.
RootReferenceCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
type Represents the type of this cell value.
SpillErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
columnCount Represents the number of columns that would spill if there were no #SPILL! error.
errorSubType Represents the type of SpillErrorCellValue.
errorType Represents the type of ErrorCellValue.
rowCount Represents the number of rows that would spill if there were no #SPILL! error.
type Represents the type of this cell value.
StringCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
type Represents the type of this cell value.
TableColumn valuesAsJson A JSON representation of the values in the cells in this table column.
valuesAsJsonLocal A JSON representation of the values in the cells in this table column.
TableColumnCollection addAsJson(index?: number, values?: CellValue[][], name?: string) Adds a new column to the table.
TableRow valuesAsJson A JSON representation of the values in the cells in this table row.
valuesAsJsonLocal A JSON representation of the values in the cells in this table row.
TableRowCollection addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean) Adds one or more rows to the table.
ValueErrorCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
errorSubType Represents the type of ValueErrorCellValue.
errorType Represents the type of ErrorCellValue.
type Represents the type of this cell value.
ValueTypeNotAvailableCellValue basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
type Represents the type of this cell value.
WebImageCellValue address Represents the URL from which the image will be downloaded.
altText Represents the alternate text that can be used in accessibility scenarios to describe what the image represents.
attribution Represents attribution information to describe the source and license requirements for using this image.
basicType Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue Represents the value that would be returned by Range.values for a cell with this value.
provider Represents information that describes the entity or individual who provided the image.
relatedImagesAddress Represents the URL of a webpage with images that are considered related to this WebImageCellValue.
type Represents the type of this cell value.
Workbook getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId) Returns a LinkedEntityCellValue based on the provided LinkedEntityId.

See also