Excel.LinkedEntityDataDomain class
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.
- Extends
Remarks
Properties
| 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. |
Methods
| 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 |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
dataProvider
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;Property Value
string
Remarks
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.
readonly id: string;Property Value
string
Remarks
lastRefreshed
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.
readonly lastRefreshed: Date;Property Value
Date
Remarks
loadFunctionId
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 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.
readonly loadFunctionId: string;Property Value
string
Remarks
name
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;Property Value
string
Remarks
periodicRefreshInterval
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".
readonly periodicRefreshInterval: number;Property Value
number
Remarks
refreshMode
Specifies 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.
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";Property Value
Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"
Remarks
serviceId
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;Property Value
number
Remarks
supportedRefreshModes
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[];Property Value
Remarks
Method Details
delete()
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.
delete(): void;Returns
void
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.LinkedEntityDataDomain;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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.
Returns
refresh()
Refreshes all LinkedEntityCellValue objects of this linked entity data ___domain. The refresh request can fail if the data provider is busy or temporarily inaccessible.
refresh(): void;Returns
void
Remarks
toJSON()
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;