Details about the format, quality, area and scale of a captured image.
extensionTypes.ImageDetails
Type
Values of this type are objects. They contain the following properties:
-
format
Optional -
extensionTypes.ImageFormat
. The format of the resulting image. Default is"png"
. -
quality
Optional -
integer
. 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
Optional -
number
. The scale to render at, defaults todevicePixelRatio
. This option was introduced in Firefox 82.
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
ImageDetails |
Yes
|
14
|
45
|
?
|
Yes
|
14
|
?
|
?
|
48
|
?
|
15
|
?
|
rect |
No
|
No
|
82
|
?
|
No
|
No
|
?
|
?
|
82
|
?
|
No
|
?
|
scale |
No
|
No
|
82
|
?
|
No
|
No
|
?
|
?
|
82
|
?
|
No
|
?
|
Note: 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.
© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/extensionTypes/ImageDetails