Edit

Share via

Excel.Interfaces.ImageLoadOptions interface

Package:
excel

Represents an image in the worksheet. To get the corresponding Shape object, use Image.shape.

Remarks

[ API set: ExcelApi 1.9 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.
shape

Returns the Shape object associated with the image.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

colorType

Specifies the type of color transformation applied to the image.

colorType?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropBottom

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

cropBottom?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropLeft

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

cropLeft?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropRight

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

cropRight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

cropTop

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

cropTop?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

format

Returns the format of the image.

format?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

id

Specifies the shape identifier for the image object.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

shape

Returns the Shape object associated with the image.

shape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

Excel.Interfaces.ShapeLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]