This browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can trysigning in orchanging directories.
Access to this page requires authorization. You can trychanging directories.
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 forLinkedEntityCellValue 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.
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| data | Gets the name of the data provider for the linked entity data domain. This name can change based on the information provided by the data provider. |
| id | 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. |
| last | Gets the date and time (in the local time zone) since the workbook was opened and the |
| load | Gets the ID of the custom function that is called on demand to resolve or refresh the |
| name | Gets the name of the linked entity data domain. This name can change based on the information provided by the data provider. |
| periodic | Gets the frequency, in seconds, at which |
| refresh | Specifies the refresh mode that defines how and when the |
| service | 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. |
| supported | 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. |
| delete() | Deletes this object from the |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property | Queues up a command to load the specified properties of the object. You must call |
| load(property | Queues up a command to load the specified properties of the object. You must call |
| refresh() | Refreshes all |
| toJSON() | Overrides the JavaScript |
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 provided by the data provider.
readonly dataProvider: string;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.
readonly id: string;string
Gets the date and time (in the local time zone) since the workbook was opened and theLinkedEntityCellValue objects of this linked entity data domain were last refreshed. Returnsundefined ifLinkedEntityCellValue objects have not been refreshed since the workbook was opened.
readonly lastRefreshed: Date;Date
Gets the ID of the custom function that is called on demand to resolve or refresh theLinkedEntityCellValue objects of the linked entity data domain defined by Office Add-ins. For further information, seeAutogenerate 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.
readonly loadFunctionId: string;string
Gets the name of the linked entity data domain. This name can change based on the information provided by the data provider.
readonly name: string;string
Gets the frequency, in seconds, at whichLinkedEntityCellValue objects of this linked entity data domain are refreshed automatically. The refresh interval only applies if therefreshMode is set to "Periodic".
readonly periodicRefreshInterval: number;number
Specifies the refresh mode that defines how and when theLinkedEntityCellValue 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 theperiodicRefreshInterval of this linked entity data domain.
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";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.
readonly serviceId: number;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.
readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];Deletes this object from theLinkedEntityDataDomainCollection. Once the linked entity data domain is deleted, newLinkedEntityCellValue objects of this linked entity data domain can't be created and existingLinkedEntityCellValue objects can't be refreshed. An Office Add-in can only delete linked entity data domains that it created.
delete(): void;void
Queues up a command to load the specified properties of the object. You must callcontext.sync() before reading the properties.
load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;Provides options for which properties of the object to load.
Queues up a command to load the specified properties of the object. You must callcontext.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Queues up a command to load the specified properties of the object. You must callcontext.sync() before reading the properties.
load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.LinkedEntityDataDomain;{select?: string;expand?: string;}
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, andpropertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Refreshes allLinkedEntityCellValue objects of this linked entity data domain. The refresh request can fail if the data provider is busy or temporarily inaccessible.
refresh(): void;void
Overrides the JavaScripttoJSON() method in order to provide more useful output when an API object is passed toJSON.stringify(). (JSON.stringify, in turn, calls thetoJSON method of the object that's passed to it.) Whereas the originalExcel.LinkedEntityDataDomain object is an API object, thetoJSON method returns a plain JavaScript object (typed asExcel.Interfaces.LinkedEntityDataDomainData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;Was this page helpful?
Was this page helpful?