Edit

Share via

Excel.LocalImageCellValue interface

  • Reference
Package:
excel

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the value of a cell containing a locally stored or generated image.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

altText

Represents the alternate text used in accessibility scenarios to describe what the image represents.
attribution

Represents attribution information to describe the source and license requirements for this image.
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.
image

Represents the image itself, either cached or encoded.
provider

Represents information that describes the entity or individual who provided the image. This information is used for branding purposes in image cards.
type

Represents the type of this cell value.

Property Details

altText

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the alternate text used in accessibility scenarios to describe what the image represents.

altText?: string;

Property Value

string

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

attribution

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents attribution information to describe the source and license requirements for this image.

attribution?: CellValueAttributionAttributes[];

Property Value

Excel.CellValueAttributionAttributes[]

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

basicType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

basicValue

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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 BETA (PREVIEW ONLY) ]

image

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the image itself, either cached or encoded.

image: LocalImageCellValueCacheId | Base64EncodedImage;

Property Value

Excel.LocalImageCellValueCacheId | Excel.Base64EncodedImage

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

provider

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents information that describes the entity or individual who provided the image. This information is used for branding purposes in image cards.

provider?: CellValueProviderAttributes;

Property Value

Excel.CellValueProviderAttributes

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

type

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the type of this cell value.

type: CellValueType.localImage | "LocalImage";

Property Value

localImage | "LocalImage"

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]