chrome.printing

説明

権限

対象

chrome.printing のすべてのメソッドとイベントで、拡張機能のマニフェストで "printing" 権限を宣言する必要があります。次に例を示します。

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

例

以下の例では、print 名前空間の各メソッドの使用方法を示しています。このコードは、extensions-samples GitHub リポジトリの api-samples/printing からコピーまたはベースになっています。

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() を呼び出してプリンタ ID を取得する必要があるため、これらの関数では 1 つの例を使用します。この例では、デフォルト プリンタの名前と説明をコンソールにログ出力しています。これは、印刷の例を簡略化したものです。

​​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 行目）。プリンタの 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 キーを使用します。（デフォルトの設定はプリンタによって異なります）。指定する場合、このキーは 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() を呼び出して "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,
)