chrome.printing

Opis

Uprawnienia

Dostępność

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

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

Przykłady

Poniższe przykłady pokazują korzystanie z każdej z metod w przestrzeni nazw drukowania. Ten kod został skopiowany z pliku api-samples/printing w repozytorium GitHub z przykładami rozszerzeń lub na podstawie tego kodu.

cancelJob()

W tym przykładzie użyto modułu obsługi onJobStatusChanged do ukrycia elementu „cancel” gdy jobStatus nie ma wartości PENDING ani IN_PROGRESS. Pamiętaj, że w niektórych sieciach lub gdy Chromebook jest podłączony bezpośrednio do drukarki, te stany mogą mijać zbyt szybko, by przycisk anulowania był widoczny dostatecznie długo, by można było wywołać przycisk. Jest to znacznie 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()

Wykorzystano jeden przykład tych funkcji, ponieważ do uzyskania informacji o drukarce wymagany jest identyfikator drukarki, który jest pobierany przez wywołanie metody getPrinters(). Ten przykład rejestruje nazwę i opis drukarki domyślnej w konsoli. To jest 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 elementów.

• Struktura ticket określająca, które funkcje drukarki mają być używane. Jeśli użytkownik musi wybrać spośród dostępnych funkcji, możesz pobrać informacje dla konkretnej drukarki za pomocą getPrinterInfo().
• Struktura SubmitJobRequest określająca drukarkę, która ma być użyta, oraz plik lub datę wydrukowania. Ta struktura zawiera odniesienie do struktury ticket.
• Blob pliku lub danych do wydrukowania.

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

To jest uproszczona wersja przykładu drukowania. Zwróć uwagę, że obiekt ticket jest dołączony do struktury SubmitJobRequest (wiersz 8), a dane do wydrukowania zostały przekonwertowane na obiekt blob (wiersz 10). Uzyskanie identyfikatora drukarki (wiersz 1) jest bardziej skomplikowane w przykładzie niż w tym przykładzie.

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 w rolce

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

Jeśli chcesz zmienić domyślną wartość wycinania papieru, użyj klucza vendor_ticket_item. (Ustawienia domyślne różnią się w zależności od drukarki). Aby zmienić wartość, podaj tablicę z jednym elementem: obiekt, którego id to 'finishings'. Wartością może być 'trim' w przypadku drukarek, które obcinają rolkę po zakończeniu drukowania, lub 'none' w przypadku drukarek, które wymagają usunięcia zadania drukowania.

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 to sprawdzić, zadzwoń pod numer getPrinterInfo() i odszukaj "display_name" o wartości "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 zgłoszenia są unikalne dla każdej drukarki. Aby wybrać odpowiedni rozmiar, wywołaj getPrinterInfo(). Zwrócony obiekt GetPrinterResponse zawiera tablicę obsługiwanych rozmiarów multimediów w lokalizacji "media_size"."option". Wybierz opcję, której wartość "is_continuous_feed" to true (prawda). Użyj wartości wysokości i szerokości 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,
  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,
)