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.

save

Summary

Saves the current state of the context. Use the restore() method to retrieve the saved state.

Method of apis/canvas/CanvasRenderingContext2Dapis/canvas/CanvasRenderingContext2D

Syntax

var object = object.save();

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

The save and restore methods preserve and restore the state of a context, but not specific paths or graphics. The following attributes and states are affected:

  • The current transformation matrix
  • The current clipping region
  • The current values of the following attributes:
    • strokeStyle
    • fillStyle
    • globalAlpha
    • lineWidth
    • lineCap
    • lineJoin
    • miterLimit

Related specifications

W3C HTML Canvas 2D Specification
W3C Candidate Recommendation

Attributions