chrome.printing

Deskripsi

Izin

Ketersediaan

Semua metode dan peristiwa chrome.printing mengharuskan Anda menyatakan izin "printing" dalam manifes ekstensi. Contoh:

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

Contoh

Contoh di bawah menunjukkan penggunaan masing-masing metode dalam namespace pencetakan. Kode ini disalin dari atau berdasarkan api-samples/printing di repo GitHub contoh ekstensi.

cancelJob()

Contoh ini menggunakan pengendali onJobStatusChanged untuk menyembunyikan tombol 'cancel' jika jobStatus bukan PENDING atau IN_PROGRESS. Perhatikan bahwa pada beberapa jaringan atau saat Chromebook terhubung langsung ke printer, status ini mungkin berjalan terlalu cepat sehingga tombol batal terlihat cukup lama untuk dipanggil. Ini adalah contoh pencetakan yang sangat disederhanakan.

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

Satu contoh digunakan untuk fungsi ini karena untuk mendapatkan informasi printer memerlukan ID printer, yang diambil dengan memanggil getPrinters(). Contoh ini mencatat nama dan deskripsi printer default ke konsol. Ini adalah versi sederhana dari contoh pencetakan.

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

kirimJob()

Metode submitJob() memerlukan tiga hal.

• Struktur ticket yang menentukan kemampuan printer yang akan digunakan. Jika pengguna perlu memilih dari kemampuan yang tersedia, Anda dapat mengambilnya untuk printer tertentu menggunakan getPrinterInfo().
• Struktur SubmitJobRequest, yang menentukan printer yang akan digunakan, dan file atau tanggal untuk dicetak. Struktur ini berisi referensi ke struktur ticket.
• Blob file atau data yang akan dicetak.

Memanggil submitJob() akan memicu kotak dialog yang meminta pengguna untuk mengonfirmasi pencetakan. Gunakan PrintingAPIExtensionsAllowlist untuk mengabaikan konfirmasi.

Ini adalah versi sederhana dari contoh pencetakan. Perhatikan bahwa ticket dilampirkan pada struktur SubmitJobRequest (baris 8) dan bahwa data yang akan dicetak dikonversi menjadi blob (baris 10). Mendapatkan ID printer (baris 1) lebih rumit dalam contoh daripada yang ditunjukkan di sini.

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

Pencetakan gulungan

Contoh ini menunjukkan cara membuat tiket printer untuk pencetakan berkelanjutan (atau roll), yang sering digunakan dengan pencetakan tanda terima. Objek submitJobRequest untuk pencetakan gulungan sama dengan yang ditunjukkan untuk contoh submitJob().

Jika Anda perlu mengubah nilai default untuk pemotong kertas, gunakan kunci vendor_ticket_item. (Nilai defaultnya berbeda-beda untuk setiap printer.) Jika disertakan, kunci ini harus berupa array dengan satu anggota: objek yang id-nya adalah 'finishings'. Nilainya dapat berupa 'trim' untuk printer yang memotong gulungan di akhir pencetakan atau 'none' untuk printer yang memerlukan tugas pencetakan untuk dihapus.

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

Beberapa printer tidak mendukung opsi "finishings". Untuk menentukan apakah printer Anda mendukungnya, panggil getPrinterInfo() dan cari "display_name" "finishings/11".

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

Nilai dalam kunci media_size tiket bersifat spesifik untuk setiap printer. Untuk memilih ukuran yang sesuai, panggil getPrinterInfo(). GetPrinterResponse yang ditampilkan berisi array ukuran media yang didukung di "media_size"."option". Pilih opsi yang nilai "is_continuous_feed"-nya benar. Gunakan nilai tinggi dan lebar untuk tiket.

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