Hopiu/fabric.js
1
0
Fork 0
mirror of https://github.com/Hopiu/fabric.js.git synced 2026-03-18 15:00:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
fabric.js/docs/symbols/fabric.Path.html

858 lines
22 KiB
HTML
Raw Blame History

<!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.Path</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">
Class fabric.Path
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br />Extends
<a href="../symbols/fabric.Object.html">fabric.Object</a>.<br />
Path
<br /><i>Defined in: </i> <a href="../symbols/src/src_path.class.js.html">path.class.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class fabric.Path.">
<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">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/fabric.Path.html#constructor">fabric.Path</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class fabric.Path.">
<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">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
fabric.Path.<b><a href="../symbols/fabric.Path.html#.ATTRIBUTE_NAMES">ATTRIBUTE_NAMES</a></b>
</div>
<div class="description">List of attribute names to account for when parsing SVG element (used by `fabric.Path.fromElement`)</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Path.html#type">type</a></b>
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<dl class="inheritsList">
<dt>Fields borrowed from class <a href="../symbols/fabric.Object.html">fabric.Object</a>: </dt><dd><a href="../symbols/fabric.Object.html#FX_DURATION">FX_DURATION</a>, <a href="../symbols/fabric.Object.html#FX_TRANSITION">FX_TRANSITION</a>, <a href="../symbols/fabric.Object.html#includeDefaultValues">includeDefaultValues</a>, <a href="../symbols/fabric.Object.html#MIN_SCALE_LIMIT">MIN_SCALE_LIMIT</a>, <a href="../symbols/fabric.Object.html#NUM_FRACTION_DIGITS">NUM_FRACTION_DIGITS</a>, <a href="../symbols/fabric.Object.html#rotate">rotate</a>, <a href="../symbols/fabric.Object.html#selectable">selectable</a>, <a href="../symbols/fabric.Object.html#stateProperties">stateProperties</a></dd>
</dl>
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class fabric.Path.">
<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">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Path.html#complexity">complexity</a></b>()
</div>
<div class="description">Returns number representation of an instance complexity</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.Path.<b><a href="../symbols/fabric.Path.html#.fromElement">fromElement</a></b>(element, options)
</div>
<div class="description">Creates an instance of fabric.Path from an SVG <path> element</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">fabric.Path.<b><a href="../symbols/fabric.Path.html#.fromObject">fromObject</a></b>(object)
</div>
<div class="description">Creates an instance of fabric.Path from an object</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Path.html#initialize">initialize</a></b>(path, options)
</div>
<div class="description">Constructor</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Path.html#render">render</a></b>(ctx, noTransform)
</div>
<div class="description">Renders path on a specified context</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Path.html#toDatalessObject">toDatalessObject</a></b>()
</div>
<div class="description">Returns dataless object representation of an instance</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Path.html#toObject">toObject</a></b>()
</div>
<div class="description">Returns object representation of an instance</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Path.html#toString">toString</a></b>()
</div>
<div class="description">Returns string representation of an instance</div>
</td>
</tr>
</tbody>
</table>
<dl class="inheritsList">
<dt>Methods borrowed from class <a href="../symbols/fabric.Object.html">fabric.Object</a>: </dt><dd><a href="../symbols/fabric.Object.html#callSuper">callSuper</a>, <a href="../symbols/fabric.Object.html#clone">clone</a>, <a href="../symbols/fabric.Object.html#cloneAsImage">cloneAsImage</a>, <a href="../symbols/fabric.Object.html#drawBorders">drawBorders</a>, <a href="../symbols/fabric.Object.html#drawCorners">drawCorners</a>, <a href="../symbols/fabric.Object.html#fxRemove">fxRemove</a>, <a href="../symbols/fabric.Object.html#fxStraighten">fxStraighten</a>, <a href="../symbols/fabric.Object.html#get">get</a>, <a href="../symbols/fabric.Object.html#getAngle">getAngle</a>, <a href="../symbols/fabric.Object.html#getCenter">getCenter</a>, <a href="../symbols/fabric.Object.html#getHeight">getHeight</a>, <a href="../symbols/fabric.Object.html#getWidth">getWidth</a>, <a href="../symbols/fabric.Object.html#hasStateChanged">hasStateChanged</a>, <a href="../symbols/fabric.Object.html#intersectsWithObject">intersectsWithObject</a>, <a href="../symbols/fabric.Object.html#intersectsWithRect">intersectsWithRect</a>, <a href="../symbols/fabric.Object.html#isActive">isActive</a>, <a href="../symbols/fabric.Object.html#isContainedWithinRect">isContainedWithinRect</a>, <a href="../symbols/fabric.Object.html#isType">isType</a>, <a href="../symbols/fabric.Object.html#saveState">saveState</a>, <a href="../symbols/fabric.Object.html#scale">scale</a>, <a href="../symbols/fabric.Object.html#scaleToHeight">scaleToHeight</a>, <a href="../symbols/fabric.Object.html#scaleToWidth">scaleToWidth</a>, <a href="../symbols/fabric.Object.html#set">set</a>, <a href="../symbols/fabric.Object.html#setActive">setActive</a>, <a href="../symbols/fabric.Object.html#setAngle">setAngle</a>, <a href="../symbols/fabric.Object.html#setCoords">setCoords</a>, <a href="../symbols/fabric.Object.html#setGradientFill">setGradientFill</a>, <a href="../symbols/fabric.Object.html#setOpacity">setOpacity</a>, <a href="../symbols/fabric.Object.html#setOptions">setOptions</a>, <a href="../symbols/fabric.Object.html#setSourcePath">setSourcePath</a>, <a href="../symbols/fabric.Object.html#setupState">setupState</a>, <a href="../symbols/fabric.Object.html#straighten">straighten</a>, <a href="../symbols/fabric.Object.html#toDataURL">toDataURL</a>, <a href="../symbols/fabric.Object.html#toggle">toggle</a>, <a href="../symbols/fabric.Object.html#toGrayscale">toGrayscale</a>, <a href="../symbols/fabric.Object.html#toJSON">toJSON</a>, <a href="../symbols/fabric.Object.html#transform">transform</a></dd>
</dl>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
<b>fabric.Path</b>()
</div>
<div class="description">
</div>
</div>
<!-- ============================== field details ========================== -->
<div class="sectionTitle">
Field Detail
</div>
<a name=".ATTRIBUTE_NAMES"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">fabric.Path.</span><b>ATTRIBUTE_NAMES</b>
</div>
<div class="description">
List of attribute names to account for when parsing SVG element (used by `fabric.Path.fromElement`)
</div>
<dl class="detailList">
<dt class="heading">See:</dt>
<dd>http://www.w3.org/TR/SVG/paths.html#PathElement</dd>
</dl>
<hr />
<a name="type"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
<b>type</b>
</div>
<div class="description">
</div>
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="complexity"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>complexity</b>()
</div>
<div class="description">
Returns number representation of an instance complexity
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> complexity</dd>
</dl>
<hr />
<a name=".fromElement"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{<a href="../symbols/fabric.Path.html">fabric.Path</a>}</span>
<span class="light">fabric.Path.</span><b>fromElement</b>(element, options)
</div>
<div class="description">
Creates an instance of fabric.Path from an SVG <path> element
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{SVGElement}</span> <b>element</b>
</dt>
<dd>to parse</dd>
<dt>
<span class="light fixedFont">{Object}</span> <b>options</b>
</dt>
<dd>object</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Path.html">fabric.Path</a>}</span> Instance of fabric.Path</dd>
</dl>
<hr />
<a name=".fromObject"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">{<a href="../symbols/fabric.Path.html">fabric.Path</a>}</span>
<span class="light">fabric.Path.</span><b>fromObject</b>(object)
</div>
<div class="description">
Creates an instance of fabric.Path from an object
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>object</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Path.html">fabric.Path</a>}</span> Instance of fabric.Path</dd>
</dl>
<hr />
<a name="initialize"> </a>
<div class="fixedFont">
<b>initialize</b>(path, options)
</div>
<div class="description">
Constructor
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>|<a href="../symbols/String.html">String</a>}</span> <b>path</b>
</dt>
<dd>Path data (sequence of coordinates and corresponding "command" tokens)</dd>
<dt>
<span class="light fixedFont">{Object}</span> <b>options</b>
<i>Optional</i>
</dt>
<dd>Options object</dd>
</dl>
<hr />
<a name="render"> </a>
<div class="fixedFont">
<b>render</b>(ctx, noTransform)
</div>
<div class="description">
Renders path on a specified context
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{CanvasRenderingContext2D}</span> <b>ctx</b>
</dt>
<dd>context to render path on</dd>
<dt>
<span class="light fixedFont">{Boolean}</span> <b>noTransform</b>
</dt>
<dd>When true, context is not transformed</dd>
</dl>
<hr />
<a name="toDatalessObject"> </a>
<div class="fixedFont">
<span class="light">{Object}</span>
<b>toDatalessObject</b>()
</div>
<div class="description">
Returns dataless object representation of an instance
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> </dd>
</dl>
<hr />
<a name="toObject"> </a>
<div class="fixedFont">
<span class="light">{Object}</span>
<b>toObject</b>()
</div>
<div class="description">
Returns object representation of an instance
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> </dd>
</dl>
<hr />
<a name="toString"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
<b>toString</b>()
</div>
<div class="description">
Returns string representation of an instance
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> string representation of an instance</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:44 GMT-0400 (EDT)
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink