chroom.afdrukken

Beschrijving

Machtigingen

Beschikbaarheid

Manifest

Voor alle methoden en gebeurtenissen chrome.printing moet u de machtiging "printing" in het extensiemanifest declareren. Bijvoorbeeld:

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

Voorbeelden

De onderstaande voorbeelden demonstreren het gebruik van elk van de methoden in de printing-naamruimte. Deze code is gekopieerd van of gebaseerd op api-samples/printing in de extensions-samples GitHub-repo.

annuleerJob()

In dit voorbeeld wordt de onJobStatusChanged handler gebruikt om een 'annuleren'-knop te verbergen wanneer de jobStatus niet PENDING of IN_PROGRESS is. Houd er rekening mee dat deze statussen in sommige netwerken of wanneer een Chromebook rechtstreeks op de printer is aangesloten, te snel kunnen worden doorgegeven om de knop 'Annuleren' lang genoeg zichtbaar te houden om te kunnen worden aangeroepen. 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()

Er wordt één voorbeeld gebruikt voor deze functies, omdat het ophalen van printerinformatie een printer-ID vereist, die wordt opgehaald door getPrinters() aan te roepen. Dit voorbeeld registreert de naam en beschrijving van de standaardprinter in de console. 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 submitJob() -methode vereist drie dingen.

• Een ticket die aangeeft welke mogelijkheden van de printer gebruikt moeten worden. 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 en het af te drukken bestand of de af te drukken datum specificeert. Deze structuur bevat een verwijzing naar de ticket .
• Een blob van het bestand of de gegevens die afgedrukt moeten worden.

Door submitJob() aan te roepen, wordt een dialoogvenster geopend waarin de gebruiker wordt gevraagd het afdrukken te bevestigen. Gebruik de PrintingAPIExtensionsAllowlist om 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 omgezet naar een blob (regel 10). Het verkrijgen van de ID van de printer (regel 1) is in het voorbeeld ingewikkelder dan hier wordt getoond.

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

Rolprinten

Dit voorbeeld laat zien hoe u een printerticket maakt voor continu (of rol) printen, wat vaak wordt gebruikt bij het printen van bonnen. Het submitJobRequest object voor rolprinten is hetzelfde als dat in het submitJob() -voorbeeld.

Als u de standaardwaarde voor het snijden van papier wilt wijzigen, gebruikt u de sleutel vendor_ticket_item . (De standaardwaarde varieert per printer.) Indien opgenomen, moet deze sleutel een array met één lid zijn: een object met id 'finishings' . De waarde kan 'trim' zijn voor printers die de rol aan het einde van de afdruktaak afsnijden, of 'none' voor printers die vereisen dat de afdruktaak wordt 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 wel 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 de media_size -sleutel van een ticket zijn specifiek voor elke printer. Om een geschikte grootte te selecteren, roept u getPrinterInfo() aan. De geretourneerde GetPrinterResponse bevat een array met ondersteunde mediaformaten bij "media_size"."option" . Kies een optie waarvan de waarde "is_continuous_feed" true 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,
): Promise<void>

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

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

chrome.printing.getPrinters(
  callback?: function,
): Promise<Printer[]>

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

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