HTMLCanvasElement: contextrestored event

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Want more browser support for this feature? Tell us why.

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

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

Alternatively, assign to the event handler property of the interface:

js
oncontextrestored = (event) => { }

Event type

A generic 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

Specification
HTML
# event-contextrestored

Browser compatibility

See also