Details about the format, quality, area and scale of a captured image.
Type
Values of this type are objects. They contain the following properties:
formatOptionalextensionTypes.ImageFormat. The format of the resulting image. Default is"png".qualityOptionalinteger. When format is"jpeg", this controls the quality of the resulting image. It is a number between 0 and 100, which is converted to a value between 0 and 1 and then used as theencoderOptionsargument toHTMLCanvasElement.toDataURL(). If is is omitted, 92 is used. As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store it will decrease. This value is ignored for PNG images.rectOptional- An
objectspecifying the area of the document to capture, in CSS pixels, relative to the page. All properties default to0. The properties are: -
x: The coordinate of the left side of the rectangle.y: The coordinate of the top side of the rectangle.width: The width of the rectangle.height: The height of the rectangle.
This option was introduced in Firefox 82. If omitted, the currently visible viewport is captured.
scaleOptionalnumber. The scale to render at, defaults todevicePixelRatio. This option was introduced in Firefox 82.
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
| Desktop | Mobile | |||||
|---|---|---|---|---|---|---|
ImageDetails | Chrome Full support Yes | Edge Full support 14 | Firefox Full support 45 | Opera Full support Yes | Safari Full support 14 | Firefox Android Full support 48 |
rect | Chrome No support No | Edge No support No | Firefox Full support 82 | Opera No support No | Safari No support No | Firefox Android Full support 82 |
scale | Chrome No support No | Edge No support No | Firefox Full support 82 | Opera No support No | Safari No support No | Firefox Android Full support 82 |
Legend
- Full support
- Full support
- No support
- No support
Acknowledgements
This API is based on Chromium's chrome.extensionTypes API. This documentation is derived from extension_types.json in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.