Excel.PictureFormat enum

Package:

excel

The format of the image.

Remarks

[ API set: ExcelApi 1.9 ]

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 shape = sheet.shapes.getItem("Image");
    const result = shape.getAsImage(Excel.PictureFormat.png);
    await context.sync();

    const imageString = result.value;
    // Your add-in would save this string as a .png file.
    console.log("The image's Base64-encoded string: " + imageString);
});

Fields

bmp = "BMP"	Bitmap image. [ API set: ExcelApi 1.9 ]
gif = "GIF"	Graphics Interchange Format. [ API set: ExcelApi 1.9 ]
jpeg = "JPEG"	Joint Photographic Experts Group. [ API set: ExcelApi 1.9 ]
png = "PNG"	Portable Network Graphics. [ API set: ExcelApi 1.9 ]
svg = "SVG"	Scalable Vector Graphic. [ API set: ExcelApi 1.9 ]
unknown = "UNKNOWN"	[ API set: ExcelApi 1.9 ]