Excel.Image class
Represents an image in the worksheet. To get the corresponding Shape object, use Image.shape.
- Extends
Remarks
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). |
| color |
Specifies the type of color transformation applied to the image. |
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| 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). |
| crop |
Specifies the number of points that are cropped off the bottom of the image. |
| crop |
Specifies the number of points that are cropped off the left side of the image. |
| crop |
Specifies the number of points that are cropped off the right side of the image. |
| crop |
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 |
Methods
| increment |
Increments the brightness of the image by a specified amount. |
| increment |
Increments the contrast of the image by a specified amount. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| toJSON() | Overrides the JavaScript |
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
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
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
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
cropBottom
Specifies the number of points that are cropped off the bottom of the image.
cropBottom: number;Property Value
number
Remarks
cropLeft
Specifies the number of points that are cropped off the left side of the image.
cropLeft: number;Property Value
number
Remarks
cropRight
Specifies the number of points that are cropped off the right side of the image.
cropRight: number;Property Value
number
Remarks
cropTop
Specifies the number of points that are cropped off the top of the image.
cropTop: number;Property Value
number
Remarks
format
Returns the format of the image.
readonly format: Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG";Property Value
Excel.PictureFormat | "UNKNOWN" | "BMP" | "JPEG" | "GIF" | "PNG" | "SVG"
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-images.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Shapes");
const image = sheet.shapes.getItem("Image").image;
image.load("format");
await context.sync();
console.log("The image's format is: " + image.format);
await context.sync();
});
id
Specifies the shape identifier for the image object.
readonly id: string;Property Value
string
Remarks
shape
Returns the Shape object associated with the image.
readonly shape: Excel.Shape;Property Value
Remarks
Method Details
incrementBrightness(increment)
Increments the brightness of the image by a specified amount.
incrementBrightness(increment: number): void;Parameters
- increment
-
number
Specifies how much to change the value of the Brightness property for the picture. A positive value makes the picture brighter; a negative value makes the picture darker.
Returns
void
Remarks
incrementContrast(increment)
Increments the contrast of the image by a specified amount.
incrementContrast(increment: number): void;Parameters
- increment
-
number
Specifies how much to change the value of the Contrast property for the picture. A positive value increases the contrast; a negative value decreases the contrast.
Returns
void
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.ImageLoadOptions): Excel.Image;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.Image;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Image;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.ImageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Excel.Interfaces.ImageUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.Image): void;Parameters
- properties
- Excel.Image
Returns
void
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.Image object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ImageData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.ImageData;