FileReader: progress Ereignis

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Das progress Ereignis des FileReader-Interfaces wird regelmäßig ausgelöst, während der FileReader Daten liest.

Dieses Ereignis kann nicht abgebrochen werden und löst keine weitere Ereignisausbreitung aus.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignis-Handler-Eigenschaft.

js
addEventListener("progress", (event) => {});

onprogress = (event) => {};

Ereignistyp

Ein ProgressEvent. Erbt von Event.

Event ProgressEvent

Ereigniseigenschaften

Erbt auch Eigenschaften von seinem Elternteil Event.

ProgressEvent.lengthComputable Schreibgeschützt

Eine boolesche Flagge, die anzeigt, ob die Gesamtarbeit, die zu erledigen ist, und der bereits geleistete Arbeitsanteil durch den zugrunde liegenden Prozess kalkulierbar sind. Mit anderen Worten zeigt es an, ob der Fortschritt messbar ist oder nicht.

ProgressEvent.loaded Schreibgeschützt

Ein 64-Bit unsigned integer Wert, der die bereits vom zugrunde liegenden Prozess geleistete Arbeit anzeigt. Das Verhältnis der geleisteten Arbeit kann berechnet werden, indem der Wert dieser Eigenschaft durch total geteilt wird. Beim Herunterladen einer Ressource über HTTP zählt dies nur den Inhalt der HTTP-Nachricht und schließt Header und anderen Overhead nicht ein.

ProgressEvent.total Schreibgeschützt

Ein 64-Bit unsigned integer, der die Gesamtmenge an Arbeit darstellt, die der zugrunde liegende Prozess gerade ausführt. Beim Herunterladen einer Ressource über HTTP ist dies die Content-Length (die Größe des Nachrichtentextes), und schließt die Header und anderen Overhead nicht ein.

Beispiele

Live-Beispiel

HTML

html
<div class="example">
  <div class="file-select">
    <label for="avatar">Choose a profile picture:</label>
    <input
      type="file"
      id="avatar"
      name="avatar"
      accept="image/png, image/jpeg" />
  </div>

  <img src="" class="preview" height="200" alt="Image preview" />

  <div class="event-log">
    <label for="eventLog">Event log:</label>
    <textarea readonly class="event-log-contents" id="eventLog"></textarea>
  </div>
</div>

JavaScript

js
const fileInput = document.querySelector('input[type="file"]');
const preview = document.querySelector("img.preview");
const eventLog = document.querySelector(".event-log-contents");
const reader = new FileReader();

function handleEvent(event) {
  eventLog.textContent += `${event.type}: ${event.loaded} bytes transferred\n`;

  if (event.type === "load") {
    preview.src = reader.result;
  }
}

function addListeners(reader) {
  reader.addEventListener("loadstart", handleEvent);
  reader.addEventListener("load", handleEvent);
  reader.addEventListener("loadend", handleEvent);
  reader.addEventListener("progress", handleEvent);
  reader.addEventListener("error", handleEvent);
  reader.addEventListener("abort", handleEvent);
}

function handleSelected(e) {
  eventLog.textContent = "";
  const selectedFile = fileInput.files[0];
  if (selectedFile) {
    addListeners(reader);
    reader.readAsDataURL(selectedFile);
  }
}

fileInput.addEventListener("change", handleSelected);

Ergebnis

Spezifikationen

Specification
File API
# dfn-progress-event
File API
# dfn-onprogress

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch