chrome.printing

Descripción

Permisos

Disponibilidad

Todos los métodos y eventos de chrome.printing requieren que declares el permiso "printing" en el manifiesto de la extensión. Por ejemplo:

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

Ejemplos

En los siguientes ejemplos, se muestra cómo usar cada uno de los métodos en el espacio de nombres de impresión. Este código se copió de api-samples/printing en el repo de GitHub de extensiones-samples o se basa en él.

cancelJob()

En este ejemplo, se usa el controlador onJobStatusChanged para ocultar un botón de "cancelar" cuando jobStatus no es PENDING ni IN_PROGRESS. Ten en cuenta que, en algunas redes o cuando una Chromebook está conectada directamente a la impresora, es posible que estos estados pasen demasiado rápido para que el botón de cancelar esté visible el tiempo suficiente para que se lo llame. Este es un ejemplo de impresión muy 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()

Se usa un solo ejemplo para estas funciones porque obtener información de la impresora requiere un ID de impresora, que se recupera llamando a getPrinters(). En este ejemplo, se registra el nombre y la descripción de la impresora predeterminada en la consola. Esta es una versión simplificada del ejemplo de impresión.

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

El método submitJob() requiere tres elementos.

• Es una estructura ticket que especifica qué capacidades de la impresora se deben usar. Si el usuario necesita seleccionar entre las capacidades disponibles, puedes recuperarlas para una impresora específica con getPrinterInfo().
• Una estructura SubmitJobRequest, que especifica la impresora que se usará y el archivo o la fecha que se imprimirá. Esta estructura contiene una referencia a la estructura ticket.
• Es un BLOB del archivo o los datos que se imprimirán.

Llamar a submitJob() activa un cuadro de diálogo en el que se le pide al usuario que confirme la impresión. Usa PrintingAPIExtensionsAllowlist para omitir la confirmación.

Esta es una versión simplificada del ejemplo de impresión. Observa que ticket está adjunto a la estructura SubmitJobRequest (línea 8) y que los datos que se imprimirán se convierten en un blob (línea 10). Obtener el ID de la impresora (línea 1) es más complicado en la muestra de lo que se muestra aquí.

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

Impresión en rollo

En este ejemplo, se muestra cómo compilar un ticket de impresora para la impresión continua (o en rollo), que se suele usar para la impresión de recibos. El objeto submitJobRequest para la impresión en rollo es el mismo que se muestra en el ejemplo de submitJob().

Si necesitas cambiar el valor predeterminado para el corte de papel, usa la tecla vendor_ticket_item. (El valor predeterminado varía según la impresora). Para cambiar el valor, proporciona un array con un miembro: un objeto cuyo id es 'finishings'. El valor puede ser 'trim' para las impresoras que cortan el rollo al final de la impresión o 'none' para las impresoras que requieren que se arranque el trabajo de impresión.

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

Algunas impresoras no admiten la opción "finishings". Para determinar si tu impresora lo hace, llama a getPrinterInfo() y busca un "display_name" de "finishings/11".

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

Los valores de la clave media_size de un ticket son específicos de cada impresora. Para seleccionar un tamaño adecuado, llama a getPrinterInfo(). El objeto GetPrinterResponse que se devuelve contiene un array de tamaños de medios admitidos en "media_size"."option". Elige una opción cuyo valor de "is_continuous_feed" sea verdadero. Usa los valores de altura y ancho para el boleto.

"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,
): Promise<void>

chrome.printing.getJobStatus(
  jobId: string,
): Promise<JobStatus>

chrome.printing.getPrinterInfo(
  printerId: string,
): Promise<GetPrinterInfoResponse>

chrome.printing.getPrinters(): Promise<Printer[]>

chrome.printing.submitJob(
  request: SubmitJobRequest,
): Promise<SubmitJobResponse>

chrome.printing.onJobStatusChanged.addListener(
  callback: function,
)