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

2712 lines
56 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.Object</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.Object
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
Object
<br /><i>Defined in: </i> <a href="../symbols/src/src_object.class.js.html">object.class.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class fabric.Object.">
<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.Object.html#constructor">fabric.Object</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.Object.">
<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;constant&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#FX_DURATION">FX_DURATION</a></b>
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;constant&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#FX_TRANSITION">FX_TRANSITION</a></b>
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#includeDefaultValues">includeDefaultValues</a></b>
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;constant&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#MIN_SCALE_LIMIT">MIN_SCALE_LIMIT</a></b>
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&lt;constant&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#NUM_FRACTION_DIGITS">NUM_FRACTION_DIGITS</a></b>
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#rotate">rotate</a></b>
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#selectable">selectable</a></b>
</div>
<div class="description">When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection)</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#stateProperties">stateProperties</a></b>
</div>
<div class="description">List of properties to consider when checking if state of an object is changed (fabric.Object#hasStateChanged);
as well as for history (undo/redo) purposes</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/fabric.Object.html#type">type</a></b>
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class fabric.Object.">
<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.Object.html#callSuper">callSuper</a></b>(methodName)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#clone">clone</a></b>(options)
</div>
<div class="description">Clones an instance</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#cloneAsImage">cloneAsImage</a></b>(callback)
</div>
<div class="description">Creates an instance of fabric.Image out of an object</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#complexity">complexity</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#drawBorders">drawBorders</a></b>(ctx)
</div>
<div class="description">Draws borders of an object's bounding box.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#drawCorners">drawCorners</a></b>(ctx)
</div>
<div class="description">Draws corners of an object's bounding box.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#fxRemove">fxRemove</a></b>(callbacks)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#fxStraighten">fxStraighten</a></b>(callbacks)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#get">get</a></b>(property)
</div>
<div class="description">Basic getter</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#getAngle">getAngle</a></b>()
</div>
<div class="description">Returns object's angle value</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#getCenter">getCenter</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#getHeight">getHeight</a></b>()
</div>
<div class="description">Returns height of an object</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#getWidth">getWidth</a></b>()
</div>
<div class="description">Returns width of an object</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#hasStateChanged">hasStateChanged</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#initialize">initialize</a></b>(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.Object.html#intersectsWithObject">intersectsWithObject</a></b>(other)
</div>
<div class="description">Returns true if object intersects with another object</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#intersectsWithRect">intersectsWithRect</a></b>(selectionTL, selectionBR)
</div>
<div class="description">Returns true if object intersects with an area formed by 2 points</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#isActive">isActive</a></b>()
</div>
<div class="description">Returns true if an object is in its active state</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#isContainedWithinRect">isContainedWithinRect</a></b>(selectionTL, selectionBR)
</div>
<div class="description">Returns true if object is fully contained within area formed by 2 points</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#isType">isType</a></b>(type)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#render">render</a></b>(ctx, noTransform)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#saveState">saveState</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#scale">scale</a></b>(value)
</div>
<div class="description">Scales an object (equally by x and y)</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#scaleToHeight">scaleToHeight</a></b>(value)
</div>
<div class="description">Scales an object to a given height (scaling by x/y equally)</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#scaleToWidth">scaleToWidth</a></b>(value)
</div>
<div class="description">Scales an object to a given width (scaling by x/y equally)</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#set">set</a></b>(property, value)
</div>
<div class="description">Basic setter</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setActive">setActive</a></b>(active)
</div>
<div class="description">Sets state of an object - `true` makes it active, `false` - inactive</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setAngle">setAngle</a></b>(value)
</div>
<div class="description">Sets object's angle</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setCoords">setCoords</a></b>()
</div>
<div class="description">Sets corner position coordinates based on current angle, width and height.</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setGradientFill">setGradientFill</a></b>(ctx, options)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setOpacity">setOpacity</a></b>(value)
</div>
<div class="description">Sets object opacity</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setOptions">setOptions</a></b>(options)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setSourcePath">setSourcePath</a></b>(value)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#setupState">setupState</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#straighten">straighten</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.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.Object.html#toDataURL">toDataURL</a></b>()
</div>
<div class="description">Converts an object into a data-url-like string</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#toggle">toggle</a></b>(property)
</div>
<div class="description">Toggles specified property from `true` to `false` or from `false` to `true`</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#toGrayscale">toGrayscale</a></b>()
</div>
<div class="description">Makes object's color grayscale</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#toJSON">toJSON</a></b>()
</div>
<div class="description">Returns a JSON representation of an instance</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#toObject">toObject</a></b>()
</div>
<div class="description">Returns an 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.Object.html#toString">toString</a></b>()
</div>
<div class="description">Returns a string representation of an instance</div>
</td>
</tr>
<tr>
<td class="attributes">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/fabric.Object.html#transform">transform</a></b>(ctx)
</div>
<div class="description"></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>fabric.Object</b>()
</div>
<div class="description">
</div>
</div>
<!-- ============================== field details ========================== -->
<div class="sectionTitle">
Field Detail
</div>
<a name="FX_DURATION"> </a>
<div class="fixedFont">&lt;constant&gt;
<span class="light">{Number}</span>
<b>FX_DURATION</b>
</div>
<div class="description">
</div>
<hr />
<a name="FX_TRANSITION"> </a>
<div class="fixedFont">&lt;constant&gt;
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
<b>FX_TRANSITION</b>
</div>
<div class="description">
</div>
<hr />
<a name="includeDefaultValues"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>includeDefaultValues</b>
</div>
<div class="description">
</div>
<hr />
<a name="MIN_SCALE_LIMIT"> </a>
<div class="fixedFont">&lt;constant&gt;
<span class="light">{Number}</span>
<b>MIN_SCALE_LIMIT</b>
</div>
<div class="description">
</div>
<hr />
<a name="NUM_FRACTION_DIGITS"> </a>
<div class="fixedFont">&lt;constant&gt;
<span class="light">{Number}</span>
<b>NUM_FRACTION_DIGITS</b>
</div>
<div class="description">
</div>
<hr />
<a name="rotate"> </a>
<div class="fixedFont">
<b>rotate</b>
</div>
<div class="description">
</div>
<hr />
<a name="selectable"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>selectable</b>
</div>
<div class="description">
When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection)
</div>
<hr />
<a name="stateProperties"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
<b>stateProperties</b>
</div>
<div class="description">
List of properties to consider when checking if state of an object is changed (fabric.Object#hasStateChanged);
as well as for history (undo/redo) purposes
</div>
<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="callSuper"> </a>
<div class="fixedFont">
<b>callSuper</b>(methodName)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>methodName</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="clone"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>clone</b>(options)
</div>
<div class="description">
Clones an instance
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<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.Object.html">fabric.Object</a>}</span> clone of an instance</dd>
</dl>
<hr />
<a name="cloneAsImage"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>cloneAsImage</b>(callback)
</div>
<div class="description">
Creates an instance of fabric.Image out of an object
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>callback</b>
</dt>
<dd>{Function} callback, invoked with an instance as a first argument</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="complexity"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>complexity</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> </dd>
</dl>
<hr />
<a name="drawBorders"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>drawBorders</b>(ctx)
</div>
<div class="description">
Draws borders of an object's bounding box.
Requires public properties: width, height
Requires public options: padding, borderColor
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{CanvasRenderingContext2D}</span> <b>ctx</b>
</dt>
<dd>Context to draw on</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="drawCorners"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>drawCorners</b>(ctx)
</div>
<div class="description">
Draws corners of an object's bounding box.
Requires public properties: width, height, scaleX, scaleY
Requires public options: cornersize, padding
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{CanvasRenderingContext2D}</span> <b>ctx</b>
</dt>
<dd>Context to draw on</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="fxRemove"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>fxRemove</b>(callbacks)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>callbacks</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="fxStraighten"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>fxStraighten</b>(callbacks)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>callbacks</b>
</dt>
<dd>- onComplete: invoked on completion
- onChange: invoked on every step of animation</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="get"> </a>
<div class="fixedFont">
<span class="light">{Any}</span>
<b>get</b>(property)
</div>
<div class="description">
Basic getter
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Any}</span> <b>property</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Any}</span> value of a property</dd>
</dl>
<hr />
<a name="getAngle"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>getAngle</b>()
</div>
<div class="description">
Returns object's angle value
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> angle value</dd>
</dl>
<hr />
<a name="getCenter"> </a>
<div class="fixedFont">
<span class="light">{Object}</span>
<b>getCenter</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> object with `x`, `y` properties corresponding to path center coordinates</dd>
</dl>
<hr />
<a name="getHeight"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>getHeight</b>()
</div>
<div class="description">
Returns height of an object
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> height value</dd>
</dl>
<hr />
<a name="getWidth"> </a>
<div class="fixedFont">
<span class="light">{Number}</span>
<b>getWidth</b>()
</div>
<div class="description">
Returns width of an object
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Number}</span> width value</dd>
</dl>
<hr />
<a name="hasStateChanged"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>hasStateChanged</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Boolean}</span> true if instance' state has changed</dd>
</dl>
<hr />
<a name="initialize"> </a>
<div class="fixedFont">
<b>initialize</b>(options)
</div>
<div class="description">
Constructor
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>options</b>
<i>Optional</i>
</dt>
<dd>Options object</dd>
</dl>
<hr />
<a name="intersectsWithObject"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>intersectsWithObject</b>(other)
</div>
<div class="description">
Returns true if object intersects with another object
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>other</b>
</dt>
<dd>Object to test</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Boolean}</span> </dd>
</dl>
<hr />
<a name="intersectsWithRect"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>intersectsWithRect</b>(selectionTL, selectionBR)
</div>
<div class="description">
Returns true if object intersects with an area formed by 2 points
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>selectionTL</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{Object}</span> <b>selectionBR</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Boolean}</span> </dd>
</dl>
<hr />
<a name="isActive"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>isActive</b>()
</div>
<div class="description">
Returns true if an object is in its active state
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Boolean}</span> true if an object is in its active state</dd>
</dl>
<hr />
<a name="isContainedWithinRect"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>isContainedWithinRect</b>(selectionTL, selectionBR)
</div>
<div class="description">
Returns true if object is fully contained within area formed by 2 points
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>selectionTL</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{Object}</span> <b>selectionBR</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Boolean}</span> </dd>
</dl>
<hr />
<a name="isType"> </a>
<div class="fixedFont">
<span class="light">{Boolean}</span>
<b>isType</b>(type)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>type</b>
</dt>
<dd>{String} type to check against</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Boolean}</span> true if specified type is identical to the type of instance</dd>
</dl>
<hr />
<a name="render"> </a>
<div class="fixedFont">
<b>render</b>(ctx, noTransform)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{CanvasRenderingContext2D}</span> <b>ctx</b>
</dt>
<dd>context to render on</dd>
<dt>
<span class="light fixedFont">{Boolean}</span> <b>noTransform</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="saveState"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>saveState</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="scale"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>scale</b>(value)
</div>
<div class="description">
Scales an object (equally by x and y)
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>value</b>
</dt>
<dd>{Number} scale factor</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="scaleToHeight"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>scaleToHeight</b>(value)
</div>
<div class="description">
Scales an object to a given height (scaling by x/y equally)
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>value</b>
</dt>
<dd>{Number} new height value</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="scaleToWidth"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>scaleToWidth</b>(value)
</div>
<div class="description">
Scales an object to a given width (scaling by x/y equally)
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>value</b>
</dt>
<dd>{Number} new width value</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="set"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>set</b>(property, value)
</div>
<div class="description">
Basic setter
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Any}</span> <b>property</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{Any}</span> <b>value</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="setActive"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>setActive</b>(active)
</div>
<div class="description">
Sets state of an object - `true` makes it active, `false` - inactive
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Boolean}</span> <b>active</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="setAngle"> </a>
<div class="fixedFont">
<span class="light">{Object}</span>
<b>setAngle</b>(value)
</div>
<div class="description">
Sets object's angle
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>value</b>
</dt>
<dd>{Number} angle value</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{Object}</span> thisArg</dd>
</dl>
<hr />
<a name="setCoords"> </a>
<div class="fixedFont">
<b>setCoords</b>()
</div>
<div class="description">
Sets corner position coordinates based on current angle, width and height.
</div>
<hr />
<a name="setGradientFill"> </a>
<div class="fixedFont">
<b>setGradientFill</b>(ctx, options)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>ctx</b>
</dt>
<dd></dd>
<dt>
<b>options</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name="setOpacity"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>setOpacity</b>(value)
</div>
<div class="description">
Sets object opacity
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>value</b>
</dt>
<dd>{Number} value 0-1</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="setOptions"> </a>
<div class="fixedFont">
<b>setOptions</b>(options)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Object}</span> <b>options</b>
<i>Optional</i>
</dt>
<dd></dd>
</dl>
<hr />
<a name="setSourcePath"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>setSourcePath</b>(value)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>value</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="setupState"> </a>
<div class="fixedFont">
<b>setupState</b>()
</div>
<div class="description">
</div>
<hr />
<a name="straighten"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>straighten</b>()
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="toDatalessObject"> </a>
<div class="fixedFont">
<b>toDatalessObject</b>()
</div>
<div class="description">
Returns (dataless) object representation of an instance
</div>
<hr />
<a name="toDataURL"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
<b>toDataURL</b>()
</div>
<div class="description">
Converts an object into a data-url-like string
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> string of data</dd>
</dl>
<hr />
<a name="toggle"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>toggle</b>(property)
</div>
<div class="description">
Toggles specified property from `true` to `false` or from `false` to `true`
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{<a href="../symbols/String.html">String</a>}</span> <b>property</b>
</dt>
<dd>property to toggle</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="toGrayscale"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span>
<b>toGrayscale</b>()
</div>
<div class="description">
Makes object's color grayscale
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{<a href="../symbols/fabric.Object.html">fabric.Object</a>}</span> thisArg</dd>
</dl>
<hr />
<a name="toJSON"> </a>
<div class="fixedFont">
<span class="light">{<a href="../symbols/String.html">String</a>}</span>
<b>toJSON</b>()
</div>
<div class="description">
Returns a JSON 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> json</dd>
</dl>
<hr />
<a name="toObject"> </a>
<div class="fixedFont">
<span class="light">{Object}</span>
<b>toObject</b>()
</div>
<div class="description">
Returns an 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 a 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> </dd>
</dl>
<hr />
<a name="transform"> </a>
<div class="fixedFont">
<b>transform</b>(ctx)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{CanvasRenderingContext2D}</span> <b>ctx</b>
</dt>
<dd>Context</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>
Reference in a new issue View git blame Copy permalink