diff --git a/types/chrome/index.d.ts b/types/chrome/index.d.ts
index 29d18743050765..2d4caa165b9e05 100644
--- a/types/chrome/index.d.ts
+++ b/types/chrome/index.d.ts
@@ -9796,32 +9796,6 @@ declare namespace chrome {
export function updateContentScripts(scripts: RegisteredContentScript[], callback: () => void): void;
}
- ////////////////////
- // Script Badge
- ////////////////////
- export namespace scriptBadge {
- export interface GetPopupDetails {
- tabId: number;
- }
-
- export interface AttentionDetails {
- tabId: number;
- }
-
- export interface SetPopupDetails {
- tabId: number;
- popup: string;
- }
-
- export interface ScriptBadgeClickedEvent extends chrome.events.Event<(tab: chrome.tabs.Tab) => void> {}
-
- export function getPopup(details: GetPopupDetails, callback: Function): void;
- export function getAttention(details: AttentionDetails): void;
- export function setPopup(details: SetPopupDetails): void;
-
- export var onClicked: ScriptBadgeClickedEvent;
- }
-
////////////////////
// Sessions
////////////////////
@@ -13443,113 +13417,6 @@ declare namespace chrome {
export const onErrorOccurred: WebResponseErrorEvent;
}
- ////////////////////
- // Web Store
- ////////////////////
- /**
- * Use the chrome.webstore API to initiate app and extension installations "inline" from your site.
- * @since Chrome 15
- */
- export namespace webstore {
- /**
- * @param url Optional. If you have more than one tag on your page with the chrome-webstore-item relation, you can choose which item you'd like to install by passing in its URL here. If it is omitted, then the first (or only) link will be used. An exception will be thrown if the passed in URL does not exist on the page.
- * @param successCallback Optional. This function is invoked when inline installation successfully completes (after the dialog is shown and the user agrees to add the item to Chrome). You may wish to use this to hide the user interface element that prompted the user to install the app or extension.
- * @param failureCallback Optional. This function is invoked when inline installation does not successfully complete. Possible reasons for this include the user canceling the dialog, the linked item not being found in the store, or the install being initiated from a non-verified site.
- * Parameter error: The failure detail. You may wish to inspect or log this for debugging purposes, but you should not rely on specific strings being passed back.
- * Optional parameter errorCode: The error code from the stable set of possible errors.
- * * Enum of the possible install results, including error codes sent back in the event that an inline installation has failed.
- * * * "otherError": An uncommon, unrecognized, or unexpected error. In some cases, the readable error string can provide more information.
- * * * "aborted": The operation was aborted as the requestor is no longer alive.
- * * * "installInProgress": An installation of the same extension is in progress.
- * * * "notPermitted": The installation is not permitted.
- * * * "invalidId": Invalid Chrome Web Store item ID.
- * * * "webstoreRequestError": Failed to retrieve extension metadata from the Web Store.
- * * * "invalidWebstoreResponse": The extension metadata retrieved from the Web Store was invalid.
- * * * "invalidManifest": An error occurred while parsing the extension manifest retrieved from the Web Store.
- * * * "iconError": Failed to retrieve the extension's icon from the Web Store, or the icon was invalid.
- * * * "userCanceled": The user canceled the operation.
- * * * "blacklisted": The extension is blacklisted.
- * * * "missingDependencies": Unsatisfied dependencies, such as shared modules.
- * * * "requirementViolations": Unsatisfied requirements, such as webgl.
- * * * "blockedByPolicy": The extension is blocked by management policies.
- * * * "launchFeatureDisabled": The launch feature is not available.
- * * * "launchUnsupportedExtensionType": The launch feature is not supported for the extension type.
- * * * "launchInProgress": A launch of the same extension is in progress.
- */
- export function install(
- url: string,
- successCallback?: Function,
- failureCallback?: (error: string, errorCode?: string) => void,
- ): void;
- /**
- * @param successCallback Optional. This function is invoked when inline installation successfully completes (after the dialog is shown and the user agrees to add the item to Chrome). You may wish to use this to hide the user interface element that prompted the user to install the app or extension.
- * @param failureCallback Optional. This function is invoked when inline installation does not successfully complete. Possible reasons for this include the user canceling the dialog, the linked item not being found in the store, or the install being initiated from a non-verified site.
- * Parameter error: The failure detail. You may wish to inspect or log this for debugging purposes, but you should not rely on specific strings being passed back.
- * Optional parameter errorCode: The error code from the stable set of possible errors.
- * * Enum of the possible install results, including error codes sent back in the event that an inline installation has failed.
- * * * "otherError": An uncommon, unrecognized, or unexpected error. In some cases, the readable error string can provide more information.
- * * * "aborted": The operation was aborted as the requestor is no longer alive.
- * * * "installInProgress": An installation of the same extension is in progress.
- * * * "notPermitted": The installation is not permitted.
- * * * "invalidId": Invalid Chrome Web Store item ID.
- * * * "webstoreRequestError": Failed to retrieve extension metadata from the Web Store.
- * * * "invalidWebstoreResponse": The extension metadata retrieved from the Web Store was invalid.
- * * * "invalidManifest": An error occurred while parsing the extension manifest retrieved from the Web Store.
- * * * "iconError": Failed to retrieve the extension's icon from the Web Store, or the icon was invalid.
- * * * "userCanceled": The user canceled the operation.
- * * * "blacklisted": The extension is blacklisted.
- * * * "missingDependencies": Unsatisfied dependencies, such as shared modules.
- * * * "requirementViolations": Unsatisfied requirements, such as webgl.
- * * * "blockedByPolicy": The extension is blocked by management policies.
- * * * "launchFeatureDisabled": The launch feature is not available.
- * * * "launchUnsupportedExtensionType": The launch feature is not supported for the extension type.
- * * * "launchInProgress": A launch of the same extension is in progress.
- */
- export function install(
- successCallback: Function,
- failureCallback?: (error: string, errorCode?: string) => void,
- ): void;
- /**
- * @param failureCallback Optional. This function is invoked when inline installation does not successfully complete. Possible reasons for this include the user canceling the dialog, the linked item not being found in the store, or the install being initiated from a non-verified site.
- * Parameter error: The failure detail. You may wish to inspect or log this for debugging purposes, but you should not rely on specific strings being passed back.
- * Optional parameter errorCode: The error code from the stable set of possible errors.
- * * Enum of the possible install results, including error codes sent back in the event that an inline installation has failed.
- * * * "otherError": An uncommon, unrecognized, or unexpected error. In some cases, the readable error string can provide more information.
- * * * "aborted": The operation was aborted as the requestor is no longer alive.
- * * * "installInProgress": An installation of the same extension is in progress.
- * * * "notPermitted": The installation is not permitted.
- * * * "invalidId": Invalid Chrome Web Store item ID.
- * * * "webstoreRequestError": Failed to retrieve extension metadata from the Web Store.
- * * * "invalidWebstoreResponse": The extension metadata retrieved from the Web Store was invalid.
- * * * "invalidManifest": An error occurred while parsing the extension manifest retrieved from the Web Store.
- * * * "iconError": Failed to retrieve the extension's icon from the Web Store, or the icon was invalid.
- * * * "userCanceled": The user canceled the operation.
- * * * "blacklisted": The extension is blacklisted.
- * * * "missingDependencies": Unsatisfied dependencies, such as shared modules.
- * * * "requirementViolations": Unsatisfied requirements, such as webgl.
- * * * "blockedByPolicy": The extension is blocked by management policies.
- * * * "launchFeatureDisabled": The launch feature is not available.
- * * * "launchUnsupportedExtensionType": The launch feature is not supported for the extension type.
- * * * "launchInProgress": A launch of the same extension is in progress.
- */
- export function install(failureCallback?: (error: string, errorCode?: string) => void): void;
-
- export interface InstallationStageEvent extends chrome.events.Event<(stage: string) => void> {}
-
- export interface DownloadProgressEvent extends chrome.events.Event<(percentDownloaded: number) => void> {}
-
- /**
- * Fired when an inline installation enters a new InstallStage. In order to receive notifications about this event, listeners must be registered before the inline installation begins.
- * @since Chrome 35
- */
- export var onInstallStageChanged: InstallationStageEvent;
- /**
- * Fired periodically with the download progress of an inline install. In order to receive notifications about this event, listeners must be registered before the inline installation begins.
- * @since Chrome 35
- */
- export var onDownloadProgress: DownloadProgressEvent;
- }
-
////////////////////
// Windows
////////////////////
diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts
index 578fe836d30bf5..930e8ab4980d18 100644
--- a/types/office-js-preview/index.d.ts
+++ b/types/office-js-preview/index.d.ts
@@ -24711,9 +24711,9 @@ declare namespace Excel {
/**
* Represents an unknown cell control.
* This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
- *
+ *
* @remarks
- * [Api set: ExcelApi 1.18]
+ * [Api set: ExcelApi 1.18]
*/
interface UnknownCellControl {
type: CellControlType.unknown;
@@ -24721,9 +24721,9 @@ declare namespace Excel {
/**
* Represents an empty cell control.
* This represents the state where a cell does not have a control.
- *
+ *
* @remarks
- * [Api set: ExcelApi 1.18]
+ * [Api set: ExcelApi 1.18]
*/
interface EmptyCellControl {
type: CellControlType.empty;
@@ -24731,28 +24731,28 @@ declare namespace Excel {
/**
* Represents the result of a query that resulted in multiple cell controls.
* If the result has multiple controls, then they can't be represented as a single result.
- *
+ *
* @remarks
- * [Api set: ExcelApi 1.18]
+ * [Api set: ExcelApi 1.18]
*/
interface MixedCellControl {
type: CellControlType.mixed;
}
/**
- * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
- *
- * @remarks
- * [Api set: ExcelApi 1.18]
- */
+ * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
+ *
+ * @remarks
+ * [Api set: ExcelApi 1.18]
+ */
interface CheckboxCellControl {
type: CellControlType.checkbox;
}
/**
- * Represents an interactable control inside of a cell.
- *
- * @remarks
- * [Api set: ExcelApi 1.18]
- */
+ * Represents an interactable control inside of a cell.
+ *
+ * @remarks
+ * [Api set: ExcelApi 1.18]
+ */
type CellControl = UnknownCellControl | EmptyCellControl | MixedCellControl | CheckboxCellControl;
/**
* Represents a 2D array of cell values.
@@ -24948,6 +24948,66 @@ declare namespace Excel {
*/
firstRowIsHeader?: boolean;
}
+ /**
+ * Represents the compact layout properties for a value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface BasicCompactLayout {
+ /**
+ * Specifies the name of the icon which is used to open the card.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ icon?: string | EntityCompactLayoutIcons;
+ }
+ /**
+ * Represents a card layout used for the boolean, double, and string basic types.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface BasicCardLayout extends CardLayoutStandardProperties {
+ /**
+ * Represents the type of this layout.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ layout?: EntityCardLayoutType.entity | "Entity";
+ }
+ /**
+ * Represents layout information for various views of the value and its properties.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface BasicViewLayouts {
+ /**
+ * Represents the layout of this value and its properties in card view.
+ * If the `BasicCardLayout` object doesn't have a layout property, it's assumed to be "Entity".
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ card?: BasicCardLayout;
+ /**
+ * Represents the layout used when there is limited space to represent the value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ compact?: BasicCompactLayout;
+ }
/**
* Represents types of #BLOCKED! errors.
*
@@ -25222,7 +25282,7 @@ declare namespace Excel {
* @remarks
* [Api set: ExcelApi 1.16]
*/
- type: CellValueType.boolean | "Boolean";
+ type: CellValueType.boolean | ReferenceValueType.boolean | "Boolean";
/**
* Represents the value that would be returned by `Range.values` for a cell with this value.
*
@@ -25237,6 +25297,41 @@ declare namespace Excel {
* [Api set: ExcelApi 1.16]
*/
basicType?: RangeValueType.boolean | "Boolean";
+ /**
+ * Represents additional properties of this boolean value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ properties?: {
+ [key: string]: EntityPropertyType;
+ };
+ /**
+ * Represents layout information for views of this boolean value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ layouts?: BasicViewLayouts;
+ /**
+ * Represents information that describes the service that provided the data in this `BooleanCellValue`.
+ * This information can be used for branding in card view.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ provider?: CellValueProviderAttributes;
+ /**
+ * Represents the cell values which are referenced within `BooleanCellValue.properties`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ referencedValues?: ReferencedValue[];
}
/**
* Represents types of #BUSY! errors.
@@ -25614,13 +25709,30 @@ declare namespace Excel {
*/
layout: "Table";
}
+ /**
+ * Represents a section of a card that is arranged as two columns in card view.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface CardLayoutTwoColumnSection extends CardLayoutSectionStandardProperties {
+ /**
+ * Represents the type of layout for this section.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ layout: "TwoColumn";
+ }
/**
* Represents the layout of a section of a card in card view.
*
* @remarks
* [Api set: ExcelApi 1.16]
*/
- type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection;
+ type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection | CardLayoutTwoColumnSection;
/**
* Properties of a card layout relevant to most card layouts.
*
@@ -25704,6 +25816,90 @@ declare namespace Excel {
*/
icon?: string | EntityCompactLayoutIcons;
}
+ /**
+ * Represents the types of the `FunctionCellValue` object.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ enum FunctionCellValueType {
+ /**
+ * Reference to a JavaScript custom function. For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-overview | Create custom functions in Excel}.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ javaScriptReference = "JavaScriptReference"
+ }
+ /**
+ * Represents a reference to a JavaScript custom function.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface JavaScriptCustomFunctionReferenceCellValue {
+ /**
+ * Represents the type of this cell value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ type: CellValueType.function | "Function";
+ /**
+ * Represents the value that would be returned by `Range.values` for a cell with this value.
+ * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
+ * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ basicValue?: "#VALUE!" | string;
+ /**
+ * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ basicType?: RangeValueType.error | "Error";
+ /**
+ * Represents the type of `FunctionCellValue`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference";
+ /**
+ * Represents the namespace used by the custom function. For more information, see {@link https://learn.microsoft.com/javascript/api/manifest/namespace | Manifest reference: Namespace}.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ namespace: string;
+ /**
+ * Represents the ID of the custom function. For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id: string;
+ }
+ /**
+ * Represents a cell value which can be evaluated as a function.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ type FunctionCellValue = JavaScriptCustomFunctionReferenceCellValue;
/**
* Represents the layout used when there is limited space to represent the entity.
*
@@ -29661,7 +29857,31 @@ declare namespace Excel {
* @remarks
* [Api set: ExcelApi 1.16]
*/
- root = "Root"
+ root = "Root",
+ /**
+ * Represents a `DoubleCellValue`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ double = "Double",
+ /**
+ * Represents a `StringCellValue`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ string = "String",
+ /**
+ * Represents a `BooleanCellValue`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ boolean = "Boolean"
}
/**
* Represents the value in a cell.
@@ -29669,7 +29889,7 @@ declare namespace Excel {
* @remarks
* [Api set: ExcelApi 1.16]
*/
- type ReferencedValue = ArrayCellValue | EntityCellValue | RootReferenceCellValue;
+ type ReferencedValue = ArrayCellValue | EntityCellValue | RootReferenceCellValue | DoubleCellValue | StringCellValue | BooleanCellValue;
/**
* Represents the types of the `CellValue` object.
*
@@ -29734,6 +29954,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.16]
*/
formattedNumber = "FormattedNumber",
+ /**
+ * Represents a `FunctionCellValue`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ function = "Function",
/**
* Represents a `LinkedEntityCellValue`.
*
@@ -29784,7 +30012,7 @@ declare namespace Excel {
* @remarks
* [Api set: ExcelApi 1.16]
*/
- type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | ExternalCodeServiceObjectCellValue | FormattedNumberCellValue | LinkedEntityCellValue | LocalImageCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
+ type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | ExternalCodeServiceObjectCellValue | FormattedNumberCellValue | FunctionCellValue | LinkedEntityCellValue | LocalImageCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
/**
* These extra properties may appear on a `CellValue` and provide information about that `CellValue`, but the extra properties are not part of the value in the cell.
*
@@ -30324,7 +30552,7 @@ declare namespace Excel {
* @remarks
* [Api set: ExcelApi 1.16]
*/
- type: CellValueType.double | "Double";
+ type: CellValueType.double | ReferenceValueType.double | "Double";
/**
* Represents the value that would be returned by `Range.values` for a cell with this value.
*
@@ -30339,6 +30567,52 @@ declare namespace Excel {
* [Api set: ExcelApi 1.16]
*/
basicType?: RangeValueType.double | "Double";
+ /**
+ * Returns the number format string that is used to display this value.
+ * When accessed through a `valuesAsJson` property, this number format string is in the en-US locale. When accessed through a `valuesAsJsonLocal` property, this number format is in the user's display locale.
+ * Number format strings must conform to Excel guidelines.
+ * To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ numberFormat?: string;
+ /**
+ * Represents additional properties of this double value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ properties?: {
+ [key: string]: EntityPropertyType;
+ };
+ /**
+ * Represents layout information for views of this double value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ layouts?: BasicViewLayouts;
+ /**
+ * Represents information that describes the service that provided the data in this `DoubleCellValue`.
+ * This information can be used for branding in card view.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ provider?: CellValueProviderAttributes;
+ /**
+ * Represents the cell values which are referenced within `DoubleCellValue.properties`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ referencedValues?: ReferencedValue[];
}
/**
* Represents the value of a cell that's empty and has no formulas or data.
@@ -30949,6 +31223,48 @@ declare namespace Excel {
*/
errorType?: ErrorCellValueType.gettingData | "GettingData";
}
+ /**
+ * Represents a request to `@linkedEntityLoadService` custom function to load `LinkedEntityCellValue` objects.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityLoadServiceRequest {
+ /**
+ * Represents the domain specific to the service used to create the `LinkedEntityCellValue` objects.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ domainId: string;
+ /**
+ * Represents the entity IDs and cultures of the `LinkedEntityCellValue` objects to load.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ entities: LinkedEntityIdCulture[];
+ }
+ /**
+ * Represents the result of a request to `@linkedEntityLoadService` custom function to load `LinkedEntityCellValue` objects.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityLoadServiceResult {
+ /**
+ * Represents the loaded `LinkedEntityCellValue` objects. The loaded objects must be returned in the same order as the `entities` property of `LinkedEntityLoadServiceRequest`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ entities: LinkedEntityCellValue[];
+ }
/**
* The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.
*
@@ -30985,6 +31301,31 @@ declare namespace Excel {
*/
culture: string;
}
+ /**
+ * Represents the entity ID and culture for a `LinkedEntityCellValue` object.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityIdCulture {
+ /**
+ * Represents the identifier specific to a service used to create the `LinkedEntityCellValue` object.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ entityId: string;
+ /**
+ * Represents the language culture used to create the `LinkedEntityCellValue` object.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ culture: string;
+ }
/**
* Represents a value whose properties derive from a service.
*
@@ -31660,7 +32001,7 @@ declare namespace Excel {
* @remarks
* [Api set: ExcelApi 1.16]
*/
- type: CellValueType.string | "String";
+ type: CellValueType.string | ReferenceValueType.string | "String";
/**
* Represents the value that would be returned by `Range.values` for a cell with this value.
*
@@ -31675,6 +32016,41 @@ declare namespace Excel {
* [Api set: ExcelApi 1.16]
*/
basicType?: RangeValueType.string | "String";
+ /**
+ * Represents additional properties of this string value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ properties?: {
+ [key: string]: EntityPropertyType;
+ };
+ /**
+ * Represents layout information for views of this string value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ layouts?: BasicViewLayouts;
+ /**
+ * Represents information that describes the service that provided the data in this `StringCellValue`.
+ * This information can be used for branding in card view.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ provider?: CellValueProviderAttributes;
+ /**
+ * Represents the cell values which are referenced within `StringCellValue.properties`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ referencedValues?: ReferencedValue[];
}
/**
* Represents types of #TIMEOUT! errors.
@@ -38523,6 +38899,14 @@ declare namespace Excel {
* @beta
*/
readonly linkedDataTypes: Excel.LinkedDataTypeCollection;
+ /**
+ * Returns a collection of linked entity data domains that are available in the workbook.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;
/**
* Returns a collection of linked workbooks. In formulas, the workbook links can be used to reference data (cell values and names) outside of the current workbook.
*
@@ -38783,6 +39167,23 @@ declare namespace Excel {
* [Api set: ExcelApi 1.9]
*/
getActiveChartOrNullObject(): Excel.Chart;
+ /**
+ * Gets the active shape in the workbook. If there is no active shape, an `ItemNotFound` error is thrown.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ getActiveShape(): Excel.Shape;
+ /**
+ * Gets the active shape in the workbook. If there is no active shape, then this method returns an object with its `isNullObject` property set to `true`.
+ For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ getActiveShapeOrNullObject(): Excel.Shape;
/**
* Gets the currently active slicer in the workbook. If there is no active slicer, an `ItemNotFound` exception is thrown.
*
@@ -39164,6 +39565,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
position: number;
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showDataTypeIcons: boolean;
/**
* Specifies if gridlines are visible to the user.
*
@@ -42057,24 +42466,24 @@ declare namespace Excel {
}
/**
* Represents a sequence of one or more characters that share the same font attributes in a cell. Can be used as the `textRuns` properties of `getCellProperties` or the `textRuns` input parameter of `setCellProperties`.
- *
+ *
* @remarks
* [Api set: ExcelApi 1.18]
*/
interface RangeTextRun {
/**
* The font attributes (such as font name, font size, and color) applied to this text run.
- *
+ *
* @remarks
* [Api set: ExcelApi 1.18]
*/
font?: Excel.CellPropertiesFont;
/**
* The text of this text run.
- *
+ *
* @remarks
* [Api set: ExcelApi 1.18]
- */
+ */
text: string;
}
/**
@@ -47222,6 +47631,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
readonly format: Excel.ChartDataLabelFormat;
+ /**
+ * Gets an object that represents the leader lines of the data labels.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly leaderLines: Excel.ChartLeaderLines;
/**
* Specifies if data labels automatically generate appropriate text based on context.
*
@@ -47229,6 +47646,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
autoText: boolean;
+ /**
+ * Gets or sets the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data labels are not geometric shapes.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
/**
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
This property is valid only when the `TextOrientation` of data label is 0.
@@ -47265,6 +47691,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
separator: string;
+ /**
+ * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly showAsStickyCallout: boolean;
/**
* Specifies if the data label bubble size is visible.
*
@@ -47279,6 +47713,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
showCategoryName: boolean;
+ /**
+ * Gets or sets a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showLeaderLines: boolean;
/**
* Specifies if the data label legend key is visible.
*
@@ -47387,6 +47829,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
formula: string;
+ /**
+ * Gets or sets the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data label is not a geometric shape.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
/**
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
*
@@ -47437,6 +47888,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.7]
*/
separator: string;
+ /**
+ * Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly showAsStickyCallout: boolean;
/**
* Specifies if the data label bubble size is visible.
*
@@ -47523,6 +47982,45 @@ declare namespace Excel {
set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
set(properties: Excel.ChartDataLabel): void;
+ /**
+ * Returns a substring of the data label. The line break character '\n' counts as one character.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param start The zero-based starting character position of a substring in the data label.
+ * @param length Optional. The number of characters in the substring. If length is omitted, all the characters from start to the end of the data label are retrieved.
+ */
+ getSubstring(start: number, length?: number): Excel.ChartFormatString;
+ /**
+ * Returns the tail anchor of the data label which is shown as a sticky callout.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ getTailAnchor(): Excel.ChartDataLabelAnchor;
+ /**
+ * Sets the height of the data label in points.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param height The height of the data label in points.
+ */
+ setHeight(height: number): void;
+ /**
+ * Sets the width of the data label in points.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param width The width of the data label in points.
+ */
+ setWidth(width: number): void;
/**
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
*
@@ -47615,6 +48113,67 @@ declare namespace Excel {
*/
toJSON(): Excel.Interfaces.ChartDataLabelFormatData;
}
+ /**
+ * Represents the chart data label anchor.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ class ChartDataLabelAnchor extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ left: number;
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ top: number;
+ /**
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
+ */
+ set(properties: Interfaces.ChartDataLabelAnchorUpdateData, options?: OfficeExtension.UpdateOptions): void;
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
+ set(properties: Excel.ChartDataLabelAnchor): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param options Provides options for which properties of the object to load.
+ */
+ load(options?: Excel.Interfaces.ChartDataLabelAnchorLoadOptions): Excel.ChartDataLabelAnchor;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.ChartDataLabelAnchor;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+ */
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): Excel.ChartDataLabelAnchor;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.ChartDataLabelAnchor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataLabelAnchorData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): Excel.Interfaces.ChartDataLabelAnchorData;
+ }
/**
* Represents the data table object of a chart.
*
@@ -49720,6 +50279,112 @@ declare namespace Excel {
*/
toJSON(): Excel.Interfaces.ChartPlotAreaFormatData;
}
+ /**
+ * Gets an object that represents the formatting of chart leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ class ChartLeaderLines extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Represents the formatting of leader lines of data labels in a series.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly format: Excel.ChartLeaderLinesFormat;
+ /**
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
+ */
+ set(properties: Interfaces.ChartLeaderLinesUpdateData, options?: OfficeExtension.UpdateOptions): void;
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
+ set(properties: Excel.ChartLeaderLines): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param options Provides options for which properties of the object to load.
+ */
+ load(options?: Excel.Interfaces.ChartLeaderLinesLoadOptions): Excel.ChartLeaderLines;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.ChartLeaderLines;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+ */
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): Excel.ChartLeaderLines;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.ChartLeaderLines` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLeaderLinesData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): Excel.Interfaces.ChartLeaderLinesData;
+ }
+ /**
+ * Encapsulates the format properties for leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ class ChartLeaderLinesFormat extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Gets an object that represents the line formatting of chart leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly line: Excel.ChartLineFormat;
+ /**
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
+ */
+ set(properties: Interfaces.ChartLeaderLinesFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
+ set(properties: Excel.ChartLeaderLinesFormat): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param options Provides options for which properties of the object to load.
+ */
+ load(options?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions): Excel.ChartLeaderLinesFormat;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.ChartLeaderLinesFormat;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+ */
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): Excel.ChartLeaderLinesFormat;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.ChartLeaderLinesFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLeaderLinesFormatData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): Excel.Interfaces.ChartLeaderLinesFormatData;
+ }
/**
* Manages sorting operations on `Range` objects.
*
@@ -59415,6 +60080,562 @@ declare namespace Excel {
*/
type: "LinkedDataTypeLinkedDataTypeAdded";
}
+ /**
+ * Represents a specific category or field of information that shares some common characteristics or attributes.
+ * A data domain is linked to a data provider that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
+ * A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ class LinkedEntityDataDomain extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /**
+ * Gets the name of the data provider for the linked entity data domain.
+ * This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly dataProvider: string;
+ /**
+ * Gets the ID of the linked entity data domain defined by Office Add-ins.
+ * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly id: string;
+ /**
+ * Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
+ * Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly lastRefreshed: Date;
+ /**
+ * Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
+ * For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
+ * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly loadFunctionId: string;
+ /**
+ * Gets the name of the linked entity data domain.
+ * This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly name: string;
+ /**
+ * Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
+ * The refresh interval only applies if the `refreshMode` is set to "Periodic".
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly periodicRefreshInterval: number;
+ /**
+ * Gets or sets the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
+ * If the refresh mode being set isn't supported by this linked entity data domain, then the current refresh mode is not changed.
+ * If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
+ /**
+ * Gets the service ID of the linked entity data domain.
+ * This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
+ * This ID never changes across user sessions.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly serviceId: number;
+ /**
+ * Gets all the refresh modes supported by the linked entity data domain.
+ * This array can change based on the information provided by the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];
+ /**
+ * Deletes this object from the `LinkedEntityDataDomainCollection`.
+ * Once the linked entity data domain is deleted, new `LinkedEntityCellValue` objects of this linked entity data domain can't be created and existing `LinkedEntityCellValue` objects can't be refreshed.
+ * An Office Add-in can only delete linked entity data domains that it created.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ delete(): void;
+ /**
+ * Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain.
+ * The refresh request can fail if the data provider is busy or temporarily inaccessible.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refresh(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param options Provides options for which properties of the object to load.
+ */
+ load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+ */
+ load(propertyNamesAndPaths?: {
+ select?: string;
+ expand?: string;
+ }): Excel.LinkedEntityDataDomain;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.LinkedEntityDataDomain` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LinkedEntityDataDomainData`) that contains shallow copies of any loaded child properties from the original object.
+ */
+ toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;
+ }
+ /**
+ * Provides information about the identity of the linked entity data domain that was just added to the workbook.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityDataDomainAddedEventArgs {
+ /**
+ * Gets the ID of the linked entity data domain that was just added to the workbook. This ID is defined by Office Add-ins.
+ * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id?: string;
+ /**
+ * Gets the service ID of the linked entity data domain that was just added to the workbook.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ serviceId: number;
+ /**
+ * Gets the source of the event. See `Excel.EventSource` for details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ source: Excel.EventSource | "Local" | "Remote";
+ /**
+ * Gets the type of the event. See `Excel.EventType` for details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ type: "LinkedEntityDataDomainLinkedEntityDataDomainAdded";
+ }
+ /**
+ * Represents a collection of `LinkedEntityDataDomain` objects.
+ * The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ class LinkedEntityDataDomainCollection extends OfficeExtension.ClientObject {
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+ context: RequestContext;
+ /** Gets the loaded child items in this collection. */
+ readonly items: Excel.LinkedEntityDataDomain[];
+ /**
+ * Adds a linked entity data domain object defined by the Office Add-in to the collection.
+ * Once the linked entity data domain is added, it can be used to create `LinkedEntityCellValue` objects.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param options Options that are used to create the linked entity data domain to be added.
+ */
+ add(options: Excel.LinkedEntityDataDomainCreateOptions): void;
+ /**
+ * Gets the number of linked entity data domains in the collection.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ getCount(): OfficeExtension.ClientResult;
+ /**
+ * Gets a linked entity data domain by its `id`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param id The `id` of the `LinkedEntityDataDomain` object to be retrieved.
+ * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned.
+ */
+ getItem(id: string): Excel.LinkedEntityDataDomain;
+ /**
+ * Gets a linked entity data domain by its index in the collection.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param index The index of the linked entity data domain in the collection.
+ * @returns The linked entity data domain at the given index.
+ */
+ getItemAt(index: number): Excel.LinkedEntityDataDomain;
+ /**
+ * Gets a linked entity data domain by its `name`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param name The `name` of the `LinkedEntityDataDomain` object to be retrieved.
+ * @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned.
+ */
+ getItemByName(name: string): Excel.LinkedEntityDataDomain;
+ /**
+ * Gets a linked entity data domain by its `name`.
+ * If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
+ * For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param name The `name` of the `LinkedEntityDataDomain` object to be retrieved.
+ * @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned.
+ */
+ getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;
+ /**
+ * Gets a linked entity data domain by its `id`.
+ * If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
+ * For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ *
+ * @param id The `id` of the `LinkedEntityDataDomain` object to be retrieved.
+ * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned.
+ */
+ getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;
+ /**
+ * Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.
+ * The refresh request can fail if the data providers are busy or temporarily inaccessible.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshAll(): void;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param options Provides options for which properties of the object to load.
+ */
+ load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
+ */
+ load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;
+ /**
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
+ *
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
+ */
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;
+ /**
+ * Occurs when a new linked entity data domain is added to the workbook.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ *
+ * @eventproperty
+ * @beta
+ */
+ readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers;
+ /**
+ * Occurs when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ *
+ * @eventproperty
+ * @beta
+ */
+ readonly onRefreshCompleted: OfficeExtension.EventHandlers;
+ /**
+ * Occurs when the `refreshMode` of a linked entity data domain is changed.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ *
+ * @eventproperty
+ * @beta
+ */
+ readonly onRefreshModeChanged: OfficeExtension.EventHandlers;
+ /**
+ * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
+ * Whereas the original `Excel.LinkedEntityDataDomainCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LinkedEntityDataDomainCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
+ */
+ toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;
+ }
+ /**
+ * Represents options that are used to create the `LinkedEntityDataDomain` object being added to the `LinkedEntityDataDomainCollection`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityDataDomainCreateOptions {
+ /**
+ * Gets or sets the name of the data provider for the linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ dataProvider: string;
+ /**
+ * Gets or sets the ID of the linked entity data domain.
+ * This ID must be unique across all linked entity data domains defined by this Office Add-in.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id: string;
+ /**
+ * Gets or sets the ID of the custom function that will be called on demand to resolve or refresh the `LinkedEntityCellValue` objects of this linked entity data domain.
+ * For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ loadFunctionId: string;
+ /**
+ * Gets or sets the name of the linked entity data domain.
+ * This name must be unique across all linked entity data domains defined by this Office Add-in.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ name: string;
+ /**
+ * Gets or sets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. The minimum valid value is 300.
+ * This property is required if the `supportedRefreshModes` array contains the value "Periodic".
+ * This property only applies if the `refreshMode` of the linked entity data domain is set to "Periodic".
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ periodicRefreshInterval?: number;
+ /**
+ * Gets or sets all the refresh modes supported by the linked entity data domain.
+ * The default value is `["Manual"]`, which is always supported even if not specified.
+ * The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data domain on the next workbook open.
+ * If the refresh mode wasn't saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data domain.
+ * If the array has the value "Periodic", the `periodicRefreshInterval` property must also be set for the linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];
+ }
+ /**
+ * Provides information about the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityDataDomainRefreshCompletedEventArgs {
+ /**
+ * Gets any errors encountered during the request to refresh `LinkedEntityCellValue` objects of the linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ errors?: string[];
+ /**
+ * Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed. This ID is defined by Office Add-ins.
+ * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id?: string;
+ /**
+ * Returns `true` if the `LinkedEntityCellValue` objects of the linked entity data domain were refreshed successfully, otherwise returns `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshed: boolean;
+ /**
+ * Gets the service ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ serviceId: number;
+ /**
+ * Gets the source of the event. See `Excel.EventSource` for details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ source: Excel.EventSource | "Local" | "Remote";
+ /**
+ * Gets the type of the event. See `Excel.EventType` for details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ type: "LinkedEntityDataDomainRefreshCompleted";
+ }
+ /**
+ * Represents the refresh mode setting for the `LinkedEntityCellValue` objects of a `LinkedEntityDataDomain`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ enum LinkedEntityDataDomainRefreshMode {
+ /**
+ * Refresh mode is unknown or unsupported.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ unknown = "Unknown",
+ /**
+ * Manual refresh by the user. Refresh is not triggered automatically.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ manual = "Manual",
+ /**
+ * Refresh on workbook load, applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ * Refresh on add-in load, applicable to linked entity data domains defined by Office Add-ins.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ onLoad = "OnLoad",
+ /**
+ * Refresh automatically based on the frequency, in seconds, specified by `periodicRefreshInterval`.
+ * For linked entity data domains defined by service data providers, such as Bing or Power BI, this value also initiates a refresh each time the workbook is opened.
+ * For linked entity data domains defined by Office Add-ins, this value also initiates a refresh each time the add-in loads.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ periodic = "Periodic"
+ }
+ /**
+ * Provides information about the linked entity data domain whose refresh mode was changed.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityDataDomainRefreshModeChangedEventArgs {
+ /**
+ * Gets the ID of the linked entity data domain whose refresh mode was changed. This ID is defined by Office Add-ins.
+ * This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id?: string;
+ /**
+ * Gets the new refresh mode of the linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
+ /**
+ * Gets the service ID of the linked entity data domain whose refresh mode was changed.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ serviceId: number;
+ /**
+ * Gets the source of the event. See `Excel.EventSource` for details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ source: Excel.EventSource | "Local" | "Remote";
+ /**
+ * Gets the type of the event. See `Excel.EventType` for details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ type: "LinkedEntityDataDomainRefreshModeChanged";
+ }
/**
* @remarks
* [Api set: ExcelApi 1.7]
@@ -63739,6 +64960,27 @@ declare namespace Excel {
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
*/
annotationAdded = "AnnotationAdded",
+ /**
+ * LinkedEntityDataDomainAdded represents the type of event registered when a new linked entity data domain is added to the workbook.
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ linkedEntityDataDomainLinkedEntityDataDomainAdded = "LinkedEntityDataDomainLinkedEntityDataDomainAdded",
+ /**
+ * LinkedEntityDataDomainRefreshCompleted represents the type of event registered when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ linkedEntityDataDomainRefreshCompleted = "LinkedEntityDataDomainRefreshCompleted",
+ /**
+ * LinkedEntityDataDomainRefreshModeChanged represents the type of event registered when the `refreshMode` of a linked entity data domain is changed.
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ linkedEntityDataDomainRefreshModeChanged = "LinkedEntityDataDomainRefreshModeChanged",
/**
* TableQueryRefreshCompleted represents the type of event registered when a table query refresh is completed.
* @remarks
@@ -70574,6 +71816,7 @@ declare namespace Excel {
pivotTableRangeConflict = "PivotTableRangeConflict",
powerQueryRefreshResourceChallenge = "PowerQueryRefreshResourceChallenge",
rangeExceedsLimit = "RangeExceedsLimit",
+ rangeImageExceedsLimit = "RangeImageExceedsLimit",
refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked",
requestAborted = "RequestAborted",
responsePayloadSizeLimitExceeded = "ResponsePayloadSizeLimitExceeded",
@@ -70833,6 +72076,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
position?: number;
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showDataTypeIcons?: boolean;
/**
* Specifies if gridlines are visible to the user.
*
@@ -72552,6 +73803,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
format?: Excel.Interfaces.ChartDataLabelFormatUpdateData;
+ /**
+ * Gets an object that represents the leader lines of the data labels.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ leaderLines?: Excel.Interfaces.ChartLeaderLinesUpdateData;
/**
* Specifies if data labels automatically generate appropriate text based on context.
*
@@ -72559,6 +73818,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
autoText?: boolean;
+ /**
+ * Gets or sets the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data labels are not geometric shapes.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
/**
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
This property is valid only when the `TextOrientation` of data label is 0.
@@ -72609,6 +73877,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
showCategoryName?: boolean;
+ /**
+ * Gets or sets a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showLeaderLines?: boolean;
/**
* Specifies if the data label legend key is visible.
*
@@ -72676,6 +73952,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
formula?: string;
+ /**
+ * Gets or sets the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data label is not a geometric shape.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
/**
* Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
@@ -72808,6 +74093,25 @@ declare namespace Excel {
*/
font?: Excel.Interfaces.ChartFontUpdateData;
}
+ /** An interface for updating data on the `ChartDataLabelAnchor` object, for use in `chartDataLabelAnchor.set({ ... })`. */
+ interface ChartDataLabelAnchorUpdateData {
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ left?: number;
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ top?: number;
+ }
/** An interface for updating data on the `ChartDataTable` object, for use in `chartDataTable.set({ ... })`. */
interface ChartDataTableUpdateData {
/**
@@ -73632,6 +74936,28 @@ declare namespace Excel {
*/
border?: Excel.Interfaces.ChartBorderUpdateData;
}
+ /** An interface for updating data on the `ChartLeaderLines` object, for use in `chartLeaderLines.set({ ... })`. */
+ interface ChartLeaderLinesUpdateData {
+ /**
+ * Represents the formatting of leader lines of data labels in a series.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ format?: Excel.Interfaces.ChartLeaderLinesFormatUpdateData;
+ }
+ /** An interface for updating data on the `ChartLeaderLinesFormat` object, for use in `chartLeaderLinesFormat.set({ ... })`. */
+ interface ChartLeaderLinesFormatUpdateData {
+ /**
+ * Gets an object that represents the line formatting of chart leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ line?: Excel.Interfaces.ChartLineFormatUpdateData;
+ }
/** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */
interface CustomXmlPartScopedCollectionUpdateData {
items?: Excel.Interfaces.CustomXmlPartData[];
@@ -75577,6 +76903,23 @@ declare namespace Excel {
interface LinkedDataTypeCollectionUpdateData {
items?: Excel.Interfaces.LinkedDataTypeData[];
}
+ /** An interface for updating data on the `LinkedEntityDataDomain` object, for use in `linkedEntityDataDomain.set({ ... })`. */
+ interface LinkedEntityDataDomainUpdateData {
+ /**
+ * Gets or sets the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
+ If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
+ If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
+ }
+ /** An interface for updating data on the `LinkedEntityDataDomainCollection` object, for use in `linkedEntityDataDomainCollection.set({ ... })`. */
+ interface LinkedEntityDataDomainCollectionUpdateData {
+ items?: Excel.Interfaces.LinkedEntityDataDomainData[];
+ }
/** An interface for updating data on the `NamedSheetView` object, for use in `namedSheetView.set({ ... })`. */
interface NamedSheetViewUpdateData {
/**
@@ -76372,6 +77715,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
position?: number;
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showDataTypeIcons?: boolean;
/**
* Specifies if gridlines are visible to the user.
*
@@ -78745,6 +80096,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
format?: Excel.Interfaces.ChartDataLabelFormatData;
+ /**
+ * Gets an object that represents the leader lines of the data labels.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ leaderLines?: Excel.Interfaces.ChartLeaderLinesData;
/**
* Specifies if data labels automatically generate appropriate text based on context.
*
@@ -78752,6 +80111,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
autoText?: boolean;
+ /**
+ * Gets or sets the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data labels are not geometric shapes.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
/**
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
This property is valid only when the `TextOrientation` of data label is 0.
@@ -78788,6 +80156,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
separator?: string;
+ /**
+ * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showAsStickyCallout?: boolean;
/**
* Specifies if the data label bubble size is visible.
*
@@ -78802,6 +80178,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
showCategoryName?: boolean;
+ /**
+ * Gets or sets a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showLeaderLines?: boolean;
/**
* Specifies if the data label legend key is visible.
*
@@ -78869,6 +80253,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
formula?: string;
+ /**
+ * Gets or sets the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data label is not a geometric shape.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
/**
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
*
@@ -78919,6 +80312,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.7]
*/
separator?: string;
+ /**
+ * Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showAsStickyCallout?: boolean;
/**
* Specifies if the data label bubble size is visible.
*
@@ -79015,6 +80416,25 @@ declare namespace Excel {
*/
font?: Excel.Interfaces.ChartFontData;
}
+ /** An interface describing the data returned by calling `chartDataLabelAnchor.toJSON()`. */
+ interface ChartDataLabelAnchorData {
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ left?: number;
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ top?: number;
+ }
/** An interface describing the data returned by calling `chartDataTable.toJSON()`. */
interface ChartDataTableData {
/**
@@ -79909,6 +81329,28 @@ declare namespace Excel {
*/
border?: Excel.Interfaces.ChartBorderData;
}
+ /** An interface describing the data returned by calling `chartLeaderLines.toJSON()`. */
+ interface ChartLeaderLinesData {
+ /**
+ * Represents the formatting of leader lines of data labels in a series.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ format?: Excel.Interfaces.ChartLeaderLinesFormatData;
+ }
+ /** An interface describing the data returned by calling `chartLeaderLinesFormat.toJSON()`. */
+ interface ChartLeaderLinesFormatData {
+ /**
+ * Gets an object that represents the line formatting of chart leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ line?: Excel.Interfaces.ChartLineFormatData;
+ }
/** An interface describing the data returned by calling `tableSort.toJSON()`. */
interface TableSortData {
/**
@@ -82587,6 +84029,97 @@ declare namespace Excel {
interface LinkedDataTypeCollectionData {
items?: Excel.Interfaces.LinkedDataTypeData[];
}
+ /** An interface describing the data returned by calling `linkedEntityDataDomain.toJSON()`. */
+ interface LinkedEntityDataDomainData {
+ /**
+ * Gets the name of the data provider for the linked entity data domain.
+ This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ dataProvider?: string;
+ /**
+ * Gets the ID of the linked entity data domain defined by Office Add-ins.
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id?: string;
+ /**
+ * Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
+ Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ lastRefreshed?: Date;
+ /**
+ * Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ loadFunctionId?: string;
+ /**
+ * Gets the name of the linked entity data domain.
+ This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ name?: string;
+ /**
+ * Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
+ The refresh interval only applies if the `refreshMode` is set to "Periodic".
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ periodicRefreshInterval?: number;
+ /**
+ * Gets or sets the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
+ If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
+ If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
+ /**
+ * Gets the service ID of the linked entity data domain.
+ This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
+ This ID never changes across user sessions.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ serviceId?: number;
+ /**
+ * Gets all the refresh modes supported by the linked entity data domain.
+ This array can change based on the information provided by the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];
+ }
+ /** An interface describing the data returned by calling `linkedEntityDataDomainCollection.toJSON()`. */
+ interface LinkedEntityDataDomainCollectionData {
+ items?: Excel.Interfaces.LinkedEntityDataDomainData[];
+ }
/** An interface describing the data returned by calling `namedSheetView.toJSON()`. */
interface NamedSheetViewData {
/**
@@ -83685,6 +85218,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
position?: boolean;
+ /**
+ * Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showDataTypeIcons?: boolean;
/**
* Specifies if gridlines are visible to the user.
*
@@ -83813,6 +85354,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
position?: boolean;
+ /**
+ * For EACH ITEM in the collection: Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showDataTypeIcons?: boolean;
/**
* For EACH ITEM in the collection: Specifies if gridlines are visible to the user.
*
@@ -87692,6 +89241,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
format?: Excel.Interfaces.ChartDataLabelFormatLoadOptions;
+ /**
+ * Gets an object that represents the leader lines of the data labels.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ leaderLines?: Excel.Interfaces.ChartLeaderLinesLoadOptions;
/**
* Specifies if data labels automatically generate appropriate text based on context.
*
@@ -87699,6 +89256,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
autoText?: boolean;
+ /**
+ * Gets or sets the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data labels are not geometric shapes.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType?: boolean;
/**
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
This property is valid only when the `TextOrientation` of data label is 0.
@@ -87735,6 +89301,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
separator?: boolean;
+ /**
+ * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showAsStickyCallout?: boolean;
/**
* Specifies if the data label bubble size is visible.
*
@@ -87749,6 +89323,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.1]
*/
showCategoryName?: boolean;
+ /**
+ * Gets or sets a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showLeaderLines?: boolean;
/**
* Specifies if the data label legend key is visible.
*
@@ -87825,6 +89407,15 @@ declare namespace Excel {
* [Api set: ExcelApi 1.8]
*/
formula?: boolean;
+ /**
+ * Gets or sets the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
+ Value is `null` if the data label is not a geometric shape.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ geometricShapeType?: boolean;
/**
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
*
@@ -87875,6 +89466,14 @@ declare namespace Excel {
* [Api set: ExcelApi 1.7]
*/
separator?: boolean;
+ /**
+ * Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ showAsStickyCallout?: boolean;
/**
* Specifies if the data label bubble size is visible.
*
@@ -87980,6 +89579,35 @@ declare namespace Excel {
*/
font?: Excel.Interfaces.ChartFontLoadOptions;
}
+ /**
+ * Represents the chart data label anchor.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface ChartDataLabelAnchorLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ left?: boolean;
+ /**
+ * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ top?: boolean;
+ }
/**
* Represents the data table object of a chart.
*
@@ -89218,6 +90846,48 @@ declare namespace Excel {
*/
border?: Excel.Interfaces.ChartBorderLoadOptions;
}
+ /**
+ * Gets an object that represents the formatting of chart leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface ChartLeaderLinesLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Represents the formatting of leader lines of data labels in a series.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ format?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions;
+ }
+ /**
+ * Encapsulates the format properties for leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface ChartLeaderLinesFormatLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Gets an object that represents the line formatting of chart leader lines.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ line?: Excel.Interfaces.ChartLineFormatLoadOptions;
+ }
/**
* Manages sorting operations on `Table` objects.
*
@@ -94431,6 +96101,203 @@ declare namespace Excel {
*/
supportedRefreshModes?: boolean;
}
+ /**
+ * Represents a specific category or field of information that shares some common characteristics or attributes.
+ A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
+ A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityDataDomainLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * Gets the name of the data provider for the linked entity data domain.
+ This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ dataProvider?: boolean;
+ /**
+ * Gets the ID of the linked entity data domain defined by Office Add-ins.
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id?: boolean;
+ /**
+ * Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
+ Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ lastRefreshed?: boolean;
+ /**
+ * Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ loadFunctionId?: boolean;
+ /**
+ * Gets the name of the linked entity data domain.
+ This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ name?: boolean;
+ /**
+ * Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
+ The refresh interval only applies if the `refreshMode` is set to "Periodic".
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ periodicRefreshInterval?: boolean;
+ /**
+ * Gets or sets the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
+ If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
+ If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshMode?: boolean;
+ /**
+ * Gets the service ID of the linked entity data domain.
+ This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
+ This ID never changes across user sessions.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ serviceId?: boolean;
+ /**
+ * Gets all the refresh modes supported by the linked entity data domain.
+ This array can change based on the information provided by the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ supportedRefreshModes?: boolean;
+ }
+ /**
+ * Represents a collection of `LinkedEntityDataDomain` objects.
+ The collection can contain linked entity data domains such as stocks, geography or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ interface LinkedEntityDataDomainCollectionLoadOptions {
+ /**
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
+ */
+ $all?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the name of the data provider for the linked entity data domain.
+ This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ dataProvider?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the ID of the linked entity data domain defined by Office Add-ins.
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ id?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
+ Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ lastRefreshed?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
+ This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ loadFunctionId?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the name of the linked entity data domain.
+ This name can change based on the information from the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ name?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
+ The refresh interval only applies if the `refreshMode` is set to "Periodic".
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ periodicRefreshInterval?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets or sets the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
+ If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
+ If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ refreshMode?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets the service ID of the linked entity data domain.
+ This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
+ This ID never changes across user sessions.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ serviceId?: boolean;
+ /**
+ * For EACH ITEM in the collection: Gets all the refresh modes supported by the linked entity data domain.
+ This array can change based on the information provided by the data provider.
+ *
+ * @remarks
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+ * @beta
+ */
+ supportedRefreshModes?: boolean;
+ }
/**
* Represents a named sheet view of a worksheet. A sheet view stores the sort and filter rules for a particular worksheet.
Every sheet view (even a temporary sheet view) has a unique, worksheet-scoped name that is used to access the view.
diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts
index 7bb67065d0a6c8..77d52eacc62176 100644
--- a/types/office-js/index.d.ts
+++ b/types/office-js/index.d.ts
@@ -24171,9 +24171,9 @@ declare namespace Excel {
/**
* Represents an unknown cell control.
* This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
- *
+ *
* @remarks
- * [Api set: ExcelApi 1.18]
+ * [Api set: ExcelApi 1.18]
*/
interface UnknownCellControl {
type: CellControlType.unknown;
@@ -24181,9 +24181,9 @@ declare namespace Excel {
/**
* Represents an empty cell control.
* This represents the state where a cell does not have a control.
- *
+ *
* @remarks
- * [Api set: ExcelApi 1.18]
+ * [Api set: ExcelApi 1.18]
*/
interface EmptyCellControl {
type: CellControlType.empty;
@@ -24191,28 +24191,28 @@ declare namespace Excel {
/**
* Represents the result of a query that resulted in multiple cell controls.
* If the result has multiple controls, then they can't be represented as a single result.
- *
+ *
* @remarks
- * [Api set: ExcelApi 1.18]
+ * [Api set: ExcelApi 1.18]
*/
interface MixedCellControl {
type: CellControlType.mixed;
}
/**
- * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
- *
- * @remarks
- * [Api set: ExcelApi 1.18]
- */
+ * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
+ *
+ * @remarks
+ * [Api set: ExcelApi 1.18]
+ */
interface CheckboxCellControl {
type: CellControlType.checkbox;
}
/**
- * Represents an interactable control inside of a cell.
- *
- * @remarks
- * [Api set: ExcelApi 1.18]
- */
+ * Represents an interactable control inside of a cell.
+ *
+ * @remarks
+ * [Api set: ExcelApi 1.18]
+ */
type CellControl = UnknownCellControl | EmptyCellControl | MixedCellControl | CheckboxCellControl;
/**
* Represents a 2D array of cell values.
@@ -37834,24 +37834,24 @@ declare namespace Excel {
}
/**
* Represents a sequence of one or more characters that share the same font attributes in a cell. Can be used as the `textRuns` properties of `getCellProperties` or the `textRuns` input parameter of `setCellProperties`.
- *
+ *
* @remarks
* [Api set: ExcelApi 1.18]
*/
interface RangeTextRun {
/**
* The font attributes (such as font name, font size, and color) applied to this text run.
- *
+ *
* @remarks
* [Api set: ExcelApi 1.18]
*/
font?: Excel.CellPropertiesFont;
/**
* The text of this text run.
- *
+ *
* @remarks
* [Api set: ExcelApi 1.18]
- */
+ */
text: string;
}
/**
@@ -65677,6 +65677,7 @@ declare namespace Excel {
pivotTableRangeConflict = "PivotTableRangeConflict",
powerQueryRefreshResourceChallenge = "PowerQueryRefreshResourceChallenge",
rangeExceedsLimit = "RangeExceedsLimit",
+ rangeImageExceedsLimit = "RangeImageExceedsLimit",
refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked",
requestAborted = "RequestAborted",
responsePayloadSizeLimitExceeded = "ResponsePayloadSizeLimitExceeded",
diff --git a/types/oracledb/index.d.ts b/types/oracledb/index.d.ts
index 955699fe34e59c..d061899a4e221b 100644
--- a/types/oracledb/index.d.ts
+++ b/types/oracledb/index.d.ts
@@ -4667,6 +4667,96 @@ declare namespace OracleDB {
function startup(creds: DBCredentials, opts?: StartupOptions): Promise;
function startup(creds: DBCredentials, opts: StartupOptions, cb: (err: Error) => void): void;
function startup(creds: DBCredentials, cb: (err: Error) => void): void;
+
+ /**
+ * Type representing the trace context object.
+ *
+ * @since 6.7.0
+ */
+ type TraceContext = Record;
+
+ /**
+ * Base class for handling tracing.
+ *
+ * @since 6.7.0
+ */
+ class TraceHandlerBase {
+ constructor();
+
+ /**
+ * Checks if sending traces is enabled.
+ */
+ isEnabled(): boolean;
+
+ /**
+ * Enables sending traces.
+ */
+ enable(): void;
+
+ /**
+ * Disables sending traces.
+ */
+ disable(): void;
+
+ /**
+ * Called before invoking a public async method.
+ * @param traceContext input/output trace context object.
+ */
+ onEnterFn(traceContext: TraceContext): void;
+
+ /**
+ * Called after invoking a public async method.
+ * @param traceContext input/output trace context object.
+ */
+ onExitFn(traceContext: TraceContext): void;
+
+ /**
+ * Called when a round trip is begun.
+ * @param traceContext input/output trace context object.
+ */
+ onBeginRoundTrip(traceContext: TraceContext): void;
+
+ /**
+ * Called when a round trip has ended.
+ * @param traceContext input/output trace context object.
+ */
+ onEndRoundTrip(traceContext: TraceContext): void;
+ }
+
+ /*
+ * Assigns a derived object that implements the hooks in the TraceHandlerBase class.
+ * If no argument is provided, it clears the previously assigned instance.
+ *
+ * @since 6.7.0
+ */
+ function setTraceInstance(obj?: TraceHandlerBase): void;
+
+ /*
+ * Retrieves the derived object that implements the hooks in the TraceHandlerBase class.
+ *
+ * @since 6.7.0
+ */
+ function getTraceInstance(): TraceHandlerBase | undefined;
+
+ /*
+ * Verify if Tracing is enabled.
+ *
+ * @since 6.7.0
+ */
+ function isEnabled(): boolean | undefined;
+
+ /**
+ * traceHandler property containing the TraceHandlerBase class.
+ *
+ * @since 6.7.0
+ */
+ interface traceHandler {
+ TraceHandlerBase: typeof TraceHandlerBase;
+ setTraceInstance(obj?: TraceHandlerBase): void;
+ getTraceInstance(): TraceHandlerBase | undefined;
+ isEnabled(): boolean | undefined;
+ }
+ const traceHandler: traceHandler;
}
export = OracleDB;
diff --git a/types/oracledb/oracledb-tests.ts b/types/oracledb/oracledb-tests.ts
index fd37fcefc541b3..4e9ae3e787856c 100644
--- a/types/oracledb/oracledb-tests.ts
+++ b/types/oracledb/oracledb-tests.ts
@@ -705,6 +705,10 @@ export const version6Tests = async (): Promise => {
console.log(defaultOracledb.DB_TYPE_VECTOR);
console.log(defaultOracledb.JsonId);
+ console.log(defaultOracledb.traceHandler.TraceHandlerBase);
+ console.log(defaultOracledb.traceHandler.setTraceInstance());
+ console.log(defaultOracledb.traceHandler.getTraceInstance());
+ console.log(defaultOracledb.traceHandler.isEnabled());
// pass random 12 byte value to JsonId which is generated
// by DB for SODA document.