Modules

tabs.captureVisibleTab()

Crée un URI de données codant une image de la zone visible de l'onglet actuellement actif dans la fenêtre spécifiée. Vous devez avoir la  permission <all_urls> pour utiliser la méthode.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

var capturing = browser.tabs.captureVisibleTab(
  windowId,               // optional integer
  options                 // optional extensionTypes.ImageDetails
)

Paramètres

windowIdFacultatif
integer. La fenêtre cible Par défaut à la fenêtre actuelle.
optionsFacultatif
extensionTypes.ImageDetails.

Values of this type are objects. They contain the following properties:

formatOptional
extensionTypes.ImageFormat. The format of the resulting image. Default is "png".
qualityOptional
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 the encoderOptions argument to HTMLCanvasElement.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.

Valeur retournée

Une Promise qui sera remplie avec une URL de données qui code une image de la zone visible de l'onglet capturé. Peut être affecté à la propriété 'src' d'un élément HTML Image pour l'affichage. Si une erreur se produit, la promesse sera rejetée avec un message d'erreur.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Oui1154754 Oui1

1. The default file format is 'jpeg'.

Exemples

Capturez une image de l'onglet actif dans la fenêtre actuelle, avec les paramètres par défaut :

function onCaptured(imageUri) {
  console.log(imageUri);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

browser.browserAction.onClicked.addListener(function() {
  var capturing = browser.tabs.captureVisibleTab();
  capturing.then(onCaptured, onError);
});

Remerciements :

Cette API est basée sur l'API Chromium chrome.tabs. Cette documentation est dérivée de tabs.json dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : hellosct1
 Dernière mise à jour par : hellosct1,