chrome.printing

Descrição

Permissões

Disponibilidade

Todos os métodos e eventos de chrome.printing exigem que você declare a permissão "printing" no manifesto da extensão. Exemplo:

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

Exemplos

Os exemplos abaixo demonstram o uso de cada um dos métodos no namespace de impressão. Esse código é copiado de ou baseado em api-samples/printing no repositório extensions-samples do GitHub.

cancelJob()

Este exemplo usa o gerenciador onJobStatusChanged para ocultar um valor "cancel". quando o jobStatus não for PENDING nem IN_PROGRESS. Em algumas redes ou quando um Chromebook está conectado diretamente à impressora, esses estados podem passar rápido demais para que o botão de cancelamento fique visível por tempo suficiente para ser chamado. Este é um exemplo de impressão bastante simplificado.

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

Um único exemplo é usado para essas funções porque a coleta de informações da impressora requer um ID da impressora, que é recuperado chamando getPrinters(). Este exemplo registra o nome e a descrição da impressora padrão no console. Esta é uma versão simplificada do exemplo de impressão.

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

O método submitJob() requer três coisas.

• Uma estrutura ticket que especifica quais recursos da impressora serão usados. Se o usuário precisar selecionar um dos recursos disponíveis, use getPrinterInfo() para buscar uma impressora específica.
• Uma estrutura SubmitJobRequest, que especifica a impressora a ser usada e o arquivo ou a data a ser impressa. Essa estrutura contém uma referência à estrutura ticket.
• Um blob do arquivo ou dos dados a serem impressos.

Chamar submitJob() aciona uma caixa de diálogo solicitando que o usuário confirme a impressão. Use PrintingAPIExtensionsAllowlist para ignorar a confirmação.

Esta é uma versão simplificada do exemplo de impressão. Observe que a ticket está anexada à estrutura SubmitJobRequest (linha 8) e que os dados a serem mostrados são convertidos em um blob (linha 10). Encontrar o ID da impressora (linha 1) é mais complicado no exemplo do que mostrado aqui.

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

Impressão em rolo

Neste exemplo, mostramos como criar um tíquete de impressora para impressão contínua (ou em rolo), que geralmente é usada com a impressão de recibos. O objeto submitJobRequest para a impressão em rolo é o mesmo mostrado no exemplo submitJob().

Se você precisar alterar o valor padrão para cortar papel, use a tecla vendor_ticket_item. O padrão varia de acordo com a impressora. Para alterar o valor, forneça uma matriz com um membro: um objeto em que id seja 'finishings'. O valor pode ser 'trim' para impressoras que cortam o rolo ao final da impressão ou 'none' para impressoras que exigem a remoção do trabalho de impressão.

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

Algumas impressoras não são compatíveis com a opção "finishings". Para determinar se ela faz isso, chame getPrinterInfo() e procure um "display_name" de "finishings/11".

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

Os valores na chave media_size de um tíquete são específicos de cada impressora. Para selecionar um tamanho adequado, chame getPrinterInfo(). O GetPrinterResponse retornado contém uma matriz de tamanhos de mídia compatíveis em "media_size"."option". Escolha uma opção em que o valor de "is_continuous_feed" seja verdadeiro. Use os valores de altura e largura para o ingresso.

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