extensionTypes.ImageDetails
Details about the format, quality, area and scale of a captured image.
Type
Values of this type are objects. They contain the following properties:
format
OptionalextensionTypes.ImageFormat
. The format of the resulting image. Default is"png"
.quality
Optionalinteger
. 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 theencoderOptions
argument toHTMLCanvasElement.toDataURL()
. If it 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.rect
Optional- An
object
specifying 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.
scale
Optionalnumber
. The scale to render at, defaults todevicePixelRatio
. This option was introduced in Firefox 82.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
ImageDetails | ChromeFull supportYes | EdgeFull support14 | FirefoxFull support45 | OperaFull supportYes | SafariFull support14 | Firefox for AndroidFull support48 |
rect | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support82 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support82 |
scale | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support82 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support82 |
Legend
- Full support
- Full support
- No support
- No support
The compatibility table on 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.
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.