CanvasRenderingContext2D.restore()

The CanvasRenderingContext2D.restore() method of the Canvas 2D API restores the most recently saved canvas state by popping the top entry in the drawing state stack. If there is no saved state, this method does nothing.

Syntax

void ctx.restore();

Fore more information about the drawing state, see CanvasRenderingContext2D.save().

Examples

Using the restore method

This is just a simple code snippet which uses the save() method to save the default state and restore() to restore it later, so that you are able to draw a rect with the default state later.

HTML

<canvas id="canvas"></canvas>

JavaScript

var canvas = document.getElementById('canvas');
var ctx = canvas.getContext('2d');
ctx.save(); // save the default state
ctx.fillStyle = 'green';
ctx.fillRect(10, 10, 100, 100);
ctx.restore(); // restore to the default state
ctx.fillRect(150, 75, 100, 100);

Edit the code below and see your changes update live in the canvas:

Playable code
<div id="canvasTarget">
</div>
<div class="playable-buttons">
  <input id="run" type="button" value="Run" />
  <input id="edit" type="button" value="Edit" />
  <input id="reset" type="button" value="Reset" />
</div>
<textarea id="code" class="playable-code">
ctx.save();
ctx.fillStyle = "green";
ctx.fillRect(10, 10, 100, 100);
ctx.restore();
ctx.fillRect(150, 75, 100, 100);</textarea>
var canvasTarget = document.getElementById("canvasTarget");
var textarea = document.getElementById("code");
var run = document.getElementById("run");
var reset = document.getElementById("reset");
var edit = document.getElementById("edit");
var code = textarea.value;
var canvas;
var ctx;
function drawCanvas() {
  if (canvas) {
  	canvasTarget.removeChild(canvas);
  }
  canvas = document.createElement('canvas');
  canvasTarget.appendChild(canvas);
  canvas.width = 400;
  canvas.height = 200;
  ctx = canvas.getContext("2d");
  eval(textarea.value);
}
reset.addEventListener("click", function() {
  textarea.value = code;
  drawCanvas();
});
edit.addEventListener("click", function() {
  textarea.focus();
})
run.addEventListener("click", drawCanvas);
window.addEventListener("load", drawCanvas);

Specifications

Specification Status Comment
WHATWG HTML Living Standard
The definition of 'CanvasRenderingContext2D.restore' in that specification.
Living Standard  

Browser compatibility

Feature Chrome Edge Firefox (Gecko) Internet Explorer Opera Safari
Basic support (Yes) (Yes) (Yes) (Yes) (Yes) (Yes)
Feature Android Chrome for Android Edge Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support (Yes) (Yes) (Yes) (Yes) (Yes) (Yes) (Yes)

See also

Document Tags and Contributors

 Contributors to this page: simonseyock, nmve, erikadoyle, fscholz
 Last updated by: simonseyock,