Edit

Excel.LinkedEntityId interface

The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.

Remarks

API set: ExcelApi 1.16

Used by

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-linked-entities.yaml

// Insert a product identity that Excel resolves through the companion load service.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const productId: Excel.LinkedEntityId = {
        entityId: "P1",
        domainId: "products",
        serviceId: 268436224,
        culture: "en-US"
    };
    const product: Excel.LinkedEntityCellValue = {
        type: Excel.CellValueType.linkedEntity,
        id: productId,
        text: "Chai",
        basicType: "Error",
        basicValue: "#VALUE!"
    };
    const productRange: Excel.Range = sheet.getRange("A2");
    productRange.valuesAsJson = [[product]];
    sheet.getRange("B2:D2").formulas = [["=A2.[Unit Price]", "=A2.Category", "=A2.Supplier"]];
    sheet.getRange("B2").numberFormat = [["$0.00"]];
    await context.sync();
    console.log("Inserted Chai in A2. Excel loads its properties asynchronously; open its card to explore.");
});

Properties

culture

Represents which language culture was used to create this CellValue.

domainId

Represents a domain specific to a service used to create the CellValue.

entityId

Represents an identifier specific to a service used to create the CellValue.

serviceId

Represents which service was used to create the CellValue.

Property Details

culture

Represents which language culture was used to create this CellValue.

culture: string;

Property Value

string

Remarks

API set: ExcelApi 1.16

domainId

Represents a domain specific to a service used to create the CellValue.

domainId?: string;

Property Value

string

Remarks

API set: ExcelApi 1.16

entityId

Represents an identifier specific to a service used to create the CellValue.

entityId: string;

Property Value

string

Remarks

API set: ExcelApi 1.16

serviceId

Represents which service was used to create the CellValue.

serviceId: number;

Property Value

number

Remarks

API set: ExcelApi 1.16