Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
New Excel JavaScript APIs are first introduced in "preview" and later become part of a specific, numbered requirement set after sufficient testing occurs and user feedback is acquired.
Note
Preview APIs are subject to change and are not intended for use in a production environment. We recommend that you try them out in test and development environments only. Do not use preview APIs in a production environment or within business-critical documents.
To use preview APIs:
- You must use the preview version of the Office JavaScript API library from the Office.js content delivery network (CDN). The type definition file for TypeScript compilation and IntelliSense is found at the CDN and DefinitelyTyped. You can install these types with
npm install --save-dev @types/office-js-preview(be sure to remove the types for@types/office-jsif you've previously installed them). - You may need to join the Microsoft 365 Insider program for access to more recent Office builds.
API list
The following table lists the Excel JavaScript APIs currently in preview. For a complete list of all Excel JavaScript APIs (including preview APIs and previously released APIs), see all Excel JavaScript APIs.
| Class | Fields | Description |
|---|---|---|
| Base64EncodedImage | data | The Base64-encoded string. |
| type | The file type of the Base64-encoded image. | |
| BusyErrorCellValue | previousValue | Optionally, a #BUSY! error may store the previous value stored in the cell, before the current transient operation began. |
| Chart | getDataRange() | Gets the data source of the whole chart. |
| getDataRangeOrNullObject() | Gets the data source of the whole chart. | |
| EntityArrayCardLayout | arrayProperty | Represents name of the property that contains the array shown in the card. |
| columnsToReport | Represents the count of columns which the card claims are in the array. | |
| displayName | Represents name of the property that contains the array shown in the card. | |
| firstRowIsHeader | Represents whether the first row of the array is treated as a header. | |
| layout | Represents the type of this layout. | |
| rowsToReport | Represents the count of rows which the card claims are in the array. | |
| ExternalCodeServiceObjectCellValue | Python_str | Represents the output of the str() function when used on this object. |
| Python_type | Represents the full type name of this object. | |
| Python_typeName | Represents the short type name of this object. | |
| 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. |
|
| language | Represents the runtime language of this external code service. | |
| preview | Represents the preview value shown in the cell. | |
| provider | Represents information about the service that provided the data in this ExternalCodeServiceObjectCellValue. |
|
| type | Represents the type of this cell value. | |
| LocalImageCellValue | altText | Represents the alternate text used in accessibility scenarios to describe what the image represents. |
| attribution | Represents attribution information to describe the source and license requirements for 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. |
|
| image | Represents the image itself, either cached or encoded. | |
| provider | Represents information that describes the entity or individual who provided the image. | |
| type | Represents the type of this cell value. | |
| LocalImageCellValueCacheId | cachedUid | Represents the image's UID as it appears in the cache. |
| NameErrorCellValue | errorSubType | Represents the type of NameErrorCellValue. |
| NamedSheetViewCollection | getItemOrNullObject(key: string) | Gets a sheet view using its name. |
| NotAvailableErrorCellValue | errorSubType | Represents the type of NotAvailableErrorCellValue. |
| PythonErrorCellValue | 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. |
|
| duringInitialization | Indicates that this #PYTHON! error originated from the workbook's initialization Python code (rather than from a worksheet cell formula). |
|
| errorType | Represents the type of ErrorCellValue. |
|
| type | Represents the type of this cell value. | |
| RequestContext | sensitivityLabelsCatalog | [Api set: ExcelApi BETA (PREVIEW ONLY)] |
| setInvocation(invocation: { invocationId: number isInSyncExecution: boolean }) | ||
| SensitivityLabel | getCurrentOrNullObject() | Gets the current label information that exists on the workbook for the user. |
| tryToUpdate(labelId: string, options?: Excel.SensitivityLabelTryUpdateOptions) | Tries to update to the provided sensitivity label on the workbook for the user. | |
| SensitivityLabelAbacAttribute | dataType | Gets the data type of the attribute. |
| displayName | Gets the display name of the attribute. | |
| displayOrder | Gets the display order of the attribute. | |
| isActive | Gets a value indicating whether the attribute is active. | |
| isMultiValued | Gets a value indicating whether the attribute supports multiple values. | |
| values | Gets the values of the attribute. | |
| SensitivityLabelAbacAttributeValue | displayName | Gets the display name of the attribute value. |
| displayOrder | Gets the display order of the attribute value. | |
| id | Gets the unique identifier of the attribute value. | |
| isActive | Gets a value indicating whether the attribute value is active. | |
| SensitivityLabelDetails | abacAttributeValues | Gets the ABAC (attribute-based access control) attribute values associated with this label. |
| children | Gets the sublabels of the sensitivity label. | |
| color | Gets the color of the sensitivity label. | |
| id | Gets the unique identifier (GUID) of the sensitivity label. | |
| isAbacAttributesRequired | Gets a value indicating whether ABAC (attribute-based access control) attributes are required for this label. | |
| isAbacEnabled | Gets a value indicating whether ABAC (attribute-based access control) is enabled for this label. | |
| isEnabled | Gets a value indicating whether the label is enabled. | |
| name | Gets the name of the sensitivity label. | |
| order | Gets the priority of the sensitivity label, with 0 as lowest priority. | |
| protectionType | Gets a value indicating the protection type provided by this label. | |
| siteId | Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged. | |
| tooltip | Gets the description of the sensitivity label. | |
| SensitivityLabelDetailsCollection | getFirst() | Gets the first SensitivityLabelDetails object in this collection. |
| getFirstOrNullObject() | Gets the first SensitivityLabelDetails object in this collection. |
|
| items | Gets the loaded child items in this collection. | |
| SensitivityLabelTryUpdateOptions | abacAttributes | If provided, specifies the ABAC attributes to apply with the label. |
| SensitivityLabelsCatalog | getAttributes() | Gets the ABAC (attribute-based access control) attributes that are available to the current user. |
| getLabelingCapabilities | Gets the labeling capabilities supported by Excel. | |
| getLabelingCapability | Gets whether the catalog of sensitivity labels is enabled in Excel. | |
| getLabels() | Gets sensitivity labels that are available to the current user. | |
| TimeoutErrorCellValue | 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 TimeoutErrorCellValue. |
|
| errorType | Represents the type of ErrorCellValue. |
|
| type | Represents the type of this cell value. | |
| Window | rangeSelection | Gets the range selection in the window. |
| Workbook | sensitivityLabel | Returns the sensitivity label of the workbook. |
See also
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins