This page is Ready to Use

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

restore

Summary

Pops the top entry from the drawing state stack, and reset the drawing state it describes. If there is no saved state, the method does nothing.

Method of apis/canvas/CanvasRenderingContext2Dapis/canvas/CanvasRenderingContext2D

Syntax

var object = object.restore();

Return Value

Returns an object of type DOM NodeDOM Node

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Examples

<canvas id="myCanvas" width="300" height="150" style="border:1px solid blue;"></canvas>
<p>. . .</p>
<script>
var can=document.getElementById("myCanvas");
var ctxt=can.getContext("2d");
ctxt.rect(50,50,125,75);
ctxt.stroke();
ctxt.save();
ctxt.restore();
</script>

Notes

Use the restore method to retrieve a context state previously saved with the save method. Affects the following states and attributes:

  • The current transformation matrix
  • The current clipping region
  • The current values of the following attributes:
    • strokeStyle
    • fillStyle
    • globalAlpha
    • lineWidth
    • lineCap
    • lineJoin
    • miterLimit
    • shadowOffsetX
    • shadowBlur
    • shadowColor
    • globalCompositeOperation
    • font
    • textAlign
    • textBaseline

Related specifications

W3C HTML Canvas 2D Specification
W3C Candidate Recommendation

Attributions