Edit

Share via

PowerPoint.ShapeGetImageOptions interface

Package:
powerpoint

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the available options when getting an image of a shape. The image is scaled to fit into the desired dimensions. If width and height aren't specified, the true size of the shape is used. If only one of either width or height is specified, the other will be calculated to preserve aspect ratio. The resulting dimensions will automatically be clamped to the maximum supported size if too large.

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

Properties

format

The desired format of the resulting image.
height

The desired height of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large. Throws an InvalidArgument exception when set with a non-positive integer.
width

The desired width of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large. Throws an InvalidArgument exception when set with a non-positive integer.

Property Details

format

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The desired format of the resulting image.

format?: PowerPoint.ShapeGetImageFormatType | "Png";

Property Value

PowerPoint.ShapeGetImageFormatType | "Png"

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

height

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The desired height of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large. Throws an InvalidArgument exception when set with a non-positive integer.

height?: number;

Property Value

number

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]

width

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The desired width of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large. Throws an InvalidArgument exception when set with a non-positive integer.

width?: number;

Property Value

number

Remarks

[ API set: PowerPointApi BETA (PREVIEW ONLY) ]