chrome.printing

Description

Autorisations

Disponibilité

Toutes les méthodes et tous les événements chrome.printing nécessitent que vous déclariez l'autorisation "printing" dans le fichier manifeste de l'extension. Exemple :

{   "name": "My extension",   ...   "permissions": [     "printing"   ],   ... } 

Exemples

Les exemples ci-dessous montrent comment utiliser chacune des méthodes dans l'espace de noms d'impression. Ce code est copié ou basé sur api-samples/printing dans le dépôt Github extensions-samples.

cancelJob()

Cet exemple utilise le gestionnaire onJobStatusChanged pour masquer un bouton "Annuler" lorsque jobStatus n'est ni PENDING ni IN_PROGRESS. Notez que sur certains réseaux ou lorsqu'un Chromebook est connecté directement à l'imprimante, ces états peuvent passer trop rapidement pour que le bouton "Annuler" soit visible assez longtemps pour être appelé. Il s'agit d'un exemple d'impression très simplifié.

chrome.printing.onJobStatusChanged.addListener((jobId, status) => {   const cancelButton = document.getElementById("cancelButton");   cancelButton.addEventListener('click', () => {     chrome.printing.cancelJob(jobId).then((response) => {       if (response !== undefined) {         console.log(response.status);       }       if (chrome.runtime.lastError !== undefined) {         console.log(chrome.runtime.lastError.message);       }     });   });   if (status !== "PENDING" && status !== "IN_PROGRESS") {     cancelButton.style.visibility = 'hidden';   } else {     cancelButton.style.visibility = 'visible';   } } 

getPrinters() and getPrinterInfo()

Un seul exemple est utilisé pour ces fonctions, car l'obtention d'informations sur l'imprimante nécessite un ID d'imprimante, qui est récupéré en appelant getPrinters(). Cet exemple enregistre le nom et la description de l'imprimante par défaut dans la console. Il s'agit d'une version simplifiée de l'exemple d'impression.

​​const printers = await chrome.printing.getPrinters(); const defaultPrinter = printers.find((printer) => {   const printerInfo = await chrome.printing.getPrinterInfo(printer.id);   return printerInfo.isDefault; } console.log(`Default printer: ${defaultPrinter.name}.\n\t${defaultPrinter.description}`); 

submitJob()

La méthode submitJob() nécessite trois éléments.

• Structure ticket spécifiant les fonctionnalités de l'imprimante à utiliser. Si l'utilisateur doit choisir parmi les fonctionnalités disponibles, vous pouvez les récupérer pour une imprimante spécifique à l'aide de getPrinterInfo().
• Une structure SubmitJobRequest, qui spécifie l'imprimante à utiliser, ainsi que le fichier ou la date à imprimer. Cette structure contient une référence à la structure ticket.
• Blob du fichier ou des données à imprimer.

L'appel de submitJob() déclenche une boîte de dialogue demandant à l'utilisateur de confirmer l'impression. Utilisez PrintingAPIExtensionsAllowlist pour contourner la confirmation.

Il s'agit d'une version simplifiée de l'exemple d'impression. Notez que ticket est associé à la structure SubmitJobRequest (ligne 8) et que les données à imprimer sont converties en blob (ligne 10). Obtenir l'ID de l'imprimante (ligne 1) est plus compliqué dans l'exemple que ce qui est montré ici.

const defaultPrinter = getDefaultPrinter(); const ticket = getPrinterTicket(defaultPrinter); const arrayBuffer = getPrintData(); const submitJobRequest = {   job: {     printerId: defaultPrinter,     title: 'test job',     ticket: ticket,     contentType: 'application/pdf',     document: new Blob([new Uint8Array(arrayBuffer)], {       type: 'application/pdf'     });   } };  chrome.printing.submitJob(submitJobRequest, (response) => {   if (response !== undefined) {     console.log(response.status);   }   if (chrome.runtime.lastError !== undefined) {     console.log(chrome.runtime.lastError.message);   } }); 

Impression sur rouleau

Cet exemple montre comment créer un ticket d'imprimante pour l'impression continue (ou sur rouleau), qui est souvent utilisée pour l'impression de reçus. L'objet submitJobRequest pour l'impression sur rouleau est le même que celui présenté pour l'exemple submitJob().

Si vous devez modifier la valeur par défaut pour la découpe du papier, utilisez la touche vendor_ticket_item. (La valeur par défaut varie d'une imprimante à l'autre.) Pour modifier la valeur, fournissez un tableau avec un seul membre : un objet dont id est 'finishings'. La valeur peut être 'trim' pour les imprimantes qui coupent le rouleau à la fin de l'impression ou 'none' pour les imprimantes qui nécessitent que la tâche d'impression soit déchirée.

const ticket = {   version: '1.0',   print: {     vendor_ticket_item: [{id: 'finishings', value: 'trim'}],     color: {type: 'STANDARD_MONOCHROME'},     duplex: {type: 'NO_DUPLEX'},     page_orientation: {type: 'PORTRAIT'},     copies: {copies: 1},     dpi: {horizontal_dpi: 300, vertical_dpi: 300},     media_size: {       width_microns: 72320,       height_microns: 100000     },     collate: {collate: false}   } }; 

Certaines imprimantes ne sont pas compatibles avec l'option "finishings". Pour savoir si votre imprimante est compatible, appelez getPrinterInfo() et recherchez un "display_name" de "finishings/11".

"vendor_capability": [   {     "display_name": "finishings/11",     "id": "finishings/11",     "type": "TYPED_VALUE",     "typed_value_cap": {       "value_type": "BOOLEAN"     }   },   ... ] 

Les valeurs de la clé media_size d'un ticket sont spécifiques à chaque imprimante. Pour sélectionner une taille appropriée, appelez getPrinterInfo(). Le GetPrinterResponse renvoyé contient un tableau des tailles de supports acceptées à "media_size"."option". Choisissez une option dont la valeur "is_continuous_feed" est "true". Utilisez ses valeurs de hauteur et de largeur pour le ticket.

"media_size": {   "option": [   {     "custom_display_name": "",     "is_continuous_feed": true,     "max_height_microns": 2000000,     "min_height_microns": 25400,     "width_microns": 50800   },   ...   ] } 

chrome.printing.cancelJob(
  jobId: string,
): Promise<void>

chrome.printing.getJobStatus(
  jobId: string,
): Promise<JobStatus>

chrome.printing.getPrinterInfo(
  printerId: string,
): Promise<GetPrinterInfoResponse>

chrome.printing.getPrinters(): Promise<Printer[]>

chrome.printing.submitJob(
  request: SubmitJobRequest,
): Promise<SubmitJobResponse>

chrome.printing.onJobStatusChanged.addListener(
  callback: function,
)