Excel.EntityCellValue interface

Package:

excel

Represents a set of properties without a schema or defined structure.

Remarks

[ API set: ExcelApi 1.16 ]

Properties

basicType	Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue	Represents the value that would be returned by Range.values for a cell with this value. When accessed through a valuesAsJson property, this string value aligns with the en-US locale. When accessed through a valuesAsJsonLocal property, this string value aligns with the user's display locale.
layouts	Represents layout information for views of this entity.
properties	Represents the properties of this entity and their metadata.
provider	Represents information that describes the service that provided the data in this EntityCellValue. This information can be used for branding in entity cards.
referencedValues	Represents the cell values which are referenced within EntityCellValue.properties.
text	Represents the text shown when a cell with this value is rendered.
type	Represents the type of this cell value.

Property Details

basicType

Represents the value that would be returned by Range.valueTypes for a cell with this value.

basicType?: RangeValueType.error | "Error";

Property Value

error | "Error"

Remarks

[ API set: ExcelApi 1.16 ]

basicValue

Represents the value that would be returned by Range.values for a cell with this value. When accessed through a valuesAsJson property, this string value aligns with the en-US locale. When accessed through a valuesAsJsonLocal property, this string value aligns with the user's display locale.

basicValue?: "#VALUE!" | string;

Property Value

"#VALUE!" | string

Remarks

[ API set: ExcelApi 1.16 ]

layouts

Represents layout information for views of this entity.

layouts?: EntityViewLayouts;

Property Value

Excel.EntityViewLayouts

Remarks

[ API set: ExcelApi 1.16 ]

properties

Represents the properties of this entity and their metadata.

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

Property Value

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

Remarks

[ API set: ExcelApi 1.16 ]

provider

Represents information that describes the service that provided the data in this EntityCellValue. This information can be used for branding in entity cards.

provider?: CellValueProviderAttributes;

Property Value

Excel.CellValueProviderAttributes

Remarks

[ API set: ExcelApi 1.16 ]

referencedValues

Represents the cell values which are referenced within EntityCellValue.properties.

referencedValues?: ReferencedValue[];

Property Value

Excel.ReferencedValue[]

Remarks

[ API set: ExcelApi 1.16 ]

text

Represents the text shown when a cell with this value is rendered.

text?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.16 ]

type

Represents the type of this cell value.

type: CellValueType.entity | ReferenceValueType.entity | "Entity";

Property Value

entity | entity | "Entity"

Remarks

[ API set: ExcelApi 1.16 ]