Excel.LinkedEntityCellValue interface

Représente une valeur dont les propriétés dérivent d’un service.

Remarques

Jeu d’API : ExcelApi 1.16

Utilisateur

Exemples

// Creates a linked entity cell value with properties and a card layout.
// This is typically returned from a linked entity load service function.
const productLinkedEntity: Excel.LinkedEntityCellValue = {
    type: "LinkedEntity",
    text: "Chai",
    id: {
        entityId: "P1",
        domainId: "products",
        serviceId: 268436224, // Service ID used by Excel to identify linked entity cell values associated with an add-in.
        culture: "en-US"
    },
    properties: {
        "Product Name": {
            type: "String",
            basicValue: "Chai"
        },
        "Unit Price": {
            type: "FormattedNumber",
            basicValue: 18,
            numberFormat: "$* #,##0.00"
        },
        Discontinued: {
            type: "Boolean",
            basicValue: false
        }
    },
    layouts: {
        compact: {
            icon: "ShoppingBag"
        },
        card: {
            title: { property: "Product Name" },
            sections: [
                {
                    layout: "List",
                    properties: ["Product Name", "Unit Price", "Discontinued"]
                }
            ]
        }
    }
};

Propriétés

basicType

Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.

basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur. Lorsque vous y accédez via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux fr-FR. Lorsque vous y accédez via une valuesAsJsonLocal propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux d’affichage de l’utilisateur.

id

Représente la source de service qui a fourni les informations dans cette valeur.

layouts

Représente les informations de disposition pour les vues de cette entité liée.

properties

Représente les propriétés de cette entité liée et leurs métadonnées.

provider

Représente des informations qui décrivent le service qui a fourni des données dans ce LinkedEntityCellValue. Ces informations peuvent être utilisées pour la personnalisation dans les cartes d’entité.

text

Représente le texte affiché lorsqu’une cellule avec cette valeur est affichée.

type

Représente le type de cette valeur de cellule.

Détails de la propriété

basicType

Représente la valeur qui serait retournée par Range.valueTypes pour une cellule avec cette valeur.

basicType?: RangeValueType.error | "Error";

Valeur de propriété

error | "Error"

Remarques

Jeu d’API : ExcelApi 1.16

basicValue

Représente la valeur qui serait retournée par Range.values pour une cellule avec cette valeur. Lorsque vous y accédez via une valuesAsJson propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux fr-FR. Lorsque vous y accédez via une valuesAsJsonLocal propriété, cette valeur de chaîne s’aligne sur les paramètres régionaux d’affichage de l’utilisateur.

basicValue?: "#VALUE!" | string;

Valeur de propriété

"#VALUE!" | string

Remarques

Jeu d’API : ExcelApi 1.16

id

Représente la source de service qui a fourni les informations dans cette valeur.

id: LinkedEntityId;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.16

layouts

Représente les informations de disposition pour les vues de cette entité liée.

layouts?: EntityViewLayouts;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.16

properties

Représente les propriétés de cette entité liée et leurs métadonnées.

properties?: {
            [key: string]: EntityPropertyType;
        };

Valeur de propriété

{ [key: string]: Excel.EntityPropertyType; }

Remarques

Jeu d’API : ExcelApi 1.16

provider

Représente des informations qui décrivent le service qui a fourni des données dans ce LinkedEntityCellValue. Ces informations peuvent être utilisées pour la personnalisation dans les cartes d’entité.

provider?: CellValueProviderAttributes;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.16

text

Représente le texte affiché lorsqu’une cellule avec cette valeur est affichée.

text?: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.16

type

Représente le type de cette valeur de cellule.

type: CellValueType.linkedEntity | "LinkedEntity";

Valeur de propriété

linkedEntity | "LinkedEntity"

Remarques

Jeu d’API : ExcelApi 1.16