Back to Content

HTMLCanvasElement: contextrestored event

files/en-us/web/api/htmlcanvaselement/contextrestored_event/index.md

latest1.3 KB
Original Source

{{APIRef("Canvas API")}}

The contextrestored event of the Canvas API is fired if the user agent restores the backing storage for a CanvasRenderingContext2D.

You can redraw, re-retrieve resources, and reinitialize the state of your context after receiving this event.

Syntax

Use the event name in methods like {{domxref("EventTarget.addEventListener", "addEventListener()")}}, or set an event handler property.

js-nolint
addEventListener("contextrestored", (event) => { })

oncontextrestored = (event) => { }

Event type

A generic {{domxref("Event")}}.

Example

The code fragment below detects the context restored event.

js
const canvas = document.getElementById("canvas");

canvas.addEventListener("contextrestored", (e) => {
  console.log(e);
  // call to redrawCanvas() or similar
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also