KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

`load`- en `error`-events voor afbeeldingen

Handel succes en fouten af op het afbeeldingselement zelf. Registreer beide handlers voordat je `src` instelt en gebruik `complete` niet als bewijs dat de afbeelding is geladen.

Versie: ECMAScript 2024 and the current web platform; runtime support varies

Syntax

const image = new Image();
image.addEventListener("load", onLoad);
image.addEventListener("error", onError);
image.src = url;

// Alternative to addEventListener():
// image.onload = onLoad;
// image.onerror = onError;

new Image() maakt een HTMLImageElement: een <img> dat een afbeelding kan laden zonder dat je het element aan het document toevoegt. Dit is een browser-API, geen onderdeel van ECMAScript 2024. De browser vuurt op het element load af als de bron met succes is geladen, en error als de bron niet kan worden geladen of gebruikt, bijvoorbeeld bij een onbereikbare URL of ongeldige afbeeldingsgegevens. Het error-event van een afbeelding is geen geworpen JavaScript-exceptie en ook geen respons met een HTTP-statuscode.

Luister op het afbeeldingselement zelf: geen van beide events bubbelt of kan worden geannuleerd. Registreer beide handlers met addEventListener() voordat je src instelt. Je kunt ook onload en onerror instellen; een nieuwe toewijzing vervangt de handler in die eigenschap. Als je src uitleest, krijg je een URL, niet het laadresultaat of een Promise.

Als een bestaande afbeelding al een event heeft afgevuurd, krijgt een nieuwe listener dat niet alsnog. complete alleen bewijst geen succes: het kan ook true zijn bij een kapotte afbeelding of als er geen bron is ingesteld. Verwacht je een afbeelding met een positieve intrinsieke breedte, dan kun je met image.complete && image.naturalWidth > 0 controleren of ze al beschikbaar is.

load betekent niet dat de afbeelding al op het scherm is getekend. Wil je wachten op decodering voordat je de afbeelding aan het document toevoegt, gebruik dan await image.decode() en handel afwijzing van de promise af. Dat een afbeelding van een andere origin succesvol is geladen, geeft je nog geen toestemming om de pixels uit een canvas uit te lezen; CORS-beperkingen blijven gelden.

Voorbeelden

<!doctype html>
<meta charset="utf-8">
<title>Image load and error events</title>
<script>
(async () => {
  function imageOutcome(url) {
    return new Promise((resolve) => {
      const image = new Image();
      function finish(event) {
        image.removeEventListener("load", finish);
        image.removeEventListener("error", finish);
        resolve(event.type);
      }
      image.addEventListener("load", finish);
      image.addEventListener("error", finish);
      image.src = url;
    });
  }

  const svg = '<svg xmlns="http://www.w3.org/2000/svg" width="1" height="1"><rect width="1" height="1"/></svg>';
  const dataURL = (text) => `data:image/svg+xml,${encodeURIComponent(text)}`;
  console.log(await imageOutcome(dataURL(svg)));
  console.log(await imageOutcome(dataURL("not an SVG")));
})();
</script>

Resultaat

load
error

Sla het voorbeeld op als `.html`-bestand, open het in een browser die op die pagina `data:`-afbeeldingen toestaat en bekijk de browserconsole. Zonder een externe server te benaderen test de code eerst een geldige SVG en daarna ongeldige afbeeldingsgegevens. Per poging gebruikt de code een apart afbeeldingselement en verwijdert hij beide listeners zodra het resultaat binnen is. De verwachte berichten zijn `load` en daarna `error`.

Gerelateerde lessen

  • JavaScript · Les 33 · Gevorderd · Versie: 4

Bronnen