Excel.LinkedEntityCellValue interface

Пакет:
excel

Представляет значение, свойства которого являются производными от службы.

Комментарии

Набор 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;

Значение свойства

Excel.LinkedEntityId

Комментарии

Набор API: ExcelApi 1.16

layouts

Представляет сведения о макете для представлений этой связанной сущности.

layouts?: EntityViewLayouts;

Значение свойства

Excel.EntityViewLayouts

Комментарии

Набор API: ExcelApi 1.16

properties

Представляет свойства этой связанной сущности и ее метаданные.

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

Значение свойства

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

Комментарии

Набор API: ExcelApi 1.16

provider

Представляет сведения, описывающие службу, которая предоставила данные в этом объекте LinkedEntityCellValue. Эти сведения можно использовать для фирменной символики в карточках сущностей.

provider?: CellValueProviderAttributes;

Значение свойства

Excel.CellValueProviderAttributes

Комментарии

Набор API: ExcelApi 1.16

text

Представляет текст, отображаемый при отображении ячейки с этим значением.

text?: string;

Значение свойства

string

Комментарии

Набор API: ExcelApi 1.16

type

Представляет тип этого значения ячейки.

type: CellValueType.linkedEntity | "LinkedEntity";

Значение свойства

linkedEntity | "LinkedEntity"

Комментарии

Набор API: ExcelApi 1.16