chrome.printing

Opis

Uprawnienia

Dostępność

Wszystkie metody i zdarzenia chrome.printing wymagają zadeklarowania uprawnienia "printing" w pliku manifestu rozszerzenia. Na przykład:

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

Przykłady

Przykłady poniżej pokazują, jak używać każdej z metod w przestrzeni nazw drukowania. Ten kod jest skopiowany z repozytorium api-samples/printing w repozytorium extensions-samples na GitHubie lub na nim oparty.

cancelJob()

W tym przykładzie użyto funkcji obsługi onJobStatusChanged, aby ukryć przycisk „Anuluj”, gdy wartość jobStatus nie jest równa PENDING ani IN_PROGRESS. Pamiętaj, że w niektórych sieciach lub gdy Chromebook jest podłączony bezpośrednio do drukarki, te stany mogą przechodzić zbyt szybko, aby przycisk anulowania był widoczny wystarczająco długo, aby można było go kliknąć. To bardzo uproszczony przykład drukowania.

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

W przypadku tych funkcji używamy jednego przykładu, ponieważ uzyskanie informacji o drukarce wymaga identyfikatora drukarki, który jest pobierany przez wywołanie funkcji getPrinters(). W tym przykładzie nazwa i opis drukarki domyślnej są rejestrowane w konsoli. To uproszczona wersja przykładu drukowania.

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

Metoda submitJob() wymaga 3 rzeczy.

• Struktura ticket określająca, które funkcje drukarki mają być używane. Jeśli użytkownik musi wybrać jedną z dostępnych funkcji, możesz je pobrać dla konkretnej drukarki za pomocą getPrinterInfo().
• SubmitJobRequest struktura, która określa drukarkę, której należy użyć, oraz plik lub datę do wydrukowania; Ta struktura zawiera odwołanie do struktury ticket.
• Blob pliku lub danych do wydrukowania.

Wywołanie submitJob() powoduje wyświetlenie okna dialogowego z prośbą o potwierdzenie drukowania. Użyj PrintingAPIExtensionsAllowlist, aby pominąć potwierdzenie.

To uproszczona wersja przykładu drukowania. Zwróć uwagę, że element ticket jest dołączony do struktury SubmitJobRequest (wiersz 8), a dane do wydrukowania są przekształcane w obiekt blob (wiersz 10). Uzyskanie identyfikatora drukarki (wiersz 1) jest w przykładzie bardziej skomplikowane niż pokazano tutaj.

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

Drukowanie z rolki

Ten przykład pokazuje, jak utworzyć bilet drukarki do drukowania ciągłego (lub z rolki), które jest często używane do drukowania paragonów. Obiekt submitJobRequest do drukowania z rolki jest taki sam jak w przykładzie submitJob().

Jeśli chcesz zmienić domyślną wartość cięcia papieru, użyj klawisza vendor_ticket_item. (Wartość domyślna różni się w zależności od drukarki). Aby zmienić wartość, podaj tablicę z 1 elementem: obiektem, którego id ma wartość 'finishings'. Wartość może wynosić 'trim' w przypadku drukarek, które odcinają rolkę po zakończeniu drukowania, lub 'none' w przypadku drukarek, które wymagają oderwania wydruku.

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

Niektóre drukarki nie obsługują opcji "finishings". Aby sprawdzić, czy drukarka obsługuje tę funkcję, zadzwoń pod numer getPrinterInfo() i poszukaj wartości "display_name" równej "finishings/11".

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

Wartości w kluczu media_size biletu są specyficzne dla każdej drukarki. Aby wybrać odpowiedni rozmiar, zadzwoń pod numer getPrinterInfo(). Zwrócony obiekt GetPrinterResponse zawiera tablicę obsługiwanych rozmiarów multimediów w "media_size"."option". Wybierz opcję, której wartość "is_continuous_feed" to prawda. Użyj wartości wysokości i szerokości w przypadku biletu.

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