Excel.LinkedEntityCellValue interface

プロパティがサービスから派生する値を表します。

注釈

API セット: ExcelApi 1.16

使用元

// 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"]
                }
            ]
        }
    }
};

プロパティ

basicType

この値を持つセルの Range.valueTypes によって返される値を表します。

basicValue

この値を持つセルの Range.values によって返される値を表します。 valuesAsJson プロパティを介してアクセスすると、この文字列値は en-US ロケールに合わせて調整されます。 valuesAsJsonLocal プロパティを介してアクセスすると、この文字列値はユーザーの表示ロケールと一致します。

id

この値の情報を提供したサービス ソースを表します。

layouts

このリンクされたエンティティのビューのレイアウト情報を表します。

properties

このリンクされたエンティティのプロパティとそのメタデータを表します。

provider

この LinkedEntityCellValueでデータを提供したサービスを説明する情報を表します。 この情報は、エンティティ カードのブランド化に使用できます。

text

この値を持つセルがレンダリングされるときに表示されるテキストを表します。

type

このセル値の型を表します。

プロパティの詳細

basicType

この値を持つセルの Range.valueTypes によって返される値を表します。

basicType?: RangeValueType.error | "Error";

プロパティ値

error | "Error"

注釈

API セット: ExcelApi 1.16

basicValue

この値を持つセルの Range.values によって返される値を表します。 valuesAsJson プロパティを介してアクセスすると、この文字列値は en-US ロケールに合わせて調整されます。 valuesAsJsonLocal プロパティを介してアクセスすると、この文字列値はユーザーの表示ロケールと一致します。

basicValue?: "#VALUE!" | string;

プロパティ値

"#VALUE!" | string

注釈

API セット: ExcelApi 1.16

id

この値の情報を提供したサービス ソースを表します。

id: LinkedEntityId;

プロパティ値

注釈

API セット: ExcelApi 1.16

layouts

このリンクされたエンティティのビューのレイアウト情報を表します。

layouts?: EntityViewLayouts;

プロパティ値

注釈

API セット: ExcelApi 1.16

properties

このリンクされたエンティティのプロパティとそのメタデータを表します。

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

プロパティ値

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

注釈

API セット: ExcelApi 1.16

provider

この LinkedEntityCellValueでデータを提供したサービスを説明する情報を表します。 この情報は、エンティティ カードのブランド化に使用できます。

provider?: CellValueProviderAttributes;

プロパティ値

注釈

API セット: ExcelApi 1.16

text

この値を持つセルがレンダリングされるときに表示されるテキストを表します。

text?: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.16

type

このセル値の型を表します。

type: CellValueType.linkedEntity | "LinkedEntity";

プロパティ値

linkedEntity | "LinkedEntity"

注釈

API セット: ExcelApi 1.16