Edit

Share via

Excel.Interfaces.ImageLoadOptions interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

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).
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

Warning

This API is now deprecated.

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

format

Warning

This API is now deprecated.

Returns the format of the image.

format?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

id

Warning

This API is now deprecated.

Specifies the shape identifier for the image object.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

shape

Warning

This API is now deprecated.

Returns the Shape object associated with the image.

shape?: Excel.Interfaces.ShapeLoadOptions;

Property Value

Excel.Interfaces.ShapeLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]