Partager via


Excel.LinkedEntityDataDomainCreateOptions interface

Représente les options utilisées pour créer l’objet LinkedEntityDataDomain ajouté au LinkedEntityDataDomainCollection.

Remarques

[ Ensemble d’API : ExcelApi 1.19 ]

Propriétés

dataProvider

Spécifie le nom du fournisseur de données pour le domaine de données d’entité liée.

id

Spécifie l’ID du domaine de données d’entité liée. Cet ID doit être unique dans tous les domaines de données d’entité liée définis par ce complément Office.

loadFunctionId

Spécifie l’ID de la fonction personnalisée qui sera appelée à la demande pour résoudre ou actualiser les LinkedEntityCellValue objets de ce domaine de données d’entité liée. Pour plus d’informations, consultez Générer automatiquement des métadonnées JSON pour les fonctions personnalisées : ID.

name

Spécifie le nom du domaine de données d’entité liée. Ce nom doit être unique dans tous les domaines de données d’entité liés définis par ce complément Office.

periodicRefreshInterval

Spécifie la fréquence, en secondes, à laquelle LinkedEntityCellValue les objets de ce domaine de données d’entité liée sont actualisés automatiquement. La valeur minimale valide est 300. Cette propriété est requise si le supportedRefreshModes tableau contient la valeur « Périodique ». Cette propriété s’applique uniquement si le refreshMode du domaine de données d’entité liée est défini sur « Périodique ».

supportedRefreshModes

Spécifie tous les modes d’actualisation pris en charge par le domaine de données d’entité liée. La valeur par défaut est ["Manual"], qui est toujours prise en charge même si elle n’est pas spécifiée. Le mode d’actualisation enregistré dans le classeur est chargé en tant que mode d’actualisation par défaut du domaine de données d’entité liée sur le classeur suivant ouvert. Si le mode d’actualisation n’a pas été enregistré dans le classeur, la première valeur du tableau est définie comme mode d’actualisation par défaut du domaine de données d’entité liée. Si le tableau a la valeur « Periodic », la periodicRefreshInterval propriété doit également être définie pour le domaine de données d’entité liée.

Détails de la propriété

dataProvider

Spécifie le nom du fournisseur de données pour le domaine de données d’entité liée.

dataProvider: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.19 ]

id

Spécifie l’ID du domaine de données d’entité liée. Cet ID doit être unique dans tous les domaines de données d’entité liée définis par ce complément Office.

id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.19 ]

loadFunctionId

Spécifie l’ID de la fonction personnalisée qui sera appelée à la demande pour résoudre ou actualiser les LinkedEntityCellValue objets de ce domaine de données d’entité liée. Pour plus d’informations, consultez Générer automatiquement des métadonnées JSON pour les fonctions personnalisées : ID.

loadFunctionId: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.19 ]

name

Spécifie le nom du domaine de données d’entité liée. Ce nom doit être unique dans tous les domaines de données d’entité liés définis par ce complément Office.

name: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.19 ]

periodicRefreshInterval

Spécifie la fréquence, en secondes, à laquelle LinkedEntityCellValue les objets de ce domaine de données d’entité liée sont actualisés automatiquement. La valeur minimale valide est 300. Cette propriété est requise si le supportedRefreshModes tableau contient la valeur « Périodique ». Cette propriété s’applique uniquement si le refreshMode du domaine de données d’entité liée est défini sur « Périodique ».

periodicRefreshInterval?: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.19 ]

supportedRefreshModes

Spécifie tous les modes d’actualisation pris en charge par le domaine de données d’entité liée. La valeur par défaut est ["Manual"], qui est toujours prise en charge même si elle n’est pas spécifiée. Le mode d’actualisation enregistré dans le classeur est chargé en tant que mode d’actualisation par défaut du domaine de données d’entité liée sur le classeur suivant ouvert. Si le mode d’actualisation n’a pas été enregistré dans le classeur, la première valeur du tableau est définie comme mode d’actualisation par défaut du domaine de données d’entité liée. Si le tableau a la valeur « Periodic », la periodicRefreshInterval propriété doit également être définie pour le domaine de données d’entité liée.

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.19 ]