Excel.LinkedEntityDataDomainCreateOptions interface
Représente les options utilisées pour créer l’objet LinkedEntityDataDomain ajouté au LinkedEntityDataDomainCollection.
Remarques
Cette interface n’est pas prise en charge dans Excel sur le Web.
Utilisateur
Exemples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-linked-entities.yaml
// Register the product, category, and supplier data sources with Excel.
await Excel.run(async (context) => {
const domains: Excel.LinkedEntityDataDomainCollection = context.workbook.linkedEntityDataDomains;
const refreshModes: Excel.LinkedEntityDataDomainRefreshMode[] = [
Excel.LinkedEntityDataDomainRefreshMode.manual,
Excel.LinkedEntityDataDomainRefreshMode.onLoad,
Excel.LinkedEntityDataDomainRefreshMode.periodic
];
// Script Lab prefixes the function ID with the companion sample's name, without spaces.
const loadFunctionId = "LINKEDENTITYLOADSERVICE.CONTOSOLOADSERVICE";
const options: Excel.LinkedEntityDataDomainCreateOptions[] = [
{
dataProvider: "Contoso",
id: "products",
name: "Products",
loadFunctionId,
periodicRefreshInterval: 300,
supportedRefreshModes: refreshModes
},
{
dataProvider: "Contoso",
id: "categories",
name: "Categories",
loadFunctionId,
periodicRefreshInterval: 300,
supportedRefreshModes: refreshModes
},
{
dataProvider: "Contoso",
id: "suppliers",
name: "Suppliers",
loadFunctionId
}
];
// Replace only this sample's domains so registration is repeatable.
const existingDomains: Excel.LinkedEntityDataDomain[] = options.map((options) =>
domains.getItemOrNullObject(options.id)
);
await context.sync();
existingDomains.forEach((domain) => {
if (!domain.isNullObject) {
domain.delete();
}
});
options.forEach((options) => domains.add(options));
await context.sync();
console.log("Registered Products, Categories, and Suppliers. Manual refresh is the default.");
});
Propriétés
| data |
Spécifie le nom du fournisseur de données pour le domaine de données de l’entité liée. |
| id | Spécifie l’ID du domaine de données de l’entité liée. Cet ID doit être unique dans tous les domaines de données d’entité liés définis par ce complément Office. |
| load |
Spécifie l’ID de la fonction personnalisée qui sera appelée à la demande pour résoudre ou actualiser les |
| name | Spécifie le nom du domaine de données de l’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. |
| periodic |
Spécifie la fréquence, en secondes, à laquelle |
| supported |
Spécifie tous les modes d’actualisation pris en charge par le domaine de données de l’entité liée. La valeur par défaut est |
Détails de la propriété
dataProvider
Spécifie le nom du fournisseur de données pour le domaine de données de l’entité liée.
dataProvider: string;Valeur de propriété
string
Remarques
Cette propriété n’est pas prise en charge dans Excel sur le Web.
id
Spécifie l’ID du domaine de données de l’entité liée. Cet ID doit être unique dans tous les domaines de données d’entité liés définis par ce complément Office.
id: string;Valeur de propriété
string
Remarques
Cette propriété n’est pas prise en charge dans Excel sur le Web.
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
Cette propriété n’est pas prise en charge dans Excel sur le Web.
name
Spécifie le nom du domaine de données de l’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
Cette propriété n’est pas prise en charge dans Excel sur le Web.
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 obligatoire si le supportedRefreshModes tableau contient la valeur « Périodique ». Cette propriété ne s’applique que si le refreshMode du domaine de données de l’entité liée est réglé sur « Périodique ».
periodicRefreshInterval?: number;Valeur de propriété
number
Remarques
Cette propriété n’est pas prise en charge dans Excel sur le Web.
supportedRefreshModes
Spécifie tous les modes d’actualisation pris en charge par le domaine de données de l’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é 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é. Si le tableau a la valeur « Périodique », la periodicRefreshInterval propriété doit également être définie pour le domaine de données de l’entité liée.
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];Valeur de propriété
Remarques
Cette propriété n’est pas prise en charge dans Excel sur le Web.