HTMLIFrameElement.getScreenshot()

The getScreenshot() method of the HTMLIFrameElement lets you request a screenshot of an content <iframe>, scaled to fit within a specified maximum width and height. The image will be cropped if necessary but will not be distorted vertically or horizontally.

Syntax

var instanceOfDOMRequest =
instanceOfHTMLIframeElement.getScreenshot(maxWidth, maxHeight, mimeType);

Returns

A DOMRequest for handling the screenshot request. Its request.onsuccess handler handles the success case (the screenshot is contained in request.result as a Blob object), and its request.onerror handler handles the failure case.

Parameters

maxWidth

A number representing the maximum width of the screenshot in device pixels.

maxHeight

A number representing the maximum height of the screenshot in device pixels.

mimeType Optional

A MIME type specifying the format of the image to be returned; if not specified, the default used is image/jpeg. Use image/png to capture the alpha channel of the rendered result by returning a PNG-format image. This lets you get a transparent background for the content <iframe>.

Examples

var browser = document.querySelector('iframe');
var request = browser.getScreenshot(100, 100);
request.onsuccess = function() {
  var blob = request.result;
  var url = URL.createObjectURL(blob);
}

Specification

Not part of any specification.

Browser compatibility

[1] Supported in chrome code only.

See also

• Using the Browser API