Excel.LinkedEntityDataDomain class
Représente une catégorie ou un champ d’informations spécifique qui partagent des caractéristiques ou des attributs communs. Un domaine de données est lié à un fournisseur de données, qui fait office de source de données pour LinkedEntityCellValue les objets du classeur. Un domaine de données est une catégorie de données, telle que les actions, la géographie ou les devises. Un fournisseur de données est un service, tel que Bing, Power BI ou un complément Office.
- Extends
Remarques
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| data |
Obtient le nom du fournisseur de données pour le domaine de données d’entité liée. Ce nom peut changer en fonction des informations fournies par le fournisseur de données. |
| id | Obtient l’ID du domaine de données d’entité liée défini par les compléments Office. Cet ID n’est pas applicable aux domaines de données d’entité liés définis par les fournisseurs de données de service, tels que Bing ou Power BI. |
| last |
Obtient la date et l’heure (dans le fuseau horaire local) depuis l’ouverture du classeur et la |
| load |
Obtient l’ID de la fonction personnalisée appelée à la demande pour résoudre ou actualiser les |
| name | Obtient le nom du domaine de données d’entité liée. Ce nom peut changer en fonction des informations fournies par le fournisseur de données. |
| periodic |
Obtient la fréquence, en secondes, à laquelle |
| refresh |
Spécifie le mode d’actualisation qui définit comment et quand les |
| service |
Obtient l’ID de service du domaine de données d’entité liée. Cet ID est une valeur réservée de manière permanente pour tous les domaines de données d’entité liés qui sont définis par les fournisseurs de données de service, tels que Bing ou Power BI, ou définis par les compléments Office. Cet ID ne change jamais entre les sessions utilisateur. |
| supported |
Obtient tous les modes d’actualisation pris en charge par le domaine de données d’entité liée. Ce tableau peut changer en fonction des informations fournies par le fournisseur de données. |
Méthodes
| delete() | Supprime cet objet du |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| refresh() | Actualise tous les |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
dataProvider
Obtient le nom du fournisseur de données pour le domaine de données d’entité liée. Ce nom peut changer en fonction des informations fournies par le fournisseur de données.
readonly dataProvider: string;Valeur de propriété
string
Remarques
id
Obtient l’ID du domaine de données d’entité liée défini par les compléments Office. Cet ID n’est pas applicable aux domaines de données d’entité liés définis par les fournisseurs de données de service, tels que Bing ou Power BI.
readonly id: string;Valeur de propriété
string
Remarques
lastRefreshed
Obtient la date et l’heure (dans le fuseau horaire local) depuis l’ouverture du classeur et la LinkedEntityCellValue dernière actualisation des objets de ce domaine de données d’entité liée. Retourne undefined si LinkedEntityCellValue les objets n’ont pas été actualisés depuis l’ouverture du classeur.
readonly lastRefreshed: Date;Valeur de propriété
Date
Remarques
loadFunctionId
Obtient l’ID de la fonction personnalisée appelée à la demande pour résoudre ou actualiser les LinkedEntityCellValue objets du domaine de données d’entité liée défini par les compléments Office. Pour plus d’informations, consultez Générer automatiquement des métadonnées JSON pour les fonctions personnalisées : ID. Cet ID n’est pas applicable aux domaines de données d’entité liés définis par les fournisseurs de données de service, tels que Bing ou Power BI.
readonly loadFunctionId: string;Valeur de propriété
string
Remarques
name
Obtient le nom du domaine de données d’entité liée. Ce nom peut changer en fonction des informations fournies par le fournisseur de données.
readonly name: string;Valeur de propriété
string
Remarques
periodicRefreshInterval
Obtient la fréquence, en secondes, à laquelle LinkedEntityCellValue les objets de ce domaine de données d’entité liée sont actualisés automatiquement. L’intervalle d’actualisation s’applique uniquement si est refreshMode défini sur « Périodique ».
readonly periodicRefreshInterval: number;Valeur de propriété
number
Remarques
refreshMode
Spécifie le mode d’actualisation qui définit comment et quand les LinkedEntityCellValue objets de ce domaine de données d’entité liée sont actualisés. Si le mode d’actualisation défini n’est pas pris en charge par ce domaine de données d’entité liée, le mode d’actualisation actuel n’est pas modifié. Si le mode d’actualisation est défini sur « Périodique », l’intervalle d’actualisation est défini sur le periodicRefreshInterval de ce domaine de données d’entité liée.
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";Valeur de propriété
Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"
Remarques
serviceId
Obtient l’ID de service du domaine de données d’entité liée. Cet ID est une valeur réservée de manière permanente pour tous les domaines de données d’entité liés qui sont définis par les fournisseurs de données de service, tels que Bing ou Power BI, ou définis par les compléments Office. Cet ID ne change jamais entre les sessions utilisateur.
readonly serviceId: number;Valeur de propriété
number
Remarques
supportedRefreshModes
Obtient tous les modes d’actualisation pris en charge par le domaine de données d’entité liée. Ce tableau peut changer en fonction des informations fournies par le fournisseur de données.
readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];Valeur de propriété
Remarques
Détails de la méthode
delete()
Supprime cet objet du LinkedEntityDataDomainCollection. Une fois le domaine de données d’entité liée supprimé, les nouveaux LinkedEntityCellValue objets de ce domaine de données d’entité liée ne peuvent pas être créés et les objets existants LinkedEntityCellValue ne peuvent pas être actualisés. Un complément Office peut uniquement supprimer les domaines de données d’entité liés qu’il a créés.
delete(): void;Retours
void
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.LinkedEntityDataDomain;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
refresh()
Actualise tous les LinkedEntityCellValue objets de ce domaine de données d’entité liée. La demande d’actualisation peut échouer si le fournisseur de données est occupé ou temporairement inaccessible.
refresh(): void;Retours
void
Remarques
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.LinkedEntityDataDomain est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.LinkedEntityDataDomainDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;