Edit

Share via


Excel.Interfaces.ImageData interface

An interface describing the data returned by calling image.toJSON().

Properties

brightness

Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).

colorType

Specifies the type of color transformation applied to the image.

contrast

Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

cropBottom

Specifies the number of points that are cropped off the bottom of the image.

cropLeft

Specifies the number of points that are cropped off the left side of the image.

cropRight

Specifies the number of points that are cropped off the right side of the image.

cropTop

Specifies the number of points that are cropped off the top of the image.

format

Returns the format of the image.

id

Specifies the shape identifier for the image object.

Property Details

brightness

Specifies the brightness of the image. The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).

brightness?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

colorType

Specifies the type of color transformation applied to the image.

colorType?: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";

Property Value

Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"

Remarks

[ API set: ExcelApiDesktop 1.1 ]

contrast

Specifies the contrast of the image. The value for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).

contrast?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropBottom

Specifies the number of points that are cropped off the bottom of the image.

cropBottom?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropLeft

Specifies the number of points that are cropped off the left side of the image.

cropLeft?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropRight

Specifies the number of points that are cropped off the right side of the image.

cropRight?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropTop

Specifies the number of points that are cropped off the top of the image.

cropTop?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

format

Returns the format of the image.

format?: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";

Property Value

Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"

Remarks

[ API set: ExcelApi 1.9 ]

id

Specifies the shape identifier for the image object.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]