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 Druck-Namespace veranschaulicht. Dieser Code wurde aus dem Feld api-samples/printing im GitHub-Repository mit Erweiterungen kopiert oder basiert auf diesem Code.

cancelJob()

In diesem Beispiel wird der Handler onJobStatusChanged verwendet, um einen „Abbrechen“-Vorgang auszublenden Schaltfläche, wenn jobStatus weder PENDING noch IN_PROGRESS ist. Beachten Sie, dass diese Status in einigen Netzwerken oder wenn ein Chromebook direkt mit dem Drucker verbunden ist, möglicherweise zu schnell übergeben wird, sodass die Schaltfläche zum Abbrechen nicht lange genug angezeigt wird, 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 zum Abrufen von Druckerinformationen eine Drucker-ID erforderlich ist, die durch Aufrufen von getPrinters() abgerufen wird. In diesem Beispiel werden Name und 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 eine Auswahl aus den verfügbaren Funktionen treffen muss, können Sie sie 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. Dieses Gebäude enthält einen Verweis auf die ticket-Struktur.
• Ein Blob der Datei oder der zu druckenden Daten.

Durch den Aufruf von submitJob() wird ein Dialogfeld ausgelöst, in dem der Nutzer aufgefordert wird, den Druckvorgang 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 SubmitJobRequest-Struktur (Zeile 8) angehängt ist und die zu druckenden Daten in ein Blob (Zeile 10) konvertiert werden. Im Beispiel ist es komplizierter, die ID des Druckers (Zeile 1) abzurufen, als hier gezeigt wird.

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

Dieses Beispiel zeigt, wie ein Druckerticket für den fortlaufenden (oder Roll-)Druck erstellt wird, der oft beim Drucken von Belegen verwendet wird. Das Objekt submitJobRequest für den Rolldruck ist dasselbe wie für das Beispiel submitJob().

Wenn Sie den Standardwert für das Ausschneiden auf Papier ändern möchten, verwenden Sie die Taste vendor_ticket_item. Die Standardeinstellung unterscheidet sich von Drucker zu Drucker. Um den Wert zu ändern, stellen Sie ein Array mit einem Mitglied bereit: einem Objekt, dessen id 'finishings' ist. Der Wert kann entweder 'trim' für Drucker sein, bei denen die Rolle am Ende des Druckvorgangs abgeschnitten wird, 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 "finishings/11" als "display_name".

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

Die Werte im Schlüssel media_size eines Tickets gelten für jeden Drucker. Rufen Sie getPrinterInfo() auf, um eine geeignete Größe auszuwählen. Die zurückgegebene GetPrinterResponse enthält ein Array unterstützter Mediengrößen bei "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 des Tickets.

"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,
)