diff options
author | Bryan Berry <bryan@olenepal.org> | 2010-02-17 09:39:34 (GMT) |
---|---|---|
committer | Bryan Berry <bryan@olenepal.org> | 2010-02-17 09:39:34 (GMT) |
commit | 0aa48d0503c69c9ebc1d2bb209bfbec10e8bed64 (patch) | |
tree | 5008d89f95d62696440785a85c08949a7fd27c97 /docs/symbols/Karma.kCanvas.html |
initial commit. Lesson English_Animal_Identification is current template
Diffstat (limited to 'docs/symbols/Karma.kCanvas.html')
-rwxr-xr-x | docs/symbols/Karma.kCanvas.html | 3409 |
1 files changed, 3409 insertions, 0 deletions
diff --git a/docs/symbols/Karma.kCanvas.html b/docs/symbols/Karma.kCanvas.html new file mode 100755 index 0000000..cfc4492 --- /dev/null +++ b/docs/symbols/Karma.kCanvas.html @@ -0,0 +1,3409 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - Karma.kCanvas</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><a href="../symbols/%24.ui.feedback.html">$.ui.feedback</a></li> + + <li><a href="../symbols/%24.ui.feedback.defaults.html">$.ui.feedback.defaults</a></li> + + <li><a href="../symbols/%24.ui.kFooter.html">$.ui.kFooter</a></li> + + <li><a href="../symbols/%24.ui.kFooter.defaults.html">$.ui.kFooter.defaults</a></li> + + <li><a href="../symbols/%24.ui.kHeader.html">$.ui.kHeader</a></li> + + <li><a href="../symbols/%24.ui.kHeader.defaults.html">$.ui.kHeader.defaults</a></li> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Karma.html">Karma</a></li> + + <li><a href="../symbols/Karma.kAudio.html">Karma.kAudio</a></li> + + <li><a href="../symbols/Karma.kCanvas.html">Karma.kCanvas</a></li> + + <li><a href="../symbols/Karma.kImage.html">Karma.kImage</a></li> + + <li><a href="../symbols/Karma.kSvg.html">Karma.kSvg</a></li> + + <li><a href="../symbols/Karma.kVideo.html">Karma.kVideo</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Class Karma.kCanvas + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + + This object is the prototype for each canvas element submitted to Karma in the +Karma() method + + + <br /><i>Defined in: </i> <a href="../symbols/src/js_karma.js.html">karma.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Karma.kCanvas."> + <caption>Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/Karma.kCanvas.html#constructor">Karma.kCanvas</a></b>() + </div> + <div class="description">Prototype object for each canvas element submitted to Karma in the +Karma() method</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Karma.kCanvas."> + <caption>Field Summary</caption> + <thead> + <tr> + <th scope="col">Field Attributes</th> + <th scope="col">Field Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.ctx">ctx</a></b> + </div> + <div class="description">The 2 Dimensional Rendering context property for this canvas</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.domId">domId</a></b> + </div> + <div class="description">Element ID for canvas element in html document.</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.height">height</a></b> + </div> + <div class="description">Height of canvas element</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.name">name</a></b> + </div> + <div class="description">Name of the canvas, used internally by karma.js</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.node">node</a></b> + </div> + <div class="description">Reference to the DOM element</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.visible">visible</a></b> + </div> + <div class="description">Whether canvas is visible</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont"> + Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.width">width</a></b> + </div> + <div class="description">Width of canvas element</div> + </td> + </tr> + + </tbody> + </table> + + + + + +<!-- ============================== methods summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Karma.kCanvas."> + <caption>Method Summary</caption> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.arc">arc</a></b>() + </div> + <div class="description">Create an arc + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.arcTo">arcTo</a></b>() + </div> + <div class="description">Draw an arc to the given points + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.beginPath">beginPath</a></b>() + </div> + <div class="description">Begin a path + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.bezierCurveTo">bezierCurveTo</a></b>() + </div> + <div class="description">Draw a bezier curve to given coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.clear">clear</a></b>(x, y, width, height) + </div> + <div class="description">Clear area of canvas element specified by parameters, if no +parameters supplied, clears entire canvas</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.clearRect">clearRect</a></b>() + </div> + <div class="description">Clear a rectangular area + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.clip">clip</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.closePath">closePath</a></b>() + </div> + <div class="description">End a path + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.createImageData">createImageData</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.createLinearGradient">createLinearGradient</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.createPattern">createPattern</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.createRadialGradient">createRadialGradient</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.drawImage">drawImage</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.drawWindow">drawWindow</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.fill">fill</a></b>() + </div> + <div class="description">fill in the current subpaths with the current fillstyle + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.fillRect">fillRect</a></b>() + </div> + <div class="description">Fill a rectangular area + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.fillStyle">fillStyle</a></b>() + </div> + <div class="description">Sets the fill style + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.fillText">fillText</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.font">font</a></b>() + </div> + <div class="description">Sets the font property and takes the same syntax as setting the font property + in CSS + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.getImageData">getImageData</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.globalAlpha">globalAlpha</a></b>(number) + </div> + <div class="description">The globalAlpha attribute gives an alpha value that is applied to shapes +and images before they are composited onto the canvas</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.globalCompositeOperation">globalCompositeOperation</a></b>(globalCompositeOperation) + </div> + <div class="description">Sets the globalCompositeOperation attribute, which sets how shapes and images +are drawn onto the existing bitmap, once they have had globalAlpha and the +current transformation matrix applied.</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.isPointInPath">isPointInPath</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.lineCap">lineCap</a></b>(type) + </div> + <div class="description">The lineCap attribute defines the type of endings that UAs will place on +the end of lines.</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.lineJoin">lineJoin</a></b>(type) + </div> + <div class="description">The lineJoin attribute defines the type of corners that UAs will place +where two lines meet.</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.lineTo">lineTo</a></b>() + </div> + <div class="description">Draw a line to the given coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.lineWidth">lineWidth</a></b>(lineWidth) + </div> + <div class="description">Sets the lineWidth attribute which gives the width of lines, in coordinate space +units.</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.measureText">measureText</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.miterLimit">miterLimit</a></b>(number) + </div> + <div class="description">Sets the miter limit + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.moveTo">moveTo</a></b>() + </div> + <div class="description">Move to specified coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.putImageData">putImageData</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.quadraticCurveTo">quadraticCurveTo</a></b>() + </div> + <div class="description">Draw a quadratic curve to given coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.rect">rect</a></b>() + </div> + <div class="description">Create a rectangle + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.restore">restore</a></b>() + </div> + <div class="description">Restore the saved context + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.rotate">rotate</a></b>() + </div> + <div class="description">Perform a rotation transformation + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.save">save</a></b>() + </div> + <div class="description">Save the current state of the context + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.scale">scale</a></b>() + </div> + <div class="description">Perform a scale transformation + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.setTransform">setTransform</a></b>() + </div> + <div class="description">Set the transform + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.shadowBlur">shadowBlur</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.shadowColor">shadowColor</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.shadowOffsetX">shadowOffsetX</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.shadowOffsetY">shadowOffsetY</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.stroke">stroke</a></b>() + </div> + <div class="description">Stroke the subpaths + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.strokeRect">strokeRect</a></b>() + </div> + <div class="description">Draw the outline of the rectangle + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.strokeStyle">strokeStyle</a></b>() + </div> + <div class="description">Sets the stroke style + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.strokeText">strokeText</a></b>() + </div> + <div class="description">description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.textAlign">textAlign</a></b>(alignment) + </div> + <div class="description">Changes the text alignment.</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.textBaseline">textBaseline</a></b>(alignment) + </div> + <div class="description">Changes the baseline alignment.</div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.transform">transform</a></b>() + </div> + <div class="description">Transform the identity matrix + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + <tr> + <td class="attributes"><static> </td> + <td class="nameDescription"> + <div class="fixedFont">Karma.kCanvas.<b><a href="../symbols/Karma.kCanvas.html#.translate">translate</a></b>() + </div> + <div class="description">Performa a translation transformation + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a></div> + </td> + </tr> + + </tbody> + </table> + + + + +<!-- ============================== events summary ======================== --> + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Class Detail + </div> + + <div class="fixedFont"> + <b>Karma.kCanvas</b>() + </div> + + <div class="description"> + Prototype object for each canvas element submitted to Karma in the +Karma() method + + </div> + + + + + + + + + <dl class="detailList"> + <dt class="heading">Throws:</dt> + + <dt> + <span class="light fixedFont">{Error}</span> <b></b> + </dt> + <dd>if the name and domId for the canvas element are not specified</dd> + + </dl> + + + + + + </div> + + +<!-- ============================== field details ========================== --> + + <div class="sectionTitle"> + Field Detail + </div> + + <a name=".ctx"> </a> + <div class="fixedFont"><static> + + <span class="light">{2DRenderingContext}</span> + <span class="light">Karma.kCanvas.</span><b>ctx</b> + + </div> + <div class="description"> + The 2 Dimensional Rendering context property for this canvas + + + </div> + + + + <pre class="code">//Almost all of the context attributes and methods are wrapped in helper functions +//but you can also access them directly using the ctx property +Karma.canvas.someCanvas.ctx.drawImage(someImage, x, y); +Karma.canvas.someCanvas.ctx.fillStyle = "#ffffff";</pre> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + undefined + </dd> + </dl> + + + <hr /> + + <a name=".domId"> </a> + <div class="fixedFont"><static> + + <span class="light">{String}</span> + <span class="light">Karma.kCanvas.</span><b>domId</b> + + </div> + <div class="description"> + Element ID for canvas element in html document. This value is read-only + + + </div> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + undefined + </dd> + </dl> + + + <hr /> + + <a name=".height"> </a> + <div class="fixedFont"><static> + + <span class="light">{Number}</span> + <span class="light">Karma.kCanvas.</span><b>height</b> + + </div> + <div class="description"> + Height of canvas element + + + </div> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + 0 + </dd> + </dl> + + + <hr /> + + <a name=".name"> </a> + <div class="fixedFont"><static> + + <span class="light">{String}</span> + <span class="light">Karma.kCanvas.</span><b>name</b> + + </div> + <div class="description"> + Name of the canvas, used internally by karma.js + + + </div> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + '' + </dd> + </dl> + + + <hr /> + + <a name=".node"> </a> + <div class="fixedFont"><static> + + <span class="light">{DOMElement}</span> + <span class="light">Karma.kCanvas.</span><b>node</b> + + </div> + <div class="description"> + Reference to the DOM element + + + </div> + + + + <pre class="code">//You can access all properties and methods of the underlying DOM element +//using the 'node' property +Karma.canvas.someCanvas.node.dispatchEvent( ... some event ...); +var stuff = Karma.canvas.someCanvas.node.innerHTML;</pre> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + undefined + </dd> + </dl> + + + <hr /> + + <a name=".visible"> </a> + <div class="fixedFont"><static> + + <span class="light">{boolean}</span> + <span class="light">Karma.kCanvas.</span><b>visible</b> + + </div> + <div class="description"> + Whether canvas is visible + + + </div> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + true + </dd> + </dl> + + + <hr /> + + <a name=".width"> </a> + <div class="fixedFont"><static> + + <span class="light">{Number}</span> + <span class="light">Karma.kCanvas.</span><b>width</b> + + </div> + <div class="description"> + Width of canvas element + + + </div> + + + + + + + + <dl class="detailList"> + <dt class="heading">Default Value:</dt> + <dd> + 0 + </dd> + </dl> + + + + + + +<!-- ============================== method details ========================= --> + + <div class="sectionTitle"> + Method Detail + </div> + + <a name=".arc"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>arc</b>() + + </div> + <div class="description"> + Create an arc + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".arcTo"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>arcTo</b>() + + </div> + <div class="description"> + Draw an arc to the given points + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".beginPath"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>beginPath</b>() + + </div> + <div class="description"> + Begin a path + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".bezierCurveTo"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>bezierCurveTo</b>() + + </div> + <div class="description"> + Draw a bezier curve to given coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".clear"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>clear</b>(x, y, width, height) + + </div> + <div class="description"> + Clear area of canvas element specified by parameters, if no +parameters supplied, clears entire canvas + + + </div> + + + + <pre class="code"> +k.canvas.ninja.clear(); +// clears the entire ninja canvas + +k.canvas.ninja.clear(0, 10, 20, 30); +//clears a specific portion of the ninja canvas</pre> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>x</b> + <i>Optional, Default: 0</i> + </dt> + <dd>x coordinate, defaults to zero if left blank</dd> + + <dt> + <span class="light fixedFont">{Number}</span> <b>y</b> + <i>Optional, Default: 0</i> + </dt> + <dd>y coordinate, defaults to zero if left blank</dd> + + <dt> + <span class="light fixedFont">{Number}</span> <b>width</b> + <i>Optional, Default: 0</i> + </dt> + <dd>width of area to be cleared, defaults +entire width of canvas</dd> + + <dt> + <span class="light fixedFont">{Number}</span> <b>height</b> + <i>Optional, Default: 0</i> + </dt> + <dd>height of area to be cleared, defaults +entire height of canvas</dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".clearRect"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>clearRect</b>() + + </div> + <div class="description"> + Clear a rectangular area + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".clip"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>clip</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".closePath"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>closePath</b>() + + </div> + <div class="description"> + End a path + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".createImageData"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>createImageData</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".createLinearGradient"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>createLinearGradient</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".createPattern"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>createPattern</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".createRadialGradient"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>createRadialGradient</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".drawImage"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>drawImage</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".drawWindow"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>drawWindow</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".fill"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>fill</b>() + + </div> + <div class="description"> + fill in the current subpaths with the current fillstyle + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".fillRect"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>fillRect</b>() + + </div> + <div class="description"> + Fill a rectangular area + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".fillStyle"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>fillStyle</b>() + + </div> + <div class="description"> + Sets the fill style + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".fillText"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>fillText</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".font"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>font</b>() + + </div> + <div class="description"> + Sets the font property and takes the same syntax as setting the font property + in CSS + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".getImageData"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>getImageData</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".globalAlpha"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>globalAlpha</b>(number) + + </div> + <div class="description"> + The globalAlpha attribute gives an alpha value that is applied to shapes +and images before they are composited onto the canvas + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>number</b> + + </dt> + <dd>in the range from 0.0 to 1.0</dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".globalCompositeOperation"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>globalCompositeOperation</b>(globalCompositeOperation) + + </div> + <div class="description"> + Sets the globalCompositeOperation attribute, which sets how shapes and images +are drawn onto the existing bitmap, once they have had globalAlpha and the +current transformation matrix applied. +For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>globalCompositeOperation</b> + + </dt> + <dd>source-atop, +source-in, source-out, +source-over, destination-atop, destination-in, destination-out, destination-over, +lighter</dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".isPointInPath"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>isPointInPath</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".lineCap"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>lineCap</b>(type) + + </div> + <div class="description"> + The lineCap attribute defines the type of endings that UAs will place on +the end of lines. + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>type</b> + + </dt> + <dd>butt, round, square</dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".lineJoin"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>lineJoin</b>(type) + + </div> + <div class="description"> + The lineJoin attribute defines the type of corners that UAs will place +where two lines meet. The three valid values are bevel, round, and miter. + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>type</b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".lineTo"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>lineTo</b>() + + </div> + <div class="description"> + Draw a line to the given coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".lineWidth"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>lineWidth</b>(lineWidth) + + </div> + <div class="description"> + Sets the lineWidth attribute which gives the width of lines, in coordinate space +units. + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>lineWidth</b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".measureText"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>measureText</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".miterLimit"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>miterLimit</b>(number) + + </div> + <div class="description"> + Sets the miter limit + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>number</b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".moveTo"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>moveTo</b>() + + </div> + <div class="description"> + Move to specified coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".putImageData"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>putImageData</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".quadraticCurveTo"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>quadraticCurveTo</b>() + + </div> + <div class="description"> + Draw a quadratic curve to given coordinates + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".rect"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>rect</b>() + + </div> + <div class="description"> + Create a rectangle + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".restore"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>restore</b>() + + </div> + <div class="description"> + Restore the saved context + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".rotate"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>rotate</b>() + + </div> + <div class="description"> + Perform a rotation transformation + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".save"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>save</b>() + + </div> + <div class="description"> + Save the current state of the context + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".scale"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>scale</b>() + + </div> + <div class="description"> + Perform a scale transformation + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".setTransform"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>setTransform</b>() + + </div> + <div class="description"> + Set the transform + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".shadowBlur"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>shadowBlur</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".shadowColor"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>shadowColor</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".shadowOffsetX"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>shadowOffsetX</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".shadowOffsetY"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>shadowOffsetY</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".stroke"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>stroke</b>() + + </div> + <div class="description"> + Stroke the subpaths + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".strokeRect"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>strokeRect</b>() + + </div> + <div class="description"> + Draw the outline of the rectangle + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".strokeStyle"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>strokeStyle</b>() + + </div> + <div class="description"> + Sets the stroke style + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".strokeText"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>strokeText</b>() + + </div> + <div class="description"> + description + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".textAlign"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>textAlign</b>(alignment) + + </div> + <div class="description"> + Changes the text alignment. The possible values are start, end, left, right, +and center. The default is start. Other values are ignored. + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{string}</span> <b>alignment</b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".textBaseline"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>textBaseline</b>(alignment) + + </div> + <div class="description"> + Changes the baseline alignment. If the value is one of top, hanging, middle, +alphabetic, ideographic, or bottom, then the value must be changed to the new value. + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>alignment</b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".transform"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>transform</b>() + + </div> + <div class="description"> + Transform the identity matrix + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + <hr /> + + <a name=".translate"> </a> + <div class="fixedFont"><static> + + + <span class="light">Karma.kCanvas.</span><b>translate</b>() + + </div> + <div class="description"> + Performa a translation transformation + For full details see <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html#dom-context-2d-globalcompositeoperation">W3C docs</a> + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <b></b> + + </dt> + <dd></dd> + + </dl> + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd>this</dd> + + </dl> + + + + + + + + +<!-- ============================== event details ========================= --> + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Wed Feb 17 2010 14:55:45 GMT+0545 (NPT) + </div> + </body> +</html> |