Excel.LinkedEntityDataDomain class

Paquet:: excel

Représente une catégorie ou un champ d’information spécifique qui partage certaines caractéristiques ou 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: OfficeExtension.ClientObject

Remarques

Jeu d’API : ExcelApi 1.19

Cette classe n’est pas prise en charge dans Excel sur le Web.

Utilisateur

Excel.LinkedEntityDataDomainCollection : getItem, getItemAt, getItemByName, getItemByNameOrNullObject, getItemOrNullObject, items

Exemples

// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;

    // Get a specific data domain by ID and refresh it.
    const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
    productsDomain.refresh();
    await context.sync();
});

Propriétés

context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
dataProvider	Obtient le nom du fournisseur de données pour le domaine de données de l’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 ne s’applique pas aux domaines de données d’entité liés définis par des fournisseurs de données de service, tels que Bing ou Power BI.
lastRefreshed	Obtient la date et l’heure (dans le fuseau horaire local) depuis l’ouverture du classeur et `LinkedEntityCellValue` la dernière actualisation des objets de ce domaine de données d’entité liée. Renvoie `undefined` si `LinkedEntityCellValue` les objets n’ont pas été actualisés depuis l’ouverture du classeur.
loadFunctionId	Obtient l’ID de la fonction personnalisée qui est appelée à la demande pour résoudre ou actualiser les `LinkedEntityCellValue` objets du domaine de données d’entité lié 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 ne s’applique pas aux domaines de données d’entité liés définis par des fournisseurs de données de service, tels que Bing ou Power BI.
name	Obtient le nom du domaine de données de l’entité liée. Ce nom peut changer en fonction des informations fournies par le fournisseur de données.
periodicRefreshInterval	Obtient la fréquence, en secondes, à laquelle `LinkedEntityCellValue` les objets de ce domaine de données d’entité lié sont actualisés automatiquement. L’intervalle d’actualisation ne s’applique que si la `refreshMode` valeur est « Périodique ».
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 en cours de définition 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.
serviceId	Obtient l’ID de service du domaine de données de l’entité liée. Cet ID est une valeur réservée de façon permanente pour tous les domaines de données d’entité liés qui sont définis par des fournisseurs de données de service, tels que Bing ou Power BI, ou définis par des compléments Office. Cet identifiant ne change jamais entre les sessions utilisateur.
supportedRefreshModes	Obtient tous les modes d’actualisation pris en charge par le domaine de données de l’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 `LinkedEntityDataDomainCollection`. Une fois le domaine de données d’entité lié supprimé, les nouveaux `LinkedEntityCellValue` objets de ce domaine de données d’entité lié ne peuvent pas être créés et les objets existants `LinkedEntityCellValue` ne peuvent pas être actualisés. Un complément Office peut uniquement supprimer des domaines de données d’entité liés qu’il a créés.
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(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(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.
refresh()	Actualise tous les `LinkedEntityCellValue` objets de ce domaine de données d’entité lié. La demande d’actualisation peut échouer si le fournisseur de données est occupé ou temporairement inaccessible.
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 simple (typé ) `Excel.Interfaces.LinkedEntityDataDomainData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

dataProvider

Obtient le nom du fournisseur de données pour le domaine de données de l’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

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

id

Obtient l’ID du domaine de données d’entité liée défini par les compléments Office. Cet ID ne s’applique pas aux domaines de données d’entité liés définis par des fournisseurs de données de service, tels que Bing ou Power BI.

readonly id: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

lastRefreshed

Obtient la date et l’heure (dans le fuseau horaire local) depuis l’ouverture du classeur et LinkedEntityCellValue la dernière actualisation des objets de ce domaine de données d’entité liée. Renvoie 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

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

loadFunctionId

Obtient l’ID de la fonction personnalisée qui est appelée à la demande pour résoudre ou actualiser les LinkedEntityCellValue objets du domaine de données d’entité lié 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 ne s’applique pas aux domaines de données d’entité liés définis par des fournisseurs de données de service, tels que Bing ou Power BI.

readonly loadFunctionId: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

name

Obtient le nom du domaine de données de l’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

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

periodicRefreshInterval

Obtient la fréquence, en secondes, à laquelle LinkedEntityCellValue les objets de ce domaine de données d’entité lié sont actualisés automatiquement. L’intervalle d’actualisation ne s’applique que si la refreshMode valeur est « Périodique ».

readonly periodicRefreshInterval: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

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 en cours de définition 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

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

serviceId

Obtient l’ID de service du domaine de données de l’entité liée. Cet ID est une valeur réservée de façon permanente pour tous les domaines de données d’entité liés qui sont définis par des fournisseurs de données de service, tels que Bing ou Power BI, ou définis par des compléments Office. Cet identifiant ne change jamais entre les sessions utilisateur.

readonly serviceId: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

supportedRefreshModes

Obtient tous les modes d’actualisation pris en charge par le domaine de données de l’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é

Excel.LinkedEntityDataDomainRefreshMode[]

Remarques

Jeu d’API : ExcelApi 1.19

Cette propriété n’est pas prise en charge dans Excel sur le Web.

Détails de la méthode

delete()

Supprime cet objet du LinkedEntityDataDomainCollection. Une fois le domaine de données d’entité lié supprimé, les nouveaux LinkedEntityCellValue objets de ce domaine de données d’entité lié ne peuvent pas être créés et les objets existants LinkedEntityCellValue ne peuvent pas être actualisés. Un complément Office peut uniquement supprimer des domaines de données d’entité liés qu’il a créés.

delete(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

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

options: Excel.Interfaces.LinkedEntityDataDomainLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.LinkedEntityDataDomain

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 spécifiant les propriétés à charger.

Retours

Excel.LinkedEntityDataDomain

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

Excel.LinkedEntityDataDomain

refresh()

Actualise tous les LinkedEntityCellValue objets de ce domaine de données d’entité lié. La demande d’actualisation peut échouer si le fournisseur de données est occupé ou temporairement inaccessible.

refresh(): void;

Retours

void

Remarques

Jeu d’API : ExcelApi 1.19

Cette méthode n’est pas prise en charge dans Excel sur le Web.

Exemples

// Refreshes all linked entity cell values for a specific data domain.
await Excel.run(async (context) => {
    const dataDomains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;

    // Get a specific data domain by ID and refresh it.
    const productsDomain: Excel.LinkedEntityDataDomain = dataDomains.getItem("products");
    productsDomain.refresh();
    await context.sync();
});

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 simple (typé ) Excel.Interfaces.LinkedEntityDataDomainDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;

Retours

Excel.Interfaces.LinkedEntityDataDomainData

Commentaires

Cette page a-t-elle été utile ?