chrome.printing

說明

權限

適用國家/地區

所有 chrome.printing 方法和事件都必須在擴充功能資訊清單中宣告 "printing" 權限。例如：

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

示例

下列範例示範如何在列印命名空間中使用上述每種方法。這個程式碼是從 Extensions-samples GitHub 存放區中的 api-samples/printing 複製或複製。

cancelJob()

此範例使用 onJobStatusChanged 處理常式，在 jobStatus 不是 PENDING 或 IN_PROGRESS 時隱藏「cancel」按鈕。請注意，在某些網路或 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()

這些函式僅適用單一範例，因為需要印表機 ID，才能呼叫 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() 方法需要三個項目。

• ticket 結構，用於指定要使用的印表機功能。如果使用者需要從可用功能中進行選取，您可以使用 getPrinterInfo() 為特定印表機擷取密碼。
• SubmitJobRequest 結構，指定要使用的印表機，以及要列印的檔案或日期。這個結構包含 ticket 結構的參照。
• 要列印的檔案或資料的 blob，

呼叫 submitJob() 會觸發對話方塊，要求使用者確認列印。請使用 PrintingAPIExtensionsAllowlist 略過確認程序。

這是簡化版的列印範例。請注意，ticket 會附加至 SubmitJobRequest 結構 (第 8 行)，且要列印的資料已轉換為 blob (第 10 行)。取得印表機 ID (第 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 物件與 submitJob() 範例所示物件相同。

如要變更迴紋針的預設值，請使用 vendor_ticket_item 鍵。(預設選項會因印表機而異)。如果加入，這個鍵必須是含有一個成員的陣列：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()，並尋找 "finishings/11" 的 "display_name"。

"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" 值為 true 的選項。請使用票券的高度和寬度值。

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