chrome.printing

Descrizione

Autorizzazioni

Disponibilità

Tutti i metodi e gli eventi chrome.printing richiedono di dichiarare l'autorizzazione "printing" nel manifest delle estensioni. Ad esempio:

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

Esempi

Gli esempi riportati di seguito mostrano l'utilizzo di ciascuno dei metodi dello spazio dei nomi di stampa. Questo codice viene copiato o basato su api-samples/printing nel repository GitHub di Extensions-samples.

cancelJob()

In questo esempio viene utilizzato il gestore onJobStatusChanged per nascondere un pulsante "Annulla" quando jobStatus non è né PENDING né IN_PROGRESS. Tieni presente che su alcune reti o quando un Chromebook è collegato direttamente alla stampante, questi stati potrebbero passare troppo velocemente perché il pulsante Annulla diventi visibile per un tempo sufficiente da essere chiamato. Questo è un esempio di stampa molto semplificato.

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

Per queste funzioni viene utilizzato un singolo esempio perché per ottenere le informazioni sulla stampante è necessario un ID stampante, che viene recuperato chiamando getPrinters(). In questo esempio il nome e la descrizione della stampante predefinita vengono registrati nella console. Questa è una versione semplificata dell'esempio di stampa.

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

Il metodo submitJob() richiede tre passaggi.

• Una struttura ticket che specifica quali funzionalità della stampante utilizzare. Se l'utente deve selezionare le funzionalità disponibili, puoi recuperarle per una stampante specifica utilizzando getPrinterInfo().
• Una struttura SubmitJobRequest, che specifica la stampante da utilizzare e il file o la data da stampare. Questa struttura contiene un riferimento alla struttura ticket.
• Un blob del file o dei dati da stampare.

La chiamata a submitJob() attiva una finestra di dialogo che chiede all'utente di confermare la stampa. Utilizza il PrintingAPIExtensionsAllowlist per ignorare la conferma.

Questa è una versione semplificata dell'esempio di stampa. Nota che ticket è collegato alla struttura SubmitJobRequest (riga 8) e che i dati da stampare vengono convertiti in un blob (riga 10). Ottenere l'ID della stampante (riga 1) è più complicato nell'esempio rispetto a quello mostrato qui.

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

Stampa in rotolo

Questo esempio mostra come creare un ticket stampante per la stampa continua (o in rotolo), che viene spesso utilizzata con la stampa di ricevute. L'oggetto submitJobRequest per la stampa in rotolo è uguale a quello mostrato nell'esempio submitJob().

Se devi modificare il valore predefinito per il taglio della carta, utilizza la chiave vendor_ticket_item. L'impostazione predefinita varia a seconda della stampante. Se inclusa, questa chiave deve essere un array con un membro, ovvero un oggetto il cui id è 'finishings'. Il valore può essere 'trim' per le stampanti che tagliano il rullo alla fine della stampa o 'none' per le stampanti che richiedono la rimozione del processo di stampa.

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

Alcune stampanti non supportano l'opzione "finishings". Per stabilire se la tua stampante funziona, chiama il numero getPrinterInfo() e cerca un "display_name" di "finishings/11".

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

I valori nella chiave media_size di un ticket sono specifici per ogni stampante. Per selezionare una dimensione appropriata, chiama getPrinterInfo(). Il valore GetPrinterResponse restituito contiene un array di dimensioni dei contenuti multimediali supportate nel formato "media_size"."option". Scegli un'opzione il cui valore "is_continuous_feed" sia true. Utilizza i relativi valori di altezza e larghezza per il ticket.

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