docs/fabric.Line.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: Line</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
    <link type="text/css" rel="stylesheet" href="styles/carbonads.css">
    <link type="text/css" rel="stylesheet" href="../css/master.css">
</head>

<body>
    <ul id="header">
      <li><a href="http://fabricjs.com/">Home</a></li>
      <li><a href="http://fabricjs.com/demos">Demos</a></li>
      <li><a href="http://fabricjs.com/articles">Tutorial</a></li>
      <li><a href="http://fabricjs.com/docs">Docs</a></li>
      <li><a href="http://fabricjs.com/build">Custom Build</a></li>
      <li><a href="http://fabricjs.com/help">Support</a></li>
      <li><a href="http://fabricjs.com/test">Tests/Benchmarks</a></li>
      <li><a href="http://fabricjs.com/team">Team</a></li>

      <li class="secondary">
        <a href="http://travis-ci.org/#!/kangax/fabric.js">
          <img src="https://api.travis-ci.org/kangax/fabric.js.png?branch=master">
        </a>
      </li>
      <li class="gittip secondary">
        <iframe style="border: 0; margin: 0; padding: 0;"
          src="https://www.gittip.com/kangax/widget.html" width="48pt" height="22pt"></iframe>
      </li>
      <li class="flattr secondary">
        <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://kangax.github.com/fabric.js"></a>
        <noscript>
          <a href="http://flattr.com/thing/391332/Fabric-js" target="_blank">
            <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" />
          </a>
        </noscript>
      </li>
      <li class="github secondary">
        <iframe src="http://ghbtns.com/github-btn.html?user=kangax&repo=fabric.js&type=watch&count=true"
          allowtransparency="true" frameborder="0" scrolling="0" width="95px" height="20px"></iframe>
      </li>
      <li class="twitter secondary">
        <a href="https://twitter.com/fabricjs" class="twitter-follow-button" data-show-count="true">Follow @fabricjs</a>
      </li>
    </ul>

    <script>
    (function() {
      if (document.location.hostname === 'localhost') {
        var links = document.getElementById('header').getElementsByTagName('a');
        for (var i = 0, len = links.length; i < len; i++) {
          // very retarted fix but fuck it
          links[i].href = links[i].href.replace('fabricjs.com', 'localhost:4000');
        }
      }
      else {
        var s = document.createElement('script'), t = document.getElementsByTagName('script')[0];
        s.async = true;
        s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
        t.parentNode.insertBefore(s, t);
        !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
      }
    })();
    </script>
    <nav>
        <div class="upperNav" >
        <script>
          (function() {
            var cx = '001658083293066718026:dbxamnxeuku';
            var gcse = document.createElement('script');
            gcse.type = 'text/javascript';
            gcse.async = true;
            gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
              '//www.google.com/cse/cse.js?cx=' + cx;
            var s = document.getElementsByTagName('script')[0];
            s.parentNode.insertBefore(gcse, s);
          })();
        </script>
        <gcse:search></gcse:search>
        </div>
        <div class="lowerNav" >
            <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="fabric.ActiveSelection.html">ActiveSelection</a></li><li><a href="fabric.BaseBrush.html">BaseBrush</a></li><li><a href="fabric.Canvas.html">Canvas</a></li><li><a href="fabric.Circle.html">Circle</a></li><li><a href="fabric.CircleBrush.html">CircleBrush</a></li><li><a href="fabric.Color.html">Color</a></li><li><a href="fabric.Ellipse.html">Ellipse</a></li><li><a href="fabric.Gradient.html">Gradient</a></li><li><a href="fabric.Group.html">Group</a></li><li><a href="fabric.Image.html">Image</a></li><li><a href="fabric.Image.filters.BaseFilter.html">BaseFilter</a></li><li><a href="fabric.Image.filters.Blur.html">Blur</a></li><li><a href="fabric.Image.filters.Brightness.html">Brightness</a></li><li><a href="fabric.Image.filters.ColorMatrix.html">ColorMatrix</a></li><li><a href="fabric.Image.filters.Contrast.html">Contrast</a></li><li><a href="fabric.Image.filters.Convolute.html">Convolute</a></li><li><a href="fabric.Image.filters.fabric.Image.filter.BlendColor.html">BlendColor</a></li><li><a href="fabric.Image.filters.fabric.Image.filter.BlendImage.html">BlendImage</a></li><li><a href="fabric.Image.filters.Gamma.html">Gamma</a></li><li><a href="fabric.Image.filters.Grayscale.html">Grayscale</a></li><li><a href="fabric.Image.filters.HueRotation.html">HueRotation</a></li><li><a href="fabric.Image.filters.Invert.html">Invert</a></li><li><a href="fabric.Image.filters.Noise.html">Noise</a></li><li><a href="fabric.Image.filters.Pixelate.html">Pixelate</a></li><li><a href="fabric.Image.filters.RemoveColor.html">RemoveColor</a></li><li><a href="fabric.Image.filters.Resize.html">Resize</a></li><li><a href="fabric.Image.filters.Saturation.html">Saturation</a></li><li><a href="fabric.Intersection.html">Intersection</a></li><li><a href="fabric.IText.html">IText</a></li><li><a href="fabric.Line.html">Line</a></li><li><a href="fabric.Object.html">Object</a></li><li><a href="fabric.Path.html">Path</a></li><li><a href="fabric.Pattern.html">Pattern</a></li><li><a href="fabric.PatternBrush.html">PatternBrush</a></li><li><a href="fabric.PencilBrush.html">PencilBrush</a></li><li><a href="fabric.Point.html">Point</a></li><li><a href="fabric.Polygon.html">Polygon</a></li><li><a href="fabric.Polyline.html">Polyline</a></li><li><a href="fabric.Rect.html">Rect</a></li><li><a href="fabric.Shadow.html">Shadow</a></li><li><a href="fabric.SprayBrush.html">SprayBrush</a></li><li><a href="fabric.StaticCanvas.html">StaticCanvas</a></li><li><a href="fabric.Text.html">Text</a></li><li><a href="fabric.Textbox.html">Textbox</a></li><li><a href="fabric.Triangle.html">Triangle</a></li></ul><h3>Namespaces</h3><ul><li><a href="fabric.html">fabric</a></li><li><a href="fabric.Collection.html">Collection</a></li><li><a href="fabric.CommonMethods.html">CommonMethods</a></li><li><a href="fabric.Image.filters.html">filters</a></li><li><a href="fabric.Observable.html">Observable</a></li><li><a href="fabric.util.html">util</a></li><li><a href="fabric.util.array.html">array</a></li><li><a href="fabric.util.ease.html">ease</a></li><li><a href="fabric.util.object.html">object</a></li><li><a href="fabric.util.string.html">string</a></li></ul><h3>Global</h3><ul><li><a href="global.html#__cachedLines">__cachedLines</a></li><li><a href="global.html#_splitTextIntoLines">_splitTextIntoLines</a></li><li><a href="global.html#_wrapLine">_wrapLine</a></li><li><a href="global.html#_wrapText">_wrapText</a></li><li><a href="global.html#applyFilters">applyFilters</a></li><li><a href="global.html#copyGLTo2DDrawImage">copyGLTo2DDrawImage</a></li><li><a href="global.html#copyGLTo2DPutImageData">copyGLTo2DPutImageData</a></li><li><a href="global.html#dynamicMinWidth">dynamicMinWidth</a></li><li><a href="global.html#initialize">initialize</a></li><li><a href="global.html#isEndOfWrapping">isEndOfWrapping</a></li><li><a href="global.html#lockScalingFlip">lockScalingFlip</a></li><li><a href="global.html#minWidth">minWidth</a></li><li><a href="global.html#noScaleCache">noScaleCache</a></li><li><a href="global.html#styleHas">styleHas</a></li><li><a href="global.html#toObject">toObject</a></li><li><a href="global.html#type">type</a></li></ul>
        </div>
    </nav>
<div id="main">
    <h1 class="page-title">Class: Line</h1>
    

<section>

<header>
    
        <h2>
            <span class="ancestors"><a href="fabric.html">fabric</a>.</span>Line</h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h4 class="name" id="Line"><a href="#Line" ><span class="type-signature"></span>new Line<span class="signature">()</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Line class
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15543">line 15543</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="fabric.Line.html#initialize">fabric.Line#initialize</a> for constructor definition</li>
        </ul>
    </dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Extends</h3>

        
    <ul>
        <li><a href="fabric.Object.html">fabric.Object</a></li>
    </ul>


        <h3 class="subsection-title">Members</h3>

        
<h4 class="name" id=".ATTRIBUTE_NAMES"><a href="#.ATTRIBUTE_NAMES" ><span class="type-signature">(static) </span>ATTRIBUTE_NAMES<span class="type-signature"></span></a></h4>


<div class="description">
    List of attribute names to account for when parsing SVG element (used by <a href="fabric.Line.html#.fromElement">fabric.Line.fromElement</a>)
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15808">line 15808</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http://www.w3.org/TR/SVG/shapes.html#LineElement">http://www.w3.org/TR/SVG/shapes.html#LineElement</a></li>
        </ul>
    </dd>
    

</dl>


<div class="inherited">

<h4 class="name" id="__corner"><a href="#__corner" ><span class="type-signature"></span>__corner<span class="type-signature"> :number|string|any</span></a></h4>


<div class="description">
    keeps the value of the last hovered coner during mouse move.
0 is no corner, or 'mt', 'ml', 'mtr' etc..
It should be private, but there is no harm in using it as
a read-only property.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">number</span>
|

<span class="param-type">string</span>
|

<span class="param-type">any</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#__corner">fabric.Object#__corner</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>0</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12414">line 12414</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="aCoords"><a href="#aCoords" ><span class="type-signature"></span>aCoords<span class="type-signature"></span></a></h4>


<div class="description">
    Describe object's corner position in canvas object absolute coordinates
properties are tl,tr,bl,br and describe the four main corner.
each property is an object with x, y, instance of Fabric.Point.
The coordinates depends from this properties: width, height, scaleX, scaleY
skewX, skewY, angle, strokeWidth, top, left.
Those coordinates are usefull to understand where an object is. They get updated
with oCoords but they do not need to be updated when zoom or panning change.
The coordinates get updated with @method setCoords.
You can calculate them without updating with @method calcCoords(true);
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#aCoords">fabric.Object#aCoords</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13945">line 13945</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="angle"><a href="#angle" ><span class="type-signature"></span>angle<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Angle of rotation of an object (in degrees)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#angle">fabric.Object#angle</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11996">line 11996</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="backgroundColor"><a href="#backgroundColor" ><span class="type-signature"></span>backgroundColor<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Background color of an object.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#backgroundColor">fabric.Object#backgroundColor</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12138">line 12138</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="borderColor"><a href="#borderColor" ><span class="type-signature"></span>borderColor<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Color of controlling borders of an object (when it's active)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#borderColor">fabric.Object#borderColor</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>rgba(102,153,255,0.75)</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12052">line 12052</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="borderDashArray"><a href="#borderDashArray" ><span class="type-signature"></span>borderDashArray<span class="type-signature"> :Array</span></a></h4>


<div class="description">
    Array specifying dash pattern of an object's borders (hasBorder must be true)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>1.6.2</li></ul></dd>
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#borderDashArray">fabric.Object#borderDashArray</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12059">line 12059</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="borderOpacityWhenMoving"><a href="#borderOpacityWhenMoving" ><span class="type-signature"></span>borderOpacityWhenMoving<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Opacity of object's controlling borders when object is active and moving
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#borderOpacityWhenMoving">fabric.Object#borderOpacityWhenMoving</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>0.4</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12201">line 12201</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="borderScaleFactor"><a href="#borderScaleFactor" ><span class="type-signature"></span>borderScaleFactor<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Scale factor of object's controlling borders
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#borderScaleFactor">fabric.Object#borderScaleFactor</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>1</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12208">line 12208</a>
    </li></ul></dd>
    

</dl>


</div>


<h4 class="name" id="cacheProperties"><a href="#cacheProperties" ><span class="type-signature"></span>cacheProperties<span class="type-signature"> :Array</span></a></h4>


<div class="description">
    List of properties to consider when checking if cache needs refresh
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="fabric.Object.html#cacheProperties">fabric.Object#cacheProperties</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12440">line 12440</a>
    </li></ul></dd>
    

</dl>


<div class="inherited">

<h4 class="name" id="centeredRotation"><a href="#centeredRotation" ><span class="type-signature"></span>centeredRotation<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When true, this object will use center point as the origin of transformation
when being rotated via the controls.
<b>Backwards incompatibility note:</b> This property replaces "centerTransform" (Boolean).
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>1.3.4</li></ul></dd>
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#centeredRotation">fabric.Object#centeredRotation</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12108">line 12108</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="centeredScaling"><a href="#centeredScaling" ><span class="type-signature"></span>centeredScaling<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When true, this object will use center point as the origin of transformation
when being scaled via the controls.
<b>Backwards incompatibility note:</b> This property replaces "centerTransform" (Boolean).
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>1.3.4</li></ul></dd>
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#centeredScaling">fabric.Object#centeredScaling</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12098">line 12098</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="clipTo"><a href="#clipTo" ><span class="type-signature"></span>clipTo<span class="type-signature"> :function</span></a></h4>


<div class="description">
    Function that determines clipping of an object (context is passed as a first argument)
Note that context origin is at the object's center point (not left/top corner)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">function</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#clipTo">fabric.Object#clipTo</a>
    </li></ul></dd>
    

        <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>since 2.0.0</li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12293">line 12293</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="cornerColor"><a href="#cornerColor" ><span class="type-signature"></span>cornerColor<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Color of controlling corners of an object (when it's active)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#cornerColor">fabric.Object#cornerColor</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>rgba(102,153,255,0.5)</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12066">line 12066</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="cornerDashArray"><a href="#cornerDashArray" ><span class="type-signature"></span>cornerDashArray<span class="type-signature"> :Array</span></a></h4>


<div class="description">
    Array specifying dash pattern of an object's control (hasBorder must be true)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>1.6.2</li></ul></dd>
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#cornerDashArray">fabric.Object#cornerDashArray</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12088">line 12088</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="cornerSize"><a href="#cornerSize" ><span class="type-signature"></span>cornerSize<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Size of object's controlling corners (in pixels)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#cornerSize">fabric.Object#cornerSize</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>13</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12017">line 12017</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="cornerStrokeColor"><a href="#cornerStrokeColor" ><span class="type-signature"></span>cornerStrokeColor<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Color of controlling corners of an object (when it's active and transparentCorners false)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>1.6.2</li></ul></dd>
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#cornerStrokeColor">fabric.Object#cornerStrokeColor</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12074">line 12074</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="cornerStyle"><a href="#cornerStyle" ><span class="type-signature"></span>cornerStyle<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Specify style of control, 'rect' or 'circle'
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-since">Since:</dt>
    <dd class="tag-since"><ul class="dummy"><li>1.6.2</li></ul></dd>
    

    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#cornerStyle">fabric.Object#cornerStyle</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12081">line 12081</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="dirty"><a href="#dirty" ><span class="type-signature"></span>dirty<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `true`, object's cache will be rerendered next render call.
since 1.7.0
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#dirty">fabric.Object#dirty</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12404">line 12404</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="evented"><a href="#evented" ><span class="type-signature"></span>evented<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `false`, an object can not be a target of events. All events propagate through it. Introduced in v1.3.4
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#evented">fabric.Object#evented</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12236">line 12236</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="excludeFromExport"><a href="#excludeFromExport" ><span class="type-signature"></span>excludeFromExport<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object is not exported in SVG or OBJECT/JSON
since 1.6.3
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#excludeFromExport">fabric.Object#excludeFromExport</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12364">line 12364</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="fill"><a href="#fill" ><span class="type-signature"></span>fill<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Color of object's fill
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#fill">fabric.Object#fill</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>rgb(0,0,0)</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12115">line 12115</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="fillRule"><a href="#fillRule" ><span class="type-signature"></span>fillRule<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Fill rule used to fill an object
accepted values are nonzero, evenodd
<b>Backwards incompatibility note:</b> This property was used for setting globalCompositeOperation until v1.4.12 (use `fabric.Object#globalCompositeOperation` instead)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#fillRule">fabric.Object#fillRule</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>nonzero</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12124">line 12124</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="flipX"><a href="#flipX" ><span class="type-signature"></span>flipX<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When true, an object is rendered as flipped horizontally
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#flipX">fabric.Object#flipX</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11975">line 11975</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="flipY"><a href="#flipY" ><span class="type-signature"></span>flipY<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When true, an object is rendered as flipped vertically
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#flipY">fabric.Object#flipY</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11982">line 11982</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="globalCompositeOperation"><a href="#globalCompositeOperation" ><span class="type-signature"></span>globalCompositeOperation<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Composite rule used for canvas globalCompositeOperation
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#globalCompositeOperation">fabric.Object#globalCompositeOperation</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>source-over</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12131">line 12131</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="hasBorders"><a href="#hasBorders" ><span class="type-signature"></span>hasBorders<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `false`, object's controlling borders are not rendered
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#hasBorders">fabric.Object#hasBorders</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12257">line 12257</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="hasControls"><a href="#hasControls" ><span class="type-signature"></span>hasControls<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `false`, object's controls are not displayed and can not be used to manipulate object
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#hasControls">fabric.Object#hasControls</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12250">line 12250</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="hasRotatingPoint"><a href="#hasRotatingPoint" ><span class="type-signature"></span>hasRotatingPoint<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `false`, object's controlling rotating point will not be visible or selectable
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#hasRotatingPoint">fabric.Object#hasRotatingPoint</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12264">line 12264</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="height"><a href="#height" ><span class="type-signature"></span>height<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Object height
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#height">fabric.Object#height</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11954">line 11954</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="hoverCursor"><a href="#hoverCursor" ><span class="type-signature"></span>hoverCursor<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Default cursor value used when hovering over this object on canvas
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#hoverCursor">fabric.Object#hoverCursor</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12031">line 12031</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="includeDefaultValues"><a href="#includeDefaultValues" ><span class="type-signature"></span>includeDefaultValues<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `false`, default object's values are not included in its serialization
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#includeDefaultValues">fabric.Object#includeDefaultValues</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12285">line 12285</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="left"><a href="#left" ><span class="type-signature"></span>left<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Left position of an object. Note that by default it's relative to object left. You can change this by setting originX={left/center/right}
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#left">fabric.Object#left</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11940">line 11940</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockMovementX"><a href="#lockMovementX" ><span class="type-signature"></span>lockMovementX<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object horizontal movement is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockMovementX">fabric.Object#lockMovementX</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12300">line 12300</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockMovementY"><a href="#lockMovementY" ><span class="type-signature"></span>lockMovementY<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object vertical movement is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockMovementY">fabric.Object#lockMovementY</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12307">line 12307</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockRotation"><a href="#lockRotation" ><span class="type-signature"></span>lockRotation<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object rotation is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockRotation">fabric.Object#lockRotation</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12314">line 12314</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockScalingFlip"><a href="#lockScalingFlip" ><span class="type-signature"></span>lockScalingFlip<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object cannot be flipped by scaling into negative values
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockScalingFlip">fabric.Object#lockScalingFlip</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12356">line 12356</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockScalingX"><a href="#lockScalingX" ><span class="type-signature"></span>lockScalingX<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object horizontal scaling is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockScalingX">fabric.Object#lockScalingX</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12321">line 12321</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockScalingY"><a href="#lockScalingY" ><span class="type-signature"></span>lockScalingY<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object vertical scaling is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockScalingY">fabric.Object#lockScalingY</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12328">line 12328</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockSkewingX"><a href="#lockSkewingX" ><span class="type-signature"></span>lockSkewingX<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object horizontal skewing is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockSkewingX">fabric.Object#lockSkewingX</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12342">line 12342</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockSkewingY"><a href="#lockSkewingY" ><span class="type-signature"></span>lockSkewingY<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object vertical skewing is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockSkewingY">fabric.Object#lockSkewingY</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12349">line 12349</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="lockUniScaling"><a href="#lockUniScaling" ><span class="type-signature"></span>lockUniScaling<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object non-uniform scaling is locked
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#lockUniScaling">fabric.Object#lockUniScaling</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12335">line 12335</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="matrixCache"><a href="#matrixCache" ><span class="type-signature"></span>matrixCache<span class="type-signature"></span></a></h4>


<div class="description">
    storage for object full transform matrix
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#matrixCache">fabric.Object#matrixCache</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13955">line 13955</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="minScaleLimit"><a href="#minScaleLimit" ><span class="type-signature"></span>minScaleLimit<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Minimum allowed scale value of an object
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#minScaleLimit">fabric.Object#minScaleLimit</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12221">line 12221</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="moveCursor"><a href="#moveCursor" ><span class="type-signature"></span>moveCursor<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Default cursor value used when moving this object on canvas
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#moveCursor">fabric.Object#moveCursor</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12038">line 12038</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="noScaleCache"><a href="#noScaleCache" ><span class="type-signature"></span>noScaleCache<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, cache does not get updated during scaling. The picture will get blocky if scaled
too much and will be redrawn with correct details at the end of scaling.
this setting is performance and application dependant.
default to true
since 1.7.0
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#noScaleCache">fabric.Object#noScaleCache</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12396">line 12396</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="objectCaching"><a href="#objectCaching" ><span class="type-signature"></span>objectCaching<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object is cached on an additional canvas.
default to true
since 1.7.0
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#objectCaching">fabric.Object#objectCaching</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12373">line 12373</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="oCoords"><a href="#oCoords" ><span class="type-signature"></span>oCoords<span class="type-signature"></span></a></h4>


<div class="description">
    Describe object's corner position in canvas element coordinates.
properties are tl,mt,tr,ml,mr,bl,mb,br,mtr for the main controls.
each property is an object with x, y and corner.
The `corner` property contains in a similar manner the 4 points of the
interactive area of the corner.
The coordinates depends from this properties: width, height, scaleX, scaleY
skewX, skewY, angle, strokeWidth, viewportTransform, top, left, padding.
The coordinates get updated with @method setCoords.
You can calculate them without updating with @method calcCoords;
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#oCoords">fabric.Object#oCoords</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13931">line 13931</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="opacity"><a href="#opacity" ><span class="type-signature"></span>opacity<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Opacity of an object
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#opacity">fabric.Object#opacity</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>1</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11989">line 11989</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="originX"><a href="#originX" ><span class="type-signature"></span>originX<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Horizontal origin of transformation of an object (one of "left", "right", "center")
See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#originX">fabric.Object#originX</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>left</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11918">line 11918</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="originY"><a href="#originY" ><span class="type-signature"></span>originY<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Vertical origin of transformation of an object (one of "top", "bottom", "center")
See http://jsfiddle.net/1ow02gea/244/ on how originX/originY affect objects in groups
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#originY">fabric.Object#originY</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>top</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11926">line 11926</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="ownMatrixCache"><a href="#ownMatrixCache" ><span class="type-signature"></span>ownMatrixCache<span class="type-signature"></span></a></h4>


<div class="description">
    storage for object transform matrix
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#ownMatrixCache">fabric.Object#ownMatrixCache</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13950">line 13950</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="padding"><a href="#padding" ><span class="type-signature"></span>padding<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Padding between object and its controlling borders (in pixels)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#padding">fabric.Object#padding</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12045">line 12045</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="paintFirst"><a href="#paintFirst" ><span class="type-signature"></span>paintFirst<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Determins if the fill or the stroke is drawn first (one of "fill" or "stroke")
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#paintFirst">fabric.Object#paintFirst</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>fill</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12421">line 12421</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="perPixelTargetFind"><a href="#perPixelTargetFind" ><span class="type-signature"></span>perPixelTargetFind<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `true`, objects are "found" on canvas on per-pixel basis rather than according to bounding box
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#perPixelTargetFind">fabric.Object#perPixelTargetFind</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12278">line 12278</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="rotatingPointOffset"><a href="#rotatingPointOffset" ><span class="type-signature"></span>rotatingPointOffset<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Offset for object's controlling rotating point (when enabled via `hasRotatingPoint`)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#rotatingPointOffset">fabric.Object#rotatingPointOffset</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>40</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12271">line 12271</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="scaleX"><a href="#scaleX" ><span class="type-signature"></span>scaleX<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Object scale factor (horizontal)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#scaleX">fabric.Object#scaleX</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>1</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11961">line 11961</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="scaleY"><a href="#scaleY" ><span class="type-signature"></span>scaleY<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Object scale factor (vertical)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#scaleY">fabric.Object#scaleY</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>1</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11968">line 11968</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="selectable"><a href="#selectable" ><span class="type-signature"></span>selectable<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `false`, an object can not be selected for modification (using either point-click-based or group-based selection).
But events still fire on it.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#selectable">fabric.Object#selectable</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12229">line 12229</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="selectionBackgroundColor"><a href="#selectionBackgroundColor" ><span class="type-signature"></span>selectionBackgroundColor<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Selection Background color of an object. colored layer behind the object when it is active.
does not mix good with globalCompositeOperation methods.
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#selectionBackgroundColor">fabric.Object#selectionBackgroundColor</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12146">line 12146</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="shadow"><a href="#shadow" ><span class="type-signature"></span>shadow<span class="type-signature"> :<a href="fabric.Shadow.html">fabric.Shadow</a></span></a></h4>


<div class="description">
    Shadow object representing shadow of this shape
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type"><a href="fabric.Shadow.html">fabric.Shadow</a></span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#shadow">fabric.Object#shadow</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12194">line 12194</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="skewX"><a href="#skewX" ><span class="type-signature"></span>skewX<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Angle of skew on x axes of an object (in degrees)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#skewX">fabric.Object#skewX</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12003">line 12003</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="skewY"><a href="#skewY" ><span class="type-signature"></span>skewY<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Angle of skew on y axes of an object (in degrees)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#skewY">fabric.Object#skewY</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12010">line 12010</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="statefullCache"><a href="#statefullCache" ><span class="type-signature"></span>statefullCache<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When `true`, object properties are checked for cache invalidation. In some particular
situation you may want this to be disabled ( spray brush, very big, groups)
or if your application does not allow you to modify properties for groups child you want
to disable it for groups.
default to false
since 1.7.0
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#statefullCache">fabric.Object#statefullCache</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>false</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12385">line 12385</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="stateProperties"><a href="#stateProperties" ><span class="type-signature"></span>stateProperties<span class="type-signature"> :Array</span></a></h4>


<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>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#stateProperties">fabric.Object#stateProperties</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12429">line 12429</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="stroke"><a href="#stroke" ><span class="type-signature"></span>stroke<span class="type-signature"> :String</span></a></h4>


<div class="description">
    When defined, an object is rendered via stroke and this property specifies its color
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#stroke">fabric.Object#stroke</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12153">line 12153</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="strokeDashArray"><a href="#strokeDashArray" ><span class="type-signature"></span>strokeDashArray<span class="type-signature"> :Array</span></a></h4>


<div class="description">
    Array specifying dash pattern of an object's stroke (stroke must be defined)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#strokeDashArray">fabric.Object#strokeDashArray</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12166">line 12166</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="strokeLineCap"><a href="#strokeLineCap" ><span class="type-signature"></span>strokeLineCap<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Line endings style of an object's stroke (one of "butt", "round", "square")
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#strokeLineCap">fabric.Object#strokeLineCap</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>butt</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12173">line 12173</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="strokeLineJoin"><a href="#strokeLineJoin" ><span class="type-signature"></span>strokeLineJoin<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Corner style of an object's stroke (one of "bevil", "round", "miter")
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#strokeLineJoin">fabric.Object#strokeLineJoin</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>miter</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12180">line 12180</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="strokeMiterLimit"><a href="#strokeMiterLimit" ><span class="type-signature"></span>strokeMiterLimit<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Maximum miter length (used for strokeLineJoin = "miter") of an object's stroke
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#strokeMiterLimit">fabric.Object#strokeMiterLimit</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>10</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12187">line 12187</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="strokeWidth"><a href="#strokeWidth" ><span class="type-signature"></span>strokeWidth<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Width of a stroke used to render this object
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#strokeWidth">fabric.Object#strokeWidth</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>1</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12160">line 12160</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="top"><a href="#top" ><span class="type-signature"></span>top<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Top position of an object. Note that by default it's relative to object top. You can change this by setting originY={top/center/bottom}
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#top">fabric.Object#top</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11933">line 11933</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="transformMatrix"><a href="#transformMatrix" ><span class="type-signature"></span>transformMatrix<span class="type-signature"> :Array</span></a></h4>


<div class="description">
    Transform matrix (similar to SVG's transform matrix)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Array</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#transformMatrix">fabric.Object#transformMatrix</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12214">line 12214</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="transparentCorners"><a href="#transparentCorners" ><span class="type-signature"></span>transparentCorners<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When true, object's controlling corners are rendered as transparent inside (i.e. stroke instead of fill)
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#transparentCorners">fabric.Object#transparentCorners</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12024">line 12024</a>
    </li></ul></dd>
    

</dl>


</div>


<h4 class="name" id="type"><a href="#type" ><span class="type-signature"></span>type<span class="type-signature"> :String</span></a></h4>


<div class="description">
    Type of an object
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">String</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="fabric.Object.html#type">fabric.Object#type</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>line</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15556">line 15556</a>
    </li></ul></dd>
    

</dl>


<div class="inherited">

<h4 class="name" id="visible"><a href="#visible" ><span class="type-signature"></span>visible<span class="type-signature"> :Boolean</span></a></h4>


<div class="description">
    When set to `false`, an object is not rendered on canvas
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Boolean</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#visible">fabric.Object#visible</a>
    </li></ul></dd>
    

    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>true</li>
        </ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12243">line 12243</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">

<h4 class="name" id="width"><a href="#width" ><span class="type-signature"></span>width<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    Object width
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#width">fabric.Object#width</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line11947">line 11947</a>
    </li></ul></dd>
    

</dl>


</div>


<h4 class="name" id="x1"><a href="#x1" ><span class="type-signature"></span>x1<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    x value or first line edge
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15563">line 15563</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="x2"><a href="#x2" ><span class="type-signature"></span>x2<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    x value or second line edge
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15577">line 15577</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="y1"><a href="#y1" ><span class="type-signature"></span>y1<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    y value or first line edge
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15570">line 15570</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="y2"><a href="#y2" ><span class="type-signature"></span>y2<span class="type-signature"> :Number</span></a></h4>


<div class="description">
    y value or second line edge
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">Number</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15584">line 15584</a>
    </li></ul></dd>
    

</dl>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id=".fromElement"><a href="#.fromElement" ><span class="type-signature">(static) </span>fromElement<span class="signature">(element, options<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Returns fabric.Line instance from an SVG element
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>element</code></td>
            

            <td class="type">
            
                
<span class="param-type">SVGElement</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Element to parse</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Options object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">callback function invoked after parsing</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15818">line 15818</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id=".fromObject"><a href="#.fromObject" ><span class="type-signature">(static) </span>fromObject<span class="signature">(object, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Returns fabric.Line instance from an object representation
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>object</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Object to create an instance from</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">invoked with new instance as first argument</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15838">line 15838</a>
    </li></ul></dd>
    

</dl>


<div class="inherited">


    <h4 class="name" id="_calcRotateMatrix"><a href="#_calcRotateMatrix" ><span class="type-signature"></span>_calcRotateMatrix<span class="signature">()</span><span class="type-signature"> &rarr; {Array}</span></a></h4>
    

<div class="description">
    calculate rotation matrix of an object
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#_calcRotateMatrix">fabric.Object#_calcRotateMatrix</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14340">line 14340</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    rotation matrix for the object
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="_limitCacheSize"><a href="#_limitCacheSize" ><span class="type-signature"></span>_limitCacheSize<span class="signature">(dims)</span><span class="type-signature"> &rarr; {Object|Object|Object|Object}</span></a></h4>
    

<div class="description">
    Limit the cache dimensions so that X * Y do not cross fabric.perfLimitSizeTotal
and each side do not cross fabric.cacheSideLimit
those numbers are configurable so that you can get as much detail as you want
making bargain with performances.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>dims</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">width of canvas</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">height of canvas</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>zoomX</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">zoomX zoom value to unscale the canvas before drawing cache</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>zoomY</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">zoomY zoom value to unscale the canvas before drawing cache</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#_limitCacheSize">fabric.Object#_limitCacheSize</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12481">line 12481</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>
<ul>
        <li>
<div class="param-desc">
    .width width of canvas
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>
</li>
    
        <li>
<div class="param-desc">
    .height height of canvas
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>
</li>
    
        <li>
<div class="param-desc">
    .zoomX zoomX zoom value to unscale the canvas before drawing cache
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>
</li>
    
        <li>
<div class="param-desc">
    .zoomY zoomY zoom value to unscale the canvas before drawing cache
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>
</li>
    </ul>


</div>


<div class="inherited">


    <h4 class="name" id="_removeCacheCanvas"><a href="#_removeCacheCanvas" ><span class="type-signature"></span>_removeCacheCanvas<span class="signature">()</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Remove cacheCanvas and its dimensions from the objects
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#_removeCacheCanvas">fabric.Object#_removeCacheCanvas</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12872">line 12872</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="_renderControls"><a href="#_renderControls" ><span class="type-signature"></span>_renderControls<span class="signature">(ctx, styleOverride<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Renders controls and borders for the object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Context to render on</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>styleOverride</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">properties to override the object style</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#_renderControls">fabric.Object#_renderControls</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13046">line 13046</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="_setupCompositeOperation"><a href="#_setupCompositeOperation" ><span class="type-signature"></span>_setupCompositeOperation<span class="signature">(ctx)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Sets canvas globalCompositeOperation for specific object
custom composition operation for the particular object can be specifed using globalCompositeOperation property
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Rendering canvas context</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#_setupCompositeOperation">fabric.Object#_setupCompositeOperation</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13592">line 13592</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="adjustPosition"><a href="#adjustPosition" ><span class="type-signature"></span>adjustPosition<span class="signature">(to)</span><span class="type-signature"></span></a></h4>
    

    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>to</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">One of 'left', 'center', 'right'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#adjustPosition">fabric.Object#adjustPosition</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13820">line 13820</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="animate"><a href="#animate" ><span class="type-signature"></span>animate<span class="signature">(property, value)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Animates object's properties
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>property</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>
|

<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Property to animate (if string) or properties to animate (if object)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>
|

<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Value to animate property to (if string was given first) or options object</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#animate">fabric.Object#animate</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15438">line 15438</a>
    </li></ul></dd>
    

    <dt class="tag-tutorial">Tutorials:</dt>
    <dd class="tag-tutorial">
        <ul>
            <li><em class="disabled">Tutorial: <a href="http://fabricjs.com/fabric-intro-part-2#animation">http://fabricjs.com/fabric-intro-part-2#animation</a></em></li>
        </ul>
    </dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="bringForward"><a href="#bringForward" ><span class="type-signature"></span>bringForward<span class="signature">(intersecting<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Moves an object up in stack of drawn objects
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>intersecting</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">If `true`, send object in front of next upper intersecting object</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#bringForward">fabric.Object#bringForward</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14544">line 14544</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="bringToFront"><a href="#bringToFront" ><span class="type-signature"></span>bringToFront<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Moves an object to the top of the stack of drawn objects
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#bringToFront">fabric.Object#bringToFront</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14512">line 14512</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="calcCoords"><a href="#calcCoords" ><span class="type-signature"></span>calcCoords<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></a></h4>
    

<div class="description">
    Calculate and returns the .coords of an object.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#calcCoords">fabric.Object#calcCoords</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14259">line 14259</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Object with tl, tr, br, bl ....
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="calcTransformMatrix"><a href="#calcTransformMatrix" ><span class="type-signature"></span>calcTransformMatrix<span class="signature">(skipGroup<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array}</span></a></h4>
    

<div class="description">
    calculate trasform Matrix that represent current transformation from
object properties.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>skipGroup</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">return transformMatrix for object and not go upward with parents</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#calcTransformMatrix">fabric.Object#calcTransformMatrix</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14368">line 14368</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    matrix Transform Matrix for the object
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="center"><a href="#center" ><span class="type-signature"></span>center<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Centers object vertically and horizontally on canvas to which is was added last
You might need to call `setCoords` on an object after centering, to update controls area.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#center">fabric.Object#center</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13551">line 13551</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="centerH"><a href="#centerH" ><span class="type-signature"></span>centerH<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Centers object horizontally on canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#centerH">fabric.Object#centerH</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13507">line 13507</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="centerV"><a href="#centerV" ><span class="type-signature"></span>centerV<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Centers object vertically on canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#centerV">fabric.Object#centerV</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13529">line 13529</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="clone"><a href="#clone" ><span class="type-signature"></span>clone<span class="signature">(callback, propertiesToInclude<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Clones an instance, using a callback method will work for every object.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Callback is invoked with a clone as a first argument</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>propertiesToInclude</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Any properties that you might want to additionally include in the output</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#clone">fabric.Object#clone</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13241">line 13241</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="cloneAsImage"><a href="#cloneAsImage" ><span class="type-signature"></span>cloneAsImage<span class="signature">(callback, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Creates an instance of fabric.Image out of an object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callback</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">callback, invoked with an instance as a first argument</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">for clone as image, passed to toDataURL
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>enableRetinaScaling</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">enable retina scaling for the cloned image</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#cloneAsImage">fabric.Object#cloneAsImage</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13258">line 13258</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="complexity"><a href="#complexity" ><span class="type-signature"></span>complexity<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></a></h4>
    

<div class="description">
    Returns complexity of an instance
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#complexity">fabric.Object#complexity</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13333">line 13333</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    complexity of this instance (is 1 unless subclassed)
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="containsPoint"><a href="#containsPoint" ><span class="type-signature"></span>containsPoint<span class="signature">(point, lines<span class="signature-attributes">opt</span>, absolute<span class="signature-attributes">opt</span>, calculate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Checks if point is inside the object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Point to check against</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>lines</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">object returned from @method _getImageLines</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates without viewportTransform</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>calculate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates of current position instead of .oCoords</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#containsPoint">fabric.Object#containsPoint</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14051">line 14051</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if point is inside the object
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="drawBorders"><a href="#drawBorders" ><span class="type-signature"></span>drawBorders<span class="signature">(ctx, styleOverride)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Draws borders of an object's bounding box.
Requires public properties: width, height
Requires public options: padding, borderColor
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context to draw on</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>styleOverride</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">object to override the object style</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#drawBorders">fabric.Object#drawBorders</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15027">line 15027</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="drawBordersInGroup"><a href="#drawBordersInGroup" ><span class="type-signature"></span>drawBordersInGroup<span class="signature">(ctx, options, styleOverride)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Draws borders of an object's bounding box when it is inside a group.
Requires public properties: width, height
Requires public options: padding, borderColor
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context to draw on</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">object</span>


            </td>

            
            <td class="description last">object representing current object parameters</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>styleOverride</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">object to override the object style</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#drawBordersInGroup">fabric.Object#drawBordersInGroup</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15076">line 15076</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="drawCacheOnCanvas"><a href="#drawCacheOnCanvas" ><span class="type-signature"></span>drawCacheOnCanvas<span class="signature">(ctx)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Paint the cached copy of the object on the target context.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context to render on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#drawCacheOnCanvas">fabric.Object#drawCacheOnCanvas</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12931">line 12931</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="drawControls"><a href="#drawControls" ><span class="type-signature"></span>drawControls<span class="signature">(ctx, styleOverride)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Draws corners of an object's bounding box.
Requires public properties: width, height
Requires public options: cornerSize, padding
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context to draw on</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>styleOverride</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">object to override the object style</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#drawControls">fabric.Object#drawControls</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15109">line 15109</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="drawObject"><a href="#drawObject" ><span class="type-signature"></span>drawObject<span class="signature">(ctx)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Execute the drawing operation for an object on a specified context
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context to render on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#drawObject">fabric.Object#drawObject</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12920">line 12920</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="drawSelectionBackground"><a href="#drawSelectionBackground" ><span class="type-signature"></span>drawSelectionBackground<span class="signature">(ctx)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Draws a colored layer behind the object, inside its selection borders.
Requires public options: padding, selectionBackgroundColor
this function is called when the context is transformed
has checks to be skipped when the object is on a staticCanvas
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context to draw on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#drawSelectionBackground">fabric.Object#drawSelectionBackground</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14999">line 14999</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="fxStraighten"><a href="#fxStraighten" ><span class="type-signature"></span>fxStraighten<span class="signature">(callbacks)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Same as fabric.Object.prototype.straighten but with animation
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>callbacks</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Object with callback functions
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>onComplete</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Invoked on completion</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>onChange</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Invoked on every step of animation</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#fxStraighten">fabric.Object#fxStraighten</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line19365">line 19365</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getBoundingRect"><a href="#getBoundingRect" ><span class="type-signature"></span>getBoundingRect<span class="signature">(absolute<span class="signature-attributes">opt</span>, calculate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></a></h4>
    

<div class="description">
    Returns coordinates of object's bounding rectangle (left, top, width, height)
the box is intented as aligned to axis of canvas.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates without viewportTransform</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>calculate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates of current position instead of .oCoords</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getBoundingRect">fabric.Object#getBoundingRect</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14174">line 14174</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Object with left, top, width, height properties
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getCenterPoint"><a href="#getCenterPoint" ><span class="type-signature"></span>getCenterPoint<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Point.html">fabric.Point</a>}</span></a></h4>
    

<div class="description">
    Returns the real center coordinates of the object
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getCenterPoint">fabric.Object#getCenterPoint</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13744">line 13744</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getCoords"><a href="#getCoords" ><span class="type-signature"></span>getCoords<span class="signature">()</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    return correct set of coordinates for intersection
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getCoords">fabric.Object#getCoords</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13960">line 13960</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="getLocalPointer"><a href="#getLocalPointer" ><span class="type-signature"></span>getLocalPointer<span class="signature">(e, pointer<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></a></h4>
    

<div class="description">
    Returns coordinates of a pointer relative to an object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>e</code></td>
            

            <td class="type">
            
                
<span class="param-type">Event</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Event to operate upon</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pointer</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Pointer to operate upon (instead of event)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getLocalPointer">fabric.Object#getLocalPointer</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13573">line 13573</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Coordinates of a pointer (x, y)
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getObjectOpacity"><a href="#getObjectOpacity" ><span class="type-signature"></span>getObjectOpacity<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></a></h4>
    

<div class="description">
    Return the object opacity counting also the group property
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getObjectOpacity">fabric.Object#getObjectOpacity</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12739">line 12739</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getObjectScaling"><a href="#getObjectScaling" ><span class="type-signature"></span>getObjectScaling<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></a></h4>
    

<div class="description">
    Return the object scale factor counting also the group scaling
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getObjectScaling">fabric.Object#getObjectScaling</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12725">line 12725</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    object with scaleX and scaleY properties
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getPointByOrigin"><a href="#getPointByOrigin" ><span class="type-signature"></span>getPointByOrigin<span class="signature">(originX, originY)</span><span class="type-signature"> &rarr; {<a href="fabric.Point.html">fabric.Point</a>}</span></a></h4>
    

<div class="description">
    Returns the coordinates of the object as if it has a different origin
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>originX</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Horizontal origin: 'left', 'center' or 'right'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originY</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Vertical origin: 'top', 'center' or 'bottom'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getPointByOrigin">fabric.Object#getPointByOrigin</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13764">line 13764</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getScaledHeight"><a href="#getScaledHeight" ><span class="type-signature"></span>getScaledHeight<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></a></h4>
    

<div class="description">
    Returns height of an object bounding box counting transformations
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getScaledHeight">fabric.Object#getScaledHeight</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14191">line 14191</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    height value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getScaledWidth"><a href="#getScaledWidth" ><span class="type-signature"></span>getScaledWidth<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></a></h4>
    

<div class="description">
    Returns width of an object bounding box counting transformations
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getScaledWidth">fabric.Object#getScaledWidth</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14183">line 14183</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    width value
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getSvgFilter"><a href="#getSvgFilter" ><span class="type-signature"></span>getSvgFilter<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns filter for svg shadow
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getSvgFilter">fabric.Object#getSvgFilter</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14676">line 14676</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getSvgId"><a href="#getSvgId" ><span class="type-signature"></span>getSvgId<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns id attribute for svg output
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getSvgId">fabric.Object#getSvgId</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14684">line 14684</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getSvgSpanStyles"><a href="#getSvgSpanStyles" ><span class="type-signature"></span>getSvgSpanStyles<span class="signature">(style, useWhiteSpace)</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns styles-string for svg-export
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>style</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">style properties for the span a boolean to skip shadow filter output</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>useWhiteSpace</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">a boolean to include an additional attribute in the style.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getSvgSpanStyles">fabric.Object#getSvgSpanStyles</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14638">line 14638</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getSvgStyles"><a href="#getSvgStyles" ><span class="type-signature"></span>getSvgStyles<span class="signature">(skipShadow)</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns styles-string for svg-export
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>skipShadow</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">a boolean to skip shadow filter output</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getSvgStyles">fabric.Object#getSvgStyles</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14603">line 14603</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getSvgTransform"><a href="#getSvgTransform" ><span class="type-signature"></span>getSvgTransform<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns transform-string for svg-export
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getSvgTransform">fabric.Object#getSvgTransform</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14692">line 14692</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getSvgTransformMatrix"><a href="#getSvgTransformMatrix" ><span class="type-signature"></span>getSvgTransformMatrix<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns transform-string for svg-export from the transform matrix of single elements
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getSvgTransformMatrix">fabric.Object#getSvgTransformMatrix</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14735">line 14735</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="getViewportTransform"><a href="#getViewportTransform" ><span class="type-signature"></span>getViewportTransform<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Retrieves viewportTransform from Object's canvas if possible
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#getViewportTransform">fabric.Object#getViewportTransform</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12801">line 12801</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="hasStateChanged"><a href="#hasStateChanged" ><span class="type-signature"></span>hasStateChanged<span class="signature">(propertySet<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Returns true if object state (one of its state properties) was changed
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>propertySet</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">optional name for the set of property we want to save</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#hasStateChanged">fabric.Object#hasStateChanged</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14837">line 14837</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if instance' state has changed since `<a href="fabric.Object.html#saveState">fabric.Object#saveState</a>` was called
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


    <h4 class="name" id="initialize"><a href="#initialize" ><span class="type-signature"></span>initialize<span class="signature">(points<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Line.html">fabric.Line</a>}</span></a></h4>
    

<div class="description">
    Constructor
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>points</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Array of points</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Options object</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="fabric.Object.html#initialize">fabric.Object#initialize</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15594">line 15594</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Line.html">fabric.Line</a></span>


    </dd>
</dl>

    
<div class="inherited">


    <h4 class="name" id="intersectsWithObject"><a href="#intersectsWithObject" ><span class="type-signature"></span>intersectsWithObject<span class="signature">(other, absolute<span class="signature-attributes">opt</span>, calculate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Checks if object intersects with another object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>other</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Object to test</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates without viewportTransform</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>calculate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates of current position instead of .oCoords</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#intersectsWithObject">fabric.Object#intersectsWithObject</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13993">line 13993</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if object intersects with another object
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="intersectsWithRect"><a href="#intersectsWithRect" ><span class="type-signature"></span>intersectsWithRect<span class="signature">(pointTL, pointBR, absolute<span class="signature-attributes">opt</span>, calculate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Checks if object intersects with an area formed by 2 points
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pointTL</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">top-left point of area</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pointBR</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">bottom-right point of area</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates without viewportTransform</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>calculate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates of current position instead of .oCoords</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#intersectsWithRect">fabric.Object#intersectsWithRect</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13976">line 13976</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if object intersects with an area formed by 2 points
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="isCacheDirty"><a href="#isCacheDirty" ><span class="type-signature"></span>isCacheDirty<span class="signature">(skipCanvas)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Check if cache is dirty
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>skipCanvas</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">skip canvas checks because this object is painted
on parent canvas.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#isCacheDirty">fabric.Object#isCacheDirty</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12941">line 12941</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="isContainedWithinObject"><a href="#isContainedWithinObject" ><span class="type-signature"></span>isContainedWithinObject<span class="signature">(other, absolute<span class="signature-attributes">opt</span>, calculate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Checks if object is fully contained within area of another object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>other</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Object to test</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates without viewportTransform</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>calculate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates of current position instead of .oCoords</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#isContainedWithinObject">fabric.Object#isContainedWithinObject</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14011">line 14011</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if object is fully contained within area of another object
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="isContainedWithinRect"><a href="#isContainedWithinRect" ><span class="type-signature"></span>isContainedWithinRect<span class="signature">(pointTL, pointBR, absolute<span class="signature-attributes">opt</span>, calculate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Checks if object is fully contained within area formed by 2 points
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pointTL</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">top-left point of area</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>pointBR</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">bottom-right point of area</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates without viewportTransform</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>calculate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates of current position instead of .oCoords</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#isContainedWithinRect">fabric.Object#isContainedWithinRect</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14032">line 14032</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if object is fully contained within area formed by 2 points
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="isControlVisible"><a href="#isControlVisible" ><span class="type-signature"></span>isControlVisible<span class="signature">(controlName)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Returns true if the specified control is visible, false otherwise.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>controlName</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">The name of the control. Possible values are 'tl', 'tr', 'br', 'bl', 'ml', 'mt', 'mr', 'mb', 'mtr'.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#isControlVisible">fabric.Object#isControlVisible</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15217">line 15217</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if the specified control is visible, false otherwise
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="isOnScreen"><a href="#isOnScreen" ><span class="type-signature"></span>isOnScreen<span class="signature">(calculate<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Checks if object is contained within the canvas with current viewportTransform
the check is done stopping at first point that appear on screen
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>calculate</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">use coordinates of current position instead of .oCoords</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#isOnScreen">fabric.Object#isOnScreen</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14067">line 14067</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    true if object is fully contained within canvas
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="isType"><a href="#isType" ><span class="type-signature"></span>isType<span class="signature">(type)</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Returns true if specified type is identical to the type of an instance
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Type to check against</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#isType">fabric.Object#isType</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13325">line 13325</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="moveTo"><a href="#moveTo" ><span class="type-signature"></span>moveTo<span class="signature">(index)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Moves an object to specified level in stack of drawn objects
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>index</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last">New position of object</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#moveTo">fabric.Object#moveTo</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14560">line 14560</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="needsItsOwnCache"><a href="#needsItsOwnCache" ><span class="type-signature"></span>needsItsOwnCache<span class="signature">()</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    When set to `true`, force the object to have its own cache, even if it is inside a group
it may be needed when your object behave in a particular way on the cache and always needs
its own isolated canvas to render correctly.
Created to be overridden
since 1.7.12
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#needsItsOwnCache">fabric.Object#needsItsOwnCache</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12886">line 12886</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    false
</div>


</div>


    <h4 class="name" id="onDeselect"><a href="#onDeselect" ><span class="type-signature"></span>onDeselect<span class="signature">()</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Callback; invoked right before object is about to go from active to inactive
</div>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="fabric.Object.html#onDeselect">fabric.Object#onDeselect</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13895">line 13895</a>
    </li></ul></dd>
    

</dl>


<div class="inherited">


    <h4 class="name" id="onSelect"><a href="#onSelect" ><span class="type-signature"></span>onSelect<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    This callback function is called every time _discardActiveObject or _setActiveObject
try to to select this object. If the function returns true, the process is cancelled
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">options sent from the upper functions
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>e</code></td>
            

            <td class="type">
            
                
<span class="param-type">Event</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">event if the process is generated by an event</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#onSelect">fabric.Object#onSelect</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15296">line 15296</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="render"><a href="#render" ><span class="type-signature"></span>render<span class="signature">(ctx)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Renders an object on a specified context
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context to render on</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#render">fabric.Object#render</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12828">line 12828</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="rotate"><a href="#rotate" ><span class="type-signature"></span>rotate<span class="signature">(angle)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets "angle" of an instance with centered rotation
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>angle</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last">Angle value (in degrees)</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#rotate">fabric.Object#rotate</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13485">line 13485</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="saveState"><a href="#saveState" ><span class="type-signature"></span>saveState<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Saves state of an object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Object with additional `stateProperties` array to include when saving state</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#saveState">fabric.Object#saveState</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14851">line 14851</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="scale"><a href="#scale" ><span class="type-signature"></span>scale<span class="signature">(value)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Scales an object (equally by x and y)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last">Scale factor</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#scale">fabric.Object#scale</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14222">line 14222</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="scaleToHeight"><a href="#scaleToHeight" ><span class="type-signature"></span>scaleToHeight<span class="signature">(value, absolute)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Scales an object to a given height, with respect to bounding box (scaling by x/y equally)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last">New height value</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">ignore viewport</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#scaleToHeight">fabric.Object#scaleToHeight</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14248">line 14248</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="scaleToWidth"><a href="#scaleToWidth" ><span class="type-signature"></span>scaleToWidth<span class="signature">(value, absolute)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Scales an object to a given width, with respect to bounding box (scaling by x/y equally)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>value</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
            <td class="description last">New width value</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>absolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">ignore viewport</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#scaleToWidth">fabric.Object#scaleToWidth</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14235">line 14235</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="sendBackwards"><a href="#sendBackwards" ><span class="type-signature"></span>sendBackwards<span class="signature">(intersecting<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Moves an object down in stack of drawn objects
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>intersecting</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">If `true`, send object behind next lower intersecting object</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#sendBackwards">fabric.Object#sendBackwards</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14528">line 14528</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="sendToBack"><a href="#sendToBack" ><span class="type-signature"></span>sendToBack<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Moves an object to the bottom of the stack of drawn objects
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#sendToBack">fabric.Object#sendToBack</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14497">line 14497</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="setColor"><a href="#setColor" ><span class="type-signature"></span>setColor<span class="signature">(color)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets "color" of an instance (alias of `set('fill', &hellip;)`)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Color value</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setColor">fabric.Object#setColor</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13474">line 13474</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="setControlsVisibility"><a href="#setControlsVisibility" ><span class="type-signature"></span>setControlsVisibility<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets the visibility state of object controls.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Options object
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>bl</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the bottom-left control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>br</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the bottom-right control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>mb</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the middle-bottom control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>ml</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the middle-left control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>mr</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the middle-right control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>mt</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the middle-top control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>tl</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the top-left control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>tr</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the top-right control, false to disable it</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>mtr</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">true to enable the middle-top-rotate control, false to disable it</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setControlsVisibility">fabric.Object#setControlsVisibility</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15248">line 15248</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="setControlVisible"><a href="#setControlVisible" ><span class="type-signature"></span>setControlVisible<span class="signature">(controlName, visible)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets the visibility of the specified control.
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>controlName</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">The name of the control. Possible values are 'tl', 'tr', 'br', 'bl', 'ml', 'mt', 'mr', 'mb', 'mtr'.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>visible</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
            <td class="description last">true to set the specified control visible, false otherwise</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setControlVisible">fabric.Object#setControlVisible</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15228">line 15228</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="setCoords"><a href="#setCoords" ><span class="type-signature"></span>setCoords<span class="signature">(ignoreZoom<span class="signature-attributes">opt</span>, skipAbsolute<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets corner position coordinates based on current angle, width and height
See https://github.com/kangax/fabric.js/wiki/When-to-call-setCoords
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ignoreZoom</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">set oCoords with or without the viewport transform.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>skipAbsolute</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">skip calculation of aCoords, usefull in setViewportTransform</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setCoords">fabric.Object#setCoords</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14324">line 14324</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="setGradient"><a href="#setGradient" ><span class="type-signature"></span>setGradient<span class="signature">(property, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets gradient (fill or stroke) of an object
<b>Backwards incompatibility note:</b> This method was named "setGradientFill" until v1.1.0
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>property</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last">Property name 'stroke' or 'fill'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Options object
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>type</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Type of gradient 'radial' or 'linear'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>x1</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">x-coordinate of start point</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>y1</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">y-coordinate of start point</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>x2</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">x-coordinate of end point</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>y2</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">y-coordinate of end point</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>r1</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">Radius of start point (only for radial gradients)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>r2</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">Radius of end point (only for radial gradients)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>colorStops</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Color stops object eg. {0: 'ff0000', 1: '000000'}</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>gradientTransform</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">transforMatrix for gradient</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setGradient">fabric.Object#setGradient</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13395">line 13395</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http://jsfiddle.net/fabricjs/58y8b/">jsFiddle demo</a></li>
        </ul>
    </dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
    <h5>Examples</h5>
    
        <p class="code-caption">Set linear gradient</p>
    
    <pre class="prettyprint"><code>object.setGradient('fill', {
  type: 'linear',
  x1: -object.width / 2,
  y1: 0,
  x2: object.width / 2,
  y2: 0,
  colorStops: {
    0: 'red',
    0.5: '#005555',
    1: 'rgba(0,0,255,0.5)'
  }
});
canvas.renderAll();</code></pre>

        <p class="code-caption">Set radial gradient</p>
    
    <pre class="prettyprint"><code>object.setGradient('fill', {
  type: 'radial',
  x1: 0,
  y1: 0,
  x2: 0,
  y2: 0,
  r1: object.width / 2,
  r2: 10,
  colorStops: {
    0: 'red',
    0.5: '#005555',
    1: 'rgba(0,0,255,0.5)'
  }
});
canvas.renderAll();</code></pre>


</div>


<div class="inherited">


    <h4 class="name" id="setOnGroup"><a href="#setOnGroup" ><span class="type-signature"></span>setOnGroup<span class="signature">()</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    This callback function is called by the parent group of an object every
time a non-delegated property changes on the group. It is passed the key
and value as parameters. Not adding in this function's signature to avoid
Travis build error about unused variables.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setOnGroup">fabric.Object#setOnGroup</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12797">line 12797</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="setOptions"><a href="#setOptions" ><span class="type-signature"></span>setOptions<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Sets object's properties from options
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Options object</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setOptions">fabric.Object#setOptions</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12606">line 12606</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="setPatternFill"><a href="#setPatternFill" ><span class="type-signature"></span>setPatternFill<span class="signature">(options)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets pattern fill of an object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Options object
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>source</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>
|

<span class="param-type">HTMLImageElement</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Pattern source</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>repeat</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    repeat
                
                </td>
            

            <td class="description last">Repeat property of a pattern (one of repeat, repeat-x, repeat-y or no-repeat)</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>offsetX</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">Pattern horizontal offset from object's left/top corner</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>offsetY</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">Pattern vertical offset from object's left/top corner</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setPatternFill">fabric.Object#setPatternFill</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13438">line 13438</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http://jsfiddle.net/fabricjs/QT3pa/">jsFiddle demo</a></li>
        </ul>
    </dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
    <h5>Example</h5>
    
        <p class="code-caption">Set pattern</p>
    
    <pre class="prettyprint"><code>fabric.util.loadImage('http://fabricjs.com/assets/escheresque_ste.png', function(img) {
  object.setPatternFill({
    source: img,
    repeat: 'repeat'
  });
  canvas.renderAll();
});</code></pre>


</div>


<div class="inherited">


    <h4 class="name" id="setPositionByOrigin"><a href="#setPositionByOrigin" ><span class="type-signature"></span>setPositionByOrigin<span class="signature">(pos, originX, originY)</span><span class="type-signature"> &rarr; {void}</span></a></h4>
    

<div class="description">
    Sets the position of the object taking into consideration the object's origin
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>pos</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


            </td>

            
            <td class="description last">The new position of the object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originX</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Horizontal origin: 'left', 'center' or 'right'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originY</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Vertical origin: 'top', 'center' or 'bottom'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setPositionByOrigin">fabric.Object#setPositionByOrigin</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13810">line 13810</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">void</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="setShadow"><a href="#setShadow" ><span class="type-signature"></span>setShadow<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Sets <a href="fabric.Object.html#shadow">shadow</a> of an object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>
|

<span class="param-type">String</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Options object or string (e.g. "2px 2px 10px rgba(0,0,0,0.2)")
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    rgb(0,0,0)
                
                </td>
            

            <td class="description last">Shadow color</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>blur</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">Shadow blur</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>offsetX</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">Shadow horizontal offset</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>offsetY</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    0
                
                </td>
            

            <td class="description last">Shadow vertical offset</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setShadow">fabric.Object#setShadow</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13464">line 13464</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="http://jsfiddle.net/fabricjs/7gvJG/">jsFiddle demo</a></li>
        </ul>
    </dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
    <h5>Examples</h5>
    
        <p class="code-caption">Set shadow with string notation</p>
    
    <pre class="prettyprint"><code>object.setShadow('2px 2px 10px rgba(0,0,0,0.2)');
canvas.renderAll();</code></pre>

        <p class="code-caption">Set shadow with object notation</p>
    
    <pre class="prettyprint"><code>object.setShadow({
  color: 'red',
  blur: 10,
  offsetX: 20,
  offsetY: 20
});
canvas.renderAll();</code></pre>


</div>


<div class="inherited">


    <h4 class="name" id="setupState"><a href="#setupState" ><span class="type-signature"></span>setupState<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Setups state of an object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Object with additional `stateProperties` array to include when saving state</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#setupState">fabric.Object#setupState</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line14869">line 14869</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="shouldCache"><a href="#shouldCache" ><span class="type-signature"></span>shouldCache<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Decide if the object should cache or not. Create its own cache level
objectCaching is a global flag, wins over everything
needsItsOwnCache should be used when the object drawing method requires
a cache step. None of the fabric classes requires it.
Generally you do not cache objects in groups because the group outside is cached.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#shouldCache">fabric.Object#shouldCache</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12901">line 12901</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="straighten"><a href="#straighten" ><span class="type-signature"></span>straighten<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Straightens an object (rotating it from current angle to one of 0, 90, 180, 270, etc. depending on which is closer)
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#straighten">fabric.Object#straighten</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line19352">line 19352</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="toDatalessObject"><a href="#toDatalessObject" ><span class="type-signature"></span>toDatalessObject<span class="signature">(propertiesToInclude<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></a></h4>
    

<div class="description">
    Returns (dataless) object representation of an instance
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>propertiesToInclude</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Any properties that you might want to additionally include in the output</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#toDatalessObject">fabric.Object#toDatalessObject</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12685">line 12685</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Object representation of an instance
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="toDataURL"><a href="#toDataURL" ><span class="type-signature"></span>toDataURL<span class="signature">(options)</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Converts an object into a data-url-like string
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>options</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object</span>


            </td>

            
            <td class="description last">Options object
                <h6>Properties</h6>
                

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th>Default</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>format</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    png
                
                </td>
            

            <td class="description last">The format of the output image. Either "jpeg" or "png"</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>quality</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last">Quality level (0..1). Only used for jpeg.</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>multiplier</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                    1
                
                </td>
            

            <td class="description last">Multiplier to scale by</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>left</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Cropping left offset. Introduced in v1.2.14</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>top</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Cropping top offset. Introduced in v1.2.14</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>width</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Cropping width. Introduced in v1.2.14</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>height</code></td>
            

            <td class="type">
            
                
<span class="param-type">Number</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Cropping height. Introduced in v1.2.14</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>enableRetina</code></td>
            

            <td class="type">
            
                
<span class="param-type">Boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

                <td class="default">
                
                </td>
            

            <td class="description last">Enable retina scaling for clone image. Introduce in 1.6.4</td>
        </tr>

    
    </tbody>
</table>

            </td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#toDataURL">fabric.Object#toDataURL</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13281">line 13281</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    Returns a data: URL containing a representation of the object in the format specified by options.format
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="toJSON"><a href="#toJSON" ><span class="type-signature"></span>toJSON<span class="signature">(propertiesToInclude<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></a></h4>
    

<div class="description">
    Returns a JSON representation of an instance
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>propertiesToInclude</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Any properties that you might want to additionally include in the output</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#toJSON">fabric.Object#toJSON</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13342">line 13342</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    JSON
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="toLocalPoint"><a href="#toLocalPoint" ><span class="type-signature"></span>toLocalPoint<span class="signature">(point, originX, originY)</span><span class="type-signature"> &rarr; {<a href="fabric.Point.html">fabric.Point</a>}</span></a></h4>
    

<div class="description">
    Returns the point in local coordinates
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


            </td>

            
            <td class="description last">The point relative to the global coordinate system</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originX</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Horizontal origin: 'left', 'center' or 'right'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originY</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Vertical origin: 'top', 'center' or 'bottom'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#toLocalPoint">fabric.Object#toLocalPoint</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13776">line 13776</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


    </dd>
</dl>

    
</div>


    <h4 class="name" id="toObject"><a href="#toObject" ><span class="type-signature"></span>toObject<span class="signature">(propertiesToInclude<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></a></h4>
    

<div class="description">
    Returns object representation of an instance
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>propertiesToInclude</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Any properties that you might want to additionally include in the output</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="fabric.Object.html#toObject">fabric.Object#toObject</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15734">line 15734</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    object representation of an instance
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    
<div class="inherited">


    <h4 class="name" id="toString"><a href="#toString" ><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns a string representation of an instance
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#toString">fabric.Object#toString</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12717">line 12717</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
</div>


    <h4 class="name" id="toSVG"><a href="#toSVG" ><span class="type-signature"></span>toSVG<span class="signature">(reviver<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></a></h4>
    

<div class="description">
    Returns SVG representation of an instance
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>reviver</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last">Method for further parsing of svg representation.</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line15781">line 15781</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    svg representation of an instance
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
<div class="inherited">


    <h4 class="name" id="transform"><a href="#transform" ><span class="type-signature"></span>transform<span class="signature">(ctx)</span><span class="type-signature"></span></a></h4>
    

<div class="description">
    Transforms context when rendering an object
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>ctx</code></td>
            

            <td class="type">
            
                
<span class="param-type">CanvasRenderingContext2D</span>


            </td>

            
            <td class="description last">Context</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#transform">fabric.Object#transform</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12619">line 12619</a>
    </li></ul></dd>
    

</dl>


</div>


<div class="inherited">


    <h4 class="name" id="translateToCenterPoint"><a href="#translateToCenterPoint" ><span class="type-signature"></span>translateToCenterPoint<span class="signature">(point, originX, originY)</span><span class="type-signature"> &rarr; {<a href="fabric.Point.html">fabric.Point</a>}</span></a></h4>
    

<div class="description">
    Translates the coordinates from origin to center coordinates (based on the object's dimensions)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


            </td>

            
            <td class="description last">The point which corresponds to the originX and originY params</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originX</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Horizontal origin: 'left', 'center' or 'right'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originY</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Vertical origin: 'top', 'center' or 'bottom'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#translateToCenterPoint">fabric.Object#translateToCenterPoint</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13717">line 13717</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="translateToGivenOrigin"><a href="#translateToGivenOrigin" ><span class="type-signature"></span>translateToGivenOrigin<span class="signature">(point, fromOriginX, fromOriginY, toOriginX, toOriginY)</span><span class="type-signature"> &rarr; {<a href="fabric.Point.html">fabric.Point</a>}</span></a></h4>
    

<div class="description">
    Translates the coordinates from a set of origin to another (based on the object's dimensions)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>point</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


            </td>

            
            <td class="description last">The point which corresponds to the originX and originY params</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fromOriginX</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Horizontal origin: 'left', 'center' or 'right'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fromOriginY</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Vertical origin: 'top', 'center' or 'bottom'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toOriginX</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Horizontal origin: 'left', 'center' or 'right'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>toOriginY</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Vertical origin: 'top', 'center' or 'bottom'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#translateToGivenOrigin">fabric.Object#translateToGivenOrigin</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13664">line 13664</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="translateToOriginPoint"><a href="#translateToOriginPoint" ><span class="type-signature"></span>translateToOriginPoint<span class="signature">(center, originX, originY)</span><span class="type-signature"> &rarr; {<a href="fabric.Point.html">fabric.Point</a>}</span></a></h4>
    

<div class="description">
    Translates the coordinates from center to origin coordinates (based on the object's dimensions)
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>center</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


            </td>

            
            <td class="description last">The point which corresponds to center of the object</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originX</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Horizontal origin: 'left', 'center' or 'right'</td>
        </tr>

    
        <tr>
            
                <td class="name"><code>originY</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            </td>

            
            <td class="description last">Vertical origin: 'top', 'center' or 'bottom'</td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#translateToOriginPoint">fabric.Object#translateToOriginPoint</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13732">line 13732</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Point.html">fabric.Point</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="viewportCenter"><a href="#viewportCenter" ><span class="type-signature"></span>viewportCenter<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Centers object on current viewport of canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#viewportCenter">fabric.Object#viewportCenter</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13562">line 13562</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="viewportCenterH"><a href="#viewportCenterH" ><span class="type-signature"></span>viewportCenterH<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Centers object horizontally on current viewport of canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#viewportCenterH">fabric.Object#viewportCenterH</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13518">line 13518</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="viewportCenterV"><a href="#viewportCenterV" ><span class="type-signature"></span>viewportCenterV<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="fabric.Object.html">fabric.Object</a>}</span></a></h4>
    

<div class="description">
    Centers object vertically on current viewport of canvas to which it was added last.
You might need to call `setCoords` on an object after centering, to update controls area.
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#viewportCenterV">fabric.Object#viewportCenterV</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line13540">line 13540</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    thisArg
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="fabric.Object.html">fabric.Object</a></span>


    </dd>
</dl>

    
</div>


<div class="inherited">


    <h4 class="name" id="willDrawShadow"><a href="#willDrawShadow" ><span class="type-signature"></span>willDrawShadow<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</span></a></h4>
    

<div class="description">
    Check if this object or a child object will cast a shadow
used by Group.shouldCache to know if child has a shadow recursively
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="fabric.Object.html#willDrawShadow">fabric.Object#willDrawShadow</a>
    </li></ul></dd>
    

    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="fabric.js.html">fabric.js</a>, <a href="fabric.js.html#line12912">line 12912</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    
</div>


</article>

</section>


</div>
<div id="carbonads-container">
  <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=fabricjscom" id="_carbonads_js"></script>
</div>
<footer><input id="toggle" type="checkbox" onclick="toggle(this.checked);"  /><label for="toggle" >Hide inherited properties and method from the page</label><br />Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sat Nov 25 2017 18:20:04 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
<script>
function toggle(displayState) {
    var value =  displayState ? 'none' : 'block';
    var elements = document.getElementsByClassName('inherited');
    for (var i = 0; i < elements.length; i++) {
        elements[i].style.display = value;
    }
}
</script>
</body>
</html>