chrome.printing

Beschreibung

Berechtigungen

Verfügbarkeit

Für alle chrome.printing-Methoden und -Ereignisse muss die Berechtigung "printing" im Erweiterungsmanifest deklariert werden. Beispiel:

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

Beispiele

In den folgenden Beispielen wird die Verwendung der einzelnen Methoden im Drucker-Namespace veranschaulicht. Dieser Code wird aus oder basierend auf api-samples/printing im GitHub-Repository „extensions-Beispiele“ kopiert.

cancelJob()

In diesem Beispiel wird der onJobStatusChanged-Handler verwendet, um die Schaltfläche „Abbrechen“ auszublenden, wenn jobStatus weder PENDING noch IN_PROGRESS ist. Beachten Sie, dass diese Status in einigen Netzwerken oder bei direkter Verbindung eines Chromebooks mit dem Drucker zu schnell übertragen werden, sodass die Schaltfläche zum 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 nur ein Beispiel verwendet, da für das 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}`);

sendJob()

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

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

Durch das Aufrufen von submitJob() wird ein Dialogfeld ausgelöst, in dem der Nutzer aufgefordert wird, das Drucken zu bestätigen. Mit PrintingAPIExtensionsAllowlist können Sie die Bestätigung umgehen.

Dies ist eine vereinfachte Version des Druckbeispiels. Beachten Sie, dass ticket an die SubmitJobRequest-Struktur (Zeile 8) angehängt ist und die zu druckenden Daten in ein Blob konvertiert werden (Zeile 10). Das Abrufen der ID des Druckers (Zeile 1) ist im Beispiel komplizierter als hier gezeigt.

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 fortlaufenden Druck (bzw. auf Rollen) erstellen, das häufig für Belegdrucke verwendet wird. Das submitJobRequest-Objekt für den Rollendruck ist dasselbe wie im submitJob()-Beispiel.

Wenn Sie den Standardwert für das Papierschneiden ändern müssen, verwenden Sie den Schlüssel vendor_ticket_item. (Die Standardeinstellung ist von Drucker zu Drucker unterschiedlich.) Wenn dieser Schlüssel enthalten ist, muss er ein Array mit einem Element sein: ein Objekt, dessen id 'finishings' ist. Der Wert kann entweder 'trim' für Drucker sein, die die Rolle am Ende des Druckens schneiden, oder 'none' für Drucker, bei denen der Druckauftrag entfernt 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. Um herauszufinden, ob das bei Ihrem Drucker der Fall ist, 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 unterstützter 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,
  callback?: function,
)

chrome.printing.getPrinterInfo(
  printerId: string,
  callback?: function,
)

chrome.printing.getPrinters(
  callback?: function,
)

chrome.printing.submitJob(
  request: SubmitJobRequest,
  callback?: function,
)

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