[]

GC.Spread.Sheets.IImageRichData

Interface: IImageRichData

Spread.Sheets.IImageRichData

Hierarchy

IRichData

↳ IImageRichData

Table of contents

Properties

Properties

richDataType

• richDataType: "Image"

Discriminant tag identifying this as an image rich data object.

Overrides

IRichData.richDataType

value

• value: Object

Rich data value, the structure of which depends on the richDataType.

Type declaration

Name	Type	Description
`altText?`	`string`	Optional. Alternative text that describes the image for accessibility.
`clipHeight?`	`number`	Optional. The height of the sub-rectangle of the source image to draw into the destination context. The default value is the height of the image.
`clipWidth?`	`number`	Optional. The width of the sub-rectangle of the source image to draw into the destination context. The default value is the width of the image.
`clipX?`	`number`	Optional. The x-axis coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context. The default value is 0.
`clipY?`	`number`	Optional. The y-axis coordinate of the top left corner of the sub-rectangle of the source image to draw into the destination context. The default value is 0.
`drawType?`	`number`	Optional. Specification of how to size the image. 0 - keep the aspect ratio to fit the cell. 1 - make the image fit the entire cell. 2 - maintains original size even if it gets cropped. 3 - custom. The default value is 1.
`hAlign?`	`number`	Optional. The horizontal alignment of the image. 0 - left, 1 - center, 2 - right. The default value is 0 (left).
`height?`	`number`	Optional. If drawType is 3 (custom), use this for the height.
`imageBase64Data?`	`string`	Optional. The base64 encoded image data.
`src`	`string`	Required. The location of the image on the web or base64 string.
`vAlign?`	`number`	Optional. The vertical alignment of the image. 0 - top, 1 - center, 2 - bottom. The default value is 0 (top).
`width?`	`number`	Optional. If drawType is 3 (custom), use this for the width.

Overrides

IRichData.value