chrome.printing

Beschreibung

Berechtigungen

Verfügbarkeit

Für alle chrome.printing-Methoden und ‑Ereignisse müssen Sie die Berechtigung "printing" im Erweiterungsmanifest deklarieren. Beispiel:

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

Beispiele

In den folgenden Beispielen wird die Verwendung der einzelnen Methoden im Namespace „printing“ veranschaulicht. Dieser Code wurde aus dem api-samples/printing-Verzeichnis im Github-Repository „extensions-samples“ kopiert oder basiert darauf.

cancelJob()

In diesem Beispiel wird der onJobStatusChanged-Handler verwendet, um die Schaltfläche „Abbrechen“ auszublenden, wenn jobStatus weder PENDING noch IN_PROGRESS ist. Hinweis: In einigen Netzwerken oder wenn ein Chromebook direkt mit dem Drucker verbunden ist, werden diese Status möglicherweise zu schnell durchlaufen, sodass die Schaltfläche „Abbrechen“ nicht lange genug sichtbar ist, um aufgerufen zu werden. Dies ist ein stark vereinfachtes Druckbeispiel.

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()

Für diese Funktionen wird ein einzelnes Beispiel verwendet, da zum Abrufen von Druckerinformationen eine Drucker-ID erforderlich ist, die durch Aufrufen von getPrinters() abgerufen wird. In diesem Beispiel werden der Name und die Beschreibung des Standarddruckers in der Konsole protokolliert. Dies ist eine vereinfachte Version des Druckbeispiels.

​​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()

Für die Methode submitJob() sind drei Dinge erforderlich.

• Eine ticket-Struktur, die angibt, welche Funktionen des Druckers verwendet werden sollen. Wenn der Nutzer aus den verfügbaren Funktionen auswählen muss, können Sie diese für einen bestimmten Drucker mit getPrinterInfo() abrufen.
• Eine SubmitJobRequest-Struktur, die den zu verwendenden Drucker und die zu druckende Datei oder das zu druckende Datum angibt. Diese Struktur enthält einen Verweis auf die ticket-Struktur.
• Ein Blob der Datei oder der zu druckenden Daten.

Durch Aufrufen von submitJob() wird ein Dialogfeld angezeigt, in dem der Nutzer aufgefordert wird, den Druck zu bestätigen. Verwenden Sie PrintingAPIExtensionsAllowlist, um die Bestätigung zu überspringen.

Dies ist eine vereinfachte Version des Druckbeispiels. Beachten Sie, dass ticket an die Struktur SubmitJobRequest angehängt wird (Zeile 8) und dass die zu druckenden Daten in einen Blob konvertiert werden (Zeile 10). Die ID des Druckers (Zeile 1) abzurufen ist im Beispiel komplizierter als hier dargestellt.

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);   } }); 

Rollendruck

In diesem Beispiel wird gezeigt, wie Sie ein Druckerticket für den kontinuierlichen Druck (oder Rollendruck) erstellen, der häufig für den Belegdruck verwendet wird. Das submitJobRequest-Objekt für den Rollendruck ist dasselbe wie im Beispiel für submitJob().

Wenn Sie den Standardwert für das Schneiden von Papier ändern möchten, verwenden Sie den Schlüssel vendor_ticket_item. Der Standardwert variiert je nach Drucker. Wenn Sie den Wert ändern möchten, geben Sie ein Array mit einem Element an: ein Objekt, dessen id 'finishings' ist. Der Wert kann entweder 'trim' für Drucker sein, die die Rolle am Ende des Druckvorgangs schneiden, oder 'none' für Drucker, bei denen der Druckauftrag abgerissen werden muss.

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}   } }; 

Einige Drucker unterstützen die Option "finishings" nicht. Wenn Sie herausfinden möchten, ob Ihr Drucker das unterstützt, rufen Sie getPrinterInfo() auf und suchen Sie nach einem "display_name" von "finishings/11".

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

Die Werte im media_size-Schlüssel eines Tickets sind für jeden Drucker spezifisch. Rufen Sie getPrinterInfo() auf, um eine geeignete Größe auszuwählen. Das zurückgegebene GetPrinterResponse enthält ein Array mit unterstützten Mediengrößen unter "media_size"."option". Wählen Sie eine Option aus, deren "is_continuous_feed"-Wert „Wahr“ ist. Verwenden Sie die Werte für Höhe und Breite für das 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,
)