chroom.afdrukken

Beschrijving

Machtigingen

Beschikbaarheid

Manifest

Voor alle chrome.printing -methoden en -gebeurtenissen moet u de toestemming voor "printing" opgeven in het extensiemanifest . Bijvoorbeeld:

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

Voorbeelden

De onderstaande voorbeelden demonstreren het gebruik van elk van de methoden in de afdruknaamruimte. Deze code wordt gekopieerd van of gebaseerd op de api-samples/printing in de extensions-samples Github-repository.

annulerenJob()

In dit voorbeeld wordt de handler onJobStatusChanged gebruikt om een ​​knop 'annuleren' te verbergen wanneer de jobStatus niet PENDING of IN_PROGRESS is. Houd er rekening mee dat deze statussen op sommige netwerken of wanneer een Chromebook rechtstreeks op de printer is aangesloten, te snel kunnen verstrijken, waardoor de knop Annuleren lang genoeg zichtbaar is om te kunnen worden gebeld. Dit is een sterk vereenvoudigd afdrukvoorbeeld.

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

Voor deze functies wordt één voorbeeld gebruikt, omdat voor het verkrijgen van printerinformatie een printer-ID vereist is, die wordt opgehaald door getPrinters() aan te roepen. In dit voorbeeld worden de naam en beschrijving van de standaardprinter in de console geregistreerd. Dit is een vereenvoudigde versie van het afdrukvoorbeeld.

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

De methode submitJob() vereist drie dingen.

• Een ticket die specificeert welke mogelijkheden van de printer moeten worden gebruikt. Als de gebruiker een keuze moet maken uit de beschikbare mogelijkheden, kunt u deze voor een specifieke printer ophalen met behulp van getPrinterInfo() .
• Een SubmitJobRequest -structuur, die de te gebruiken printer specificeert en het bestand of de datum die moet worden afgedrukt. Deze structuur bevat een verwijzing naar de ticket .
• Een klodder van het bestand of de gegevens die moeten worden afgedrukt.

Het aanroepen submitJob() activeert een dialoogvenster waarin de gebruiker wordt gevraagd het afdrukken te bevestigen. Gebruik de PrintingAPIExtensionsAllowlist om de bevestiging te omzeilen.

Dit is een vereenvoudigde versie van het afdrukvoorbeeld. Merk op dat het ticket is gekoppeld aan de SubmitJobRequest structuur (regel 8) en dat de af te drukken gegevens worden geconverteerd naar een blob (regel 10). Het verkrijgen van de ID van de printer (regel 1) is in het voorbeeld ingewikkelder dan hier wordt weergegeven.

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

Afdrukken op rol

Dit voorbeeld laat zien hoe u een printerticket kunt bouwen voor continu (of rol) afdrukken, wat vaak wordt gebruikt bij het afdrukken van bonnen. Het submitJobRequest object voor het afdrukken op rollen is hetzelfde als het object dat wordt weergegeven in het voorbeeld submitJob() .

Als u de standaardwaarde voor papiersnijden wilt wijzigen, gebruikt u de sleutel vendor_ticket_item . (De standaard varieert van printer tot printer.) Indien opgenomen, moet deze sleutel een array zijn met één lid: een object waarvan id 'finishings' is. De waarde kan 'trim' zijn voor printers die de rol aan het einde van het afdrukken afsnijden, of 'none' voor printers waarbij de afdruktaak moet worden afgescheurd.

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

Sommige printers ondersteunen de optie "finishings" niet. Om te bepalen of uw printer dit doet, roept u getPrinterInfo() aan en zoekt u naar een "display_name" van "finishings/11" .

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

De waarden in media_size sleutel van een ticket zijn specifiek voor elke printer. Om een ​​geschikt formaat te selecteren, roept u getPrinterInfo() op. De geretourneerde GetPrinterResponse bevat een reeks ondersteunde mediaformaten op "media_size"."option" . Kies een optie waarvan de waarde "is_continuous_feed" waar is. Gebruik de hoogte- en breedtewaarden voor het 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,
)