W3cubDocs

/Web APIs

HTMLCanvasElement: contextrestored event

Baseline: Not widely supported

Baseline is determined by this web feature being supported on the current and the previous major versions of major browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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 addEventListener(), or set an event handler property.

js

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

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

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
contextrestored_event 98 98 No No 84 No 98 98 No 68 No 18.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/contextrestored_event