This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
The ExcelApi 1.19 adds capabilities for charts and shapes, to help you better visualize your data in Excel. It also includes updates to the data types feature, such as support forlinked data types,dot notation, and expanded options forbasic cell values.
The following table provides a concise summary of the APIs, while the subsequentAPI list table gives a detailed list.
| Feature area | Description | Relevant objects |
|---|---|---|
| Chart labels | Control the appearance of chart labels. | ChartDataLabel,ChartDataLabelAnchor,ChartLeaderLines,ChartLeaderLinesFormat |
| Linked data types | Adds support for data types connected to Excel from external sources. To learn more, seeCreate linked entity cell values | LinkedDataType,LinkedDataTypeAddedEventArgs,LinkedDataTypeCollection |
The following table lists the APIs in Excel JavaScript API requirement set 1.19. To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.19 or earlier, seeExcel APIs in requirement set 1.19 or earlier.
| Class | Fields | Description |
|---|---|---|
| BasicCardLayout | layout | Represents the type of this layout. |
| BasicCompactLayout | icon | Specifies the name of the icon which is used to open the card. |
| BasicViewLayouts | card | Represents the layout of this value and its properties in card view. |
| compact | Represents the layout used when there is limited space to represent the value. | |
| BooleanCellValue | layouts | Represents layout information for views of this Boolean value. |
| properties | Represents additional properties of this Boolean value. | |
| provider | Represents information that describes the service that provided the data in thisBooleanCellValue. | |
| referencedValues | Represents the cell values which are referenced withinBooleanCellValue.properties. | |
| CardLayoutTwoColumnSection | layout | Represents the type of layout for this section. |
| ChartDataLabel | geometricShapeType | Specifies the geometric shape type of the data label. |
| getSubstring(start: number, length?: number) | Returns a substring of the data label. | |
| getTailAnchor() | Returns the tail anchor of the data label which is shown as a sticky callout. | |
| setHeight(height: number) | Sets the height of the data label in points. | |
| setWidth(width: number) | Sets the width of the data label in points. | |
| showAsStickyCallout | Specifies if the data label is shown as a callout with the tail anchor attached to the data point. | |
| ChartDataLabelAnchor | left | Specifies the distance, in points, from the anchor to the left edge of the chart data label. |
| top | Specifies the distance, in points, from the anchor to the top edge of the chart data label. | |
| ChartDataLabels | geometricShapeType | Specifies the geometric shape type of the data labels. |
| leaderLines | Gets an object that represents the leader lines of the data labels. | |
| showAsStickyCallout | Specifies if the data labels are shown as a callout with the tail anchor attached to the data point. | |
| showLeaderLines | Specifies if leader lines are displayed for the data labels. | |
| ChartLeaderLines | format | Represents the formatting of leader lines of data labels in a series. |
| ChartLeaderLinesFormat | line | Gets an object that represents the line formatting of chart leader lines. |
| DoubleCellValue | layouts | Represents layout information for views of this double value. |
| numberFormat | Returns the number format string that is used to display this value. | |
| properties | Represents additional properties of this double value. | |
| provider | Represents information that describes the service that provided the data in thisDoubleCellValue. | |
| referencedValues | Represents the cell values which are referenced withinDoubleCellValue.properties. | |
| EntityCompactLayout | icon | Specifies the name of the icon which is used to open the card. |
| FormattedNumberCellValue | basicType | Represents the value that would be returned byRange.valueTypes for a cell with this value. |
| basicValue | Represents the value that would be returned byRange.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. | |
| JavaScriptCustomFunctionReferenceCellValue | basicType | Represents the value that would be returned byRange.valueTypes for a cell with this value. |
| basicValue | Represents the value that would be returned byRange.values for a cell with this value. | |
| functionType | Represents the type ofFunctionCellValue. | |
| id | Represents the ID of the custom function. | |
| namespace | Represents the namespace used by the custom function. | |
| type | Represents the type of this cell value. | |
| LinkedEntityDataDomain | dataProvider | Gets the name of the data provider for the linked entity data domain. |
| delete() | Deletes this object from theLinkedEntityDataDomainCollection. | |
| id | Gets the ID of the linked entity data domain defined by Office Add-ins. | |
| lastRefreshed | Gets the date and time (in the local time zone) since the workbook was opened and theLinkedEntityCellValue objects of this linked entity data domain were last refreshed. | |
| loadFunctionId | Gets the ID of the custom function that is called on demand to resolve or refresh theLinkedEntityCellValue objects of the linked entity data domain defined by Office Add-ins. | |
| name | Gets the name of the linked entity data domain. | |
| periodicRefreshInterval | Gets the frequency, in seconds, at whichLinkedEntityCellValue objects of this linked entity data domain are refreshed automatically. | |
| refresh() | Refreshes allLinkedEntityCellValue objects of this linked entity data domain. | |
| refreshMode | Specifies the refresh mode that defines how and when theLinkedEntityCellValue objects of this linked entity data domain are refreshed. | |
| serviceId | Gets the service ID of the linked entity data domain. | |
| supportedRefreshModes | Gets all the refresh modes supported by the linked entity data domain. | |
| LinkedEntityDataDomainAddedEventArgs | id | Gets the ID of the linked entity data domain that was just added to the workbook. |
| serviceId | Gets the service ID of the linked entity data domain that was just added to the workbook. | |
| source | Gets the source of the event. | |
| type | Gets the type of the event. | |
| LinkedEntityDataDomainCollection | add(options: Excel.LinkedEntityDataDomainCreateOptions) | Adds a linked entity data domain object defined by the Office Add-in to the collection. |
| getCount() | Gets the number of linked entity data domains in the collection. | |
| getItem(id: string) | Gets a linked entity data domain by itsid. | |
| getItemAt(index: number) | Gets a linked entity data domain by its index in the collection. | |
| getItemByName(name: string) | Gets a linked entity data domain by itsname. | |
| getItemByNameOrNullObject(name: string) | Gets a linked entity data domain by itsname. | |
| getItemOrNullObject(id: string) | Gets a linked entity data domain by itsid. | |
| items | Gets the loaded child items in this collection. | |
| onLinkedEntityDataDomainAdded | Occurs when a new linked entity data domain is added to the workbook. | |
| onRefreshCompleted | Occurs when the request to refreshLinkedEntityCellValue objects of a linked entity data domain is completed. | |
| onRefreshModeChanged | Occurs when therefreshMode of a linked entity data domain is changed. | |
| refreshAll() | Refreshes allLinkedEntityCellValue objects of all linked entity data domains in this collection. | |
| LinkedEntityDataDomainCreateOptions | dataProvider | Specifies the name of the data provider for the linked entity data domain. |
| id | Specifies the ID of the linked entity data domain. | |
| loadFunctionId | Specifies the ID of the custom function that will be called on demand to resolve or refresh theLinkedEntityCellValue objects of this linked entity data domain. | |
| name | Specifies the name of the linked entity data domain. | |
| periodicRefreshInterval | Specifies the frequency, in seconds, at whichLinkedEntityCellValue objects of this linked entity data domain are refreshed automatically. | |
| supportedRefreshModes | Specifies all the refresh modes supported by the linked entity data domain. | |
| LinkedEntityDataDomainRefreshCompletedEventArgs | errors | Gets any errors encountered during the request to refreshLinkedEntityCellValue objects of the linked entity data domain. |
| id | Gets the ID of the linked entity data domain whoseLinkedEntityCellValue objects were refreshed. | |
| refreshed | Returnstrue if theLinkedEntityCellValue objects of the linked entity data domain were refreshed successfully, otherwise returnsfalse. | |
| serviceId | Gets the service ID of the linked entity data domain whoseLinkedEntityCellValue objects were refreshed. | |
| source | Gets the source of the event. | |
| type | Gets the type of the event. | |
| LinkedEntityDataDomainRefreshModeChangedEventArgs | id | Gets the ID of the linked entity data domain whose refresh mode was changed. |
| refreshMode | Gets the new refresh mode of the linked entity data domain. | |
| serviceId | Gets the service ID of the linked entity data domain whose refresh mode was changed. | |
| source | Gets the source of the event. | |
| type | Gets the type of the event. | |
| LinkedEntityIdCulture | culture | Represents the language culture used to create theLinkedEntityCellValue object. |
| entityId | Represents the identifier specific to a service used to create theLinkedEntityCellValue object. | |
| LinkedEntityLoadServiceRequest | domainId | Represents the domain specific to the service used to create theLinkedEntityCellValue objects. |
| entities | Represents the entity IDs and cultures of theLinkedEntityCellValue objects to load. | |
| LinkedEntityLoadServiceResult | entities | Represents the loadedLinkedEntityCellValue objects. |
| Range | getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions) | Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties. |
| StringCellValue | layouts | Represents layout information for views of this string value. |
| properties | Represents additional properties of this string value. | |
| provider | Represents information that describes the service that provided the data in thisStringCellValue. | |
| referencedValues | Represents the cell values which are referenced withinStringCellValue.properties. | |
| Workbook | getActiveShape() | Gets the active shape in the workbook. |
| getActiveShapeOrNullObject() | Gets the active shape in the workbook. | |
| linkedEntityDataDomains | Returns a collection of linked entity data domains that are available in the workbook. | |
| Worksheet | showDataTypeIcons | Specifies if data type icons are visible on the worksheet. |
Was this page helpful?
Was this page helpful?