fabric.js/docs/symbols/fabric.html

910 lines
21 KiB
HTML

<!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 - fabric</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><i><a href="../symbols/_global_.html">_global_</a></i></li>
<li><a href="../symbols/Array.html">Array</a></li>
<li><a href="../symbols/fabric.html">fabric</a></li>
<li><a href="../symbols/fabric.Canvas.html">fabric.Canvas</a></li>
<li><a href="../symbols/fabric.Canvas%23cache.html">fabric.Canvas#cache</a></li>
<li><a href="../symbols/fabric.Circle.html">fabric.Circle</a></li>
<li><a href="../symbols/fabric.Color.html">fabric.Color</a></li>
<li><a href="../symbols/fabric.Element.html">fabric.Element</a></li>
<li><a href="../symbols/fabric.Ellipse.html">fabric.Ellipse</a></li>
<li><a href="../symbols/fabric.Gradient.html">fabric.Gradient</a></li>
<li><a href="../symbols/fabric.Group.html">fabric.Group</a></li>
<li><a href="../symbols/fabric.Image.html">fabric.Image</a></li>
<li><a href="../symbols/fabric.Intersection.html">fabric.Intersection</a></li>
<li><a href="../symbols/fabric.Line.html">fabric.Line</a></li>
<li><a href="../symbols/fabric.Object.html">fabric.Object</a></li>
<li><a href="../symbols/fabric.Path.html">fabric.Path</a></li>
<li><a href="../symbols/fabric.PathGroup.html">fabric.PathGroup</a></li>
<li><a href="../symbols/fabric.Point.html">fabric.Point</a></li>
<li><a href="../symbols/fabric.Polygon.html">fabric.Polygon</a></li>
<li><a href="../symbols/fabric.Polyline.html">fabric.Polyline</a></li>
<li><a href="../symbols/fabric.Rect.html">fabric.Rect</a></li>
<li><a href="../symbols/fabric.Text.html">fabric.Text</a></li>
<li><a href="../symbols/fabric.Triangle.html">fabric.Triangle</a></li>
<li><a href="../symbols/fabric.util.html">fabric.util</a></li>
<li><a href="../symbols/fabric.util.array.html">fabric.util.array</a></li>
<li><a href="../symbols/fabric.util.object.html">fabric.util.object</a></li>
<li><a href="../symbols/fabric.util.string.html">fabric.util.string</a></li>
<li><a href="../symbols/Function.html">Function</a></li>
<li><a href="../symbols/String.html">String</a></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Namespace fabric
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br /><i>Defined in: </i> <a href="../symbols/src/src_parser.js.html">parser.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class fabric.">
<caption>Namespace 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">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/fabric.html#constructor">fabric</a></b>
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class fabric.">
<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">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.getCSSRules">getCSSRules</a></b>(doc)
</div>
<div class="description">Returns CSS rules for a given SVG document</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.getGradientDefs">getGradientDefs</a></b>(doc)
</div>
<div class="description">Parses an SVG document, returning all of the gradient declarations found in it</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.log">log</a></b>(Values)
</div>
<div class="description">Wrapper around `console.log` (when available)</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.parseAttributes">parseAttributes</a></b>(element, attributes)
</div>
<div class="description">Returns an object of attributes' name/value, given element and an array of attribute names;
Parses parent "g" nodes recursively upwards.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.parseElements">parseElements</a></b>(elements, callback, options)
</div>
<div class="description">Transforms an array of svg elements to corresponding fabric.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.parsePointsAttribute">parsePointsAttribute</a></b>(points)
</div>
<div class="description">Parses "points" attribute, returning an array of values</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.parseStyleAttribute">parseStyleAttribute</a></b>(element)
</div>
<div class="description">Parses "style" attribute, retuning an object with values</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.parseSVGDocument">parseSVGDocument</a></b>(doc, callback)
</div>
<div class="description">Parses an SVG document, converts it to an array of corresponding fabric.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.parseTransformAttribute">parseTransformAttribute</a></b>(attributeValue)
</div>
<div class="description">Parses "transform" attribute, returning an array of values</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.<b><a href="../symbols/fabric.html#.warn">warn</a></b>(Values)
</div>
<div class="description">Wrapper around `console.warn` (when available)</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Namespace Detail
</div>
<div class="fixedFont">
<b>fabric</b>
</div>
<div class="description">
</div>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name=".getCSSRules"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Object}</span>
<span class="light">fabric.</span><b>getCSSRules</b>(doc)
</div>
<div class="description">
Returns CSS rules for a given SVG document
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{SVGDocument}</span> <b>doc</b>
</dt>
<dd>SVG document to parse</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> CSS rules of this document</dd>
</dl>
<hr />
<a name=".getGradientDefs"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Object}</span>
<span class="light">fabric.</span><b>getGradientDefs</b>(doc)
</div>
<div class="description">
Parses an SVG document, returning all of the gradient declarations found in it
<br />
<i>Defined in: </i> <a href="../symbols/src/src_gradient.js.html">gradient.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{SVGDocument}</span> <b>doc</b>
</dt>
<dd>SVG document to parse</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> Gradient definitions; key corresponds to element id, value -- to gradient definition element</dd>
</dl>
<hr />
<a name=".log"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">fabric.</span><b>log</b>(Values)
</div>
<div class="description">
Wrapper around `console.log` (when available)
<br />
<i>Defined in: </i> <a href="../symbols/src/fabric.js.html">fabric.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Any}</span> <b>Values</b>
</dt>
<dd>to log</dd>
</dl>
<hr />
<a name=".parseAttributes"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Object}</span>
<span class="light">fabric.</span><b>parseAttributes</b>(element, attributes)
</div>
<div class="description">
Returns an object of attributes' name/value, given element and an array of attribute names;
Parses parent "g" nodes recursively upwards.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{DOMElement}</span> <b>element</b>
</dt>
<dd>Element to parse</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>attributes</b>
</dt>
<dd>Array of attributes to parse</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> object containing parsed attributes' names/values</dd>
</dl>
<hr />
<a name=".parseElements"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">fabric.</span><b>parseElements</b>(elements, callback, options)
</div>
<div class="description">
Transforms an array of svg elements to corresponding fabric.* instances
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>elements</b>
</dt>
<dd>Array of elements to parse</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Function.html">Function</a>}</span> <b>callback</b>
</dt>
<dd>Being passed an array of fabric instances (transformed from SVG elements)</dd>
<dt>
<span class="light fixedFont">{Object}</span> <b>options</b>
</dt>
<dd>Options object</dd>
</dl>
<hr />
<a name=".parsePointsAttribute"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
<span class="light">fabric.</span><b>parsePointsAttribute</b>(points)
</div>
<div class="description">
Parses "points" attribute, returning an array of values
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>points</b>
</dt>
<dd>{String} points attribute string</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> array of points</dd>
</dl>
<hr />
<a name=".parseStyleAttribute"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{Object}</span>
<span class="light">fabric.</span><b>parseStyleAttribute</b>(element)
</div>
<div class="description">
Parses "style" attribute, retuning an object with values
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{SVGElement}</span> <b>element</b>
</dt>
<dd>Element to parse</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> Objects with values parsed from style attribute of an element</dd>
</dl>
<hr />
<a name=".parseSVGDocument"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">fabric.</span><b>parseSVGDocument</b>(doc, callback)
</div>
<div class="description">
Parses an SVG document, converts it to an array of corresponding fabric.* instances and passes them to a callback
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{SVGDocument}</span> <b>doc</b>
</dt>
<dd>SVG document to parse</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Function.html">Function</a>}</span> <b>callback</b>
</dt>
<dd>Callback to call when parsing is finished; It's being passed an array of elements (parsed from a document).</dd>
</dl>
<hr />
<a name=".parseTransformAttribute"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
<span class="light">fabric.</span><b>parseTransformAttribute</b>(attributeValue)
</div>
<div class="description">
Parses "transform" attribute, returning an array of values
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>attributeValue</b>
</dt>
<dd>{String} string containing attribute value</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> array of 6 elements representing transformation matrix</dd>
</dl>
<hr />
<a name=".warn"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">fabric.</span><b>warn</b>(Values)
</div>
<div class="description">
Wrapper around `console.warn` (when available)
<br />
<i>Defined in: </i> <a href="../symbols/src/fabric.js.html">fabric.js</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Any}</span> <b>Values</b>
</dt>
<dd>to log as a warning</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.4.0 on Tue Jun 28 2011 18:47:43 GMT-0400 (EDT)
</div>
</body>
</html>