chrome.printing

คำอธิบาย

สิทธิ์

ความพร้อมใช้งาน

เมธอดและเหตุการณ์ chrome.printing ทั้งหมดกำหนดให้คุณต้องประกาศสิทธิ์ "printing" ในไฟล์ Manifest ของส่วนขยาย เช่น

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

ตัวอย่าง

ตัวอย่างด้านล่างแสดงให้เห็นการใช้แต่ละวิธีในเนมสเปซของการพิมพ์ โค้ดนี้คัดลอกมาจากหรืออิงตาม api-samples/printing ในที่เก็บ GitHub ตัวอย่างส่วนขยาย

cancelJob()

ตัวอย่างนี้ใช้เครื่องจัดการ onJobStatusChanged เพื่อซ่อน "ยกเลิก" เมื่อ jobStatus ไม่ใช่ PENDING หรือ IN_PROGRESS โปรดทราบว่าในบางเครือข่ายหรือเมื่อ Chromebook เชื่อมต่อกับเครื่องพิมพ์โดยตรง สถานะเหล่านี้อาจผ่านไปเร็วเกินไปจนไม่สามารถเห็นปุ่มยกเลิกได้นานพอที่จะเรียกใช้ได้ นี่เป็นตัวอย่างการพิมพ์ที่ลดความซับซ้อนลงมาก

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

ตัวอย่างเดียวใช้สำหรับฟังก์ชันเหล่านี้ เนื่องจากการรับข้อมูลเครื่องพิมพ์ต้องใช้รหัสเครื่องพิมพ์ ซึ่งดึงข้อมูลโดยการเรียกใช้ getPrinters() ตัวอย่างนี้บันทึกชื่อและคำอธิบายของเครื่องพิมพ์เริ่มต้นลงในคอนโซล นี่เป็นตัวอย่างการพิมพ์แบบง่าย

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

เมธอด submitJob() ต้องใช้ 3 สิ่ง

• โครงสร้าง ticket ที่ระบุความสามารถของเครื่องพิมพ์ หากผู้ใช้ต้องเลือกความสามารถที่มีอยู่ คุณเรียกข้อมูลสำหรับเครื่องพิมพ์ที่ต้องการได้โดยใช้ getPrinterInfo()
• โครงสร้าง SubmitJobRequest ซึ่งระบุเครื่องพิมพ์ที่จะใช้ และไฟล์หรือวันที่ที่จะพิมพ์ โครงสร้างนี้มีการอ้างอิงโครงสร้าง ticket
• BLOB ของไฟล์หรือข้อมูลที่จะพิมพ์

การเรียกใช้ submitJob() จะเป็นการทริกเกอร์กล่องโต้ตอบที่ขอให้ผู้ใช้ยืนยันการพิมพ์ ใช้ PrintingAPIExtensionsAllowlist เพื่อข้ามการยืนยัน

นี่เป็นตัวอย่างการพิมพ์แบบง่าย โปรดสังเกตว่า ticket แนบอยู่กับโครงสร้าง SubmitJobRequest (บรรทัดที่ 8) และข้อมูลที่จะพิมพ์ได้แปลงเป็น BLOB (บรรทัดที่ 10) แล้ว การรับรหัสของเครื่องพิมพ์ (บรรทัดที่ 1) จะซับซ้อนกว่าในตัวอย่างกว่าที่แสดงที่นี่

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

การพิมพ์แบบม้วน

ตัวอย่างนี้แสดงวิธีสร้างตั๋วเครื่องพิมพ์สำหรับการพิมพ์แบบต่อเนื่อง (หรือแบบม้วน) ซึ่งมักใช้กับการพิมพ์ใบเสร็จ ออบเจ็กต์ submitJobRequest สำหรับการพิมพ์แบบม้วน (Roll Print) เหมือนกับที่ปรากฏสำหรับตัวอย่าง submitJob()

หากต้องการเปลี่ยนค่าเริ่มต้นสำหรับการตัดกระดาษ ให้ใช้คีย์ vendor_ticket_item (ค่าเริ่มต้นจะแตกต่างกันไปตามเครื่องพิมพ์แต่ละเครื่อง) หากต้องการเปลี่ยนค่า ให้ระบุอาร์เรย์ที่มีสมาชิก 1 คน ได้แก่ ออบเจ็กต์ที่มี id เป็น 'finishings' ค่าอาจเป็น 'trim' สำหรับเครื่องพิมพ์ที่ตัดม้วนเมื่อพิมพ์เสร็จ หรือ 'none' สำหรับเครื่องพิมพ์ที่จำเป็นต้องฉีกงานพิมพ์ออก

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

เครื่องพิมพ์บางเครื่องไม่รองรับตัวเลือก "finishings" หากต้องการทราบว่าเครื่องพิมพ์ของคุณใช้งานได้หรือไม่ ให้โทรไปที่ getPrinterInfo() แล้วมองหา "display_name" จาก "finishings/11"

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

ค่าในคีย์ media_size ของตั๋วจะใช้เฉพาะกับเครื่องพิมพ์แต่ละเครื่อง เพื่อเลือกขนาดการโทรที่เหมาะสม getPrinterInfo() GetPrinterResponse ที่แสดงผลมีอาร์เรย์ของขนาดสื่อที่รองรับที่ "media_size"."option" เลือกตัวเลือกที่มีค่า "is_continuous_feed" เป็น "จริง" ใช้ค่าความสูงและความกว้างสำหรับตั๋ว

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