Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.util.Point.html
1 <!DOCTYPE html><html><head><title>Ext.util.Point | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
2 <style type="text/css">.head-band { display: none; }
3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
4 .doc-tab .members .member a.more { background-color: #efefef; }
5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
8
9     req = {
10         liveURL: '.',
11         standAloneMode: true,
12         origDocClass: 'Ext.util.Point',
13         docClass: 'Ext.util.Point',
14         docReq: 'Ext.util.Point',
15         version: '4.0',
16         baseURL: '.',
17         baseDocURL: '.',
18         baseProdURL: '.'
19     };
20
21     clsInfo = {};
22
23
24
25 </script>
26
27 <script type="text/javascript" src="../search.js"></script>
28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
29 <script type="text/javascript" src="../class_tree.js"></script>
30 <script type="text/javascript" src="../class_doc.js"></script>
31 <script type="text/javascript">
32     req.source = 'Point.html#Ext-util.Point';
33     clsInfo = {"methods":["Point","adjust","constrainTo","contains","copy","copyFrom","equals","from","fromEvent","getOutOfBoundOffset","getOutOfBoundOffsetX","getOutOfBoundOffsetY","getRegion","intersect","isOutOfBound","isOutOfBoundX","isOutOfBoundY","isWithin","round","roundedEquals","toString","translateBy","union"],"cfgs":[],"properties":["translate"],"events":[],"subclasses":[]};
34     Ext.onReady(function() {
35         Ext.create('Docs.classPanel');
36     });
37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Point.html#Ext-util.Point" target="_blank">Ext.util.Point</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.util.Region.html" rel="Ext.util.Region" class="cls docClass">Ext.util.Region</a><div class="subclass"><strong>Ext.util.Point</strong></div></div></pre><p>Represents a 2D point with x and y properties, useful for comparison and instantiation
38 from an event:</p>
39
40 <pre class="prettyprint"><code>var point = Ext.util.Point.fromEvent(e);
41 </code></pre>
42
43 <div class="members"><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-translate" class="member f ni"><a href="Ext.util.Point.html#property-translate" rel="property-translate" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Point.html" class="definedIn docClass">Ext.util.Point</a><br/><a href="../source/Point.html#Ext-util.Point-property-translate" class="viewSource">view source</a></div><a name="translate"></a><a name="property-translate"></a><a href="Ext.util.Point.html#" rel="property-translate" class="cls expand">translate</a><span> : Object</span></div><div class="description"><div class="short"><p>Translate this region by the given offset amount. TODO: Either use translate or translateBy!</p>
44 </div><div class="long"><p>Translate this region by the given offset amount. TODO: Either use translate or translateBy!</p>
45 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-Point" class="member f inherited"><a href="Ext.util.Point.html#method-Point" rel="method-Point" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-constructor" class="viewSource">view source</a></div><a name="Point"></a><a name="method-Point"></a><a href="Ext.util.Point.html#" rel="method-Point" class="cls expand">Point</a>(
46 <span class="pre">Number top, Number right, Number bottom, Number left</span>)
47  : void</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
48 <h3 class="pa">Parameters</h3><ul><li><span class="pre">top</span> : Number<div class="sub-desc"><p>Top</p>
49 </div></li><li><span class="pre">right</span> : Number<div class="sub-desc"><p>Right</p>
50 </div></li><li><span class="pre">bottom</span> : Number<div class="sub-desc"><p>Bottom</p>
51 </div></li><li><span class="pre">left</span> : Number<div class="sub-desc"><p>Left</p>
52 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
53 </li></ul></div></div></div><div id="method-adjust" class="member inherited"><a href="Ext.util.Point.html#method-adjust" rel="method-adjust" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-adjust" class="viewSource">view source</a></div><a name="adjust"></a><a name="method-adjust"></a><a href="Ext.util.Point.html#" rel="method-adjust" class="cls expand">adjust</a>(
54 <span class="pre">Number top, Number right, Number bottom, Number left</span>)
55  : void</div><div class="description"><div class="short"><p>Modifies the current region to be adjusted by offsets.</p>
56 </div><div class="long"><p>Modifies the current region to be adjusted by offsets.</p>
57 <h3 class="pa">Parameters</h3><ul><li><span class="pre">top</span> : Number<div class="sub-desc"><p>top offset</p>
58 </div></li><li><span class="pre">right</span> : Number<div class="sub-desc"><p>right offset</p>
59 </div></li><li><span class="pre">bottom</span> : Number<div class="sub-desc"><p>bottom offset</p>
60 </div></li><li><span class="pre">left</span> : Number<div class="sub-desc"><p>left offset</p>
61 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
62 </li></ul></div></div></div><div id="method-constrainTo" class="member inherited"><a href="Ext.util.Point.html#method-constrainTo" rel="method-constrainTo" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-constrainTo" class="viewSource">view source</a></div><a name="constrainTo"></a><a name="method-constrainTo"></a><a href="Ext.util.Point.html#" rel="method-constrainTo" class="cls expand">constrainTo</a>(
63 <span class="pre">Ext.util.Region targetRegion</span>)
64  : void</div><div class="description"><div class="short"><p>Modifies the current region to be constrained to the targetRegion.</p>
65 </div><div class="long"><p>Modifies the current region to be constrained to the targetRegion.</p>
66 <h3 class="pa">Parameters</h3><ul><li><span class="pre">targetRegion</span> : Ext.util.Region<div class="sub-desc">
67 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
68 </li></ul></div></div></div><div id="method-contains" class="member inherited"><a href="Ext.util.Point.html#method-contains" rel="method-contains" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-contains" class="viewSource">view source</a></div><a name="contains"></a><a name="method-contains"></a><a href="Ext.util.Point.html#" rel="method-contains" class="cls expand">contains</a>(
69 <span class="pre">Ext.util.Region region</span>)
70  : void</div><div class="description"><div class="short"><p>Checks if this region completely contains the region that is passed in.</p>
71 </div><div class="long"><p>Checks if this region completely contains the region that is passed in.</p>
72 <h3 class="pa">Parameters</h3><ul><li><span class="pre">region</span> : Ext.util.Region<div class="sub-desc">
73 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
74 </li></ul></div></div></div><div id="method-copy" class="member inherited"><a href="Ext.util.Point.html#method-copy" rel="method-copy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-copy" class="viewSource">view source</a></div><a name="copy"></a><a name="method-copy"></a><a href="Ext.util.Point.html#" rel="method-copy" class="cls expand">copy</a> : Ext.util.Region</div><div class="description"><div class="short"><p>Copy a new instance</p>
75 </div><div class="long"><p>Copy a new instance</p>
76 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region</span>&nbsp; &nbsp;
77 </li></ul></div></div></div><div id="method-copyFrom" class="member inherited"><a href="Ext.util.Point.html#method-copyFrom" rel="method-copyFrom" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-copyFrom" class="viewSource">view source</a></div><a name="copyFrom"></a><a name="method-copyFrom"></a><a href="Ext.util.Point.html#" rel="method-copyFrom" class="cls expand">copyFrom</a>(
78 <span class="pre">Region The</span>)
79  : Ext.util.Point</div><div class="description"><div class="short"><p>Copy the values of another Region to this Region</p>
80 </div><div class="long"><p>Copy the values of another Region to this Region</p>
81 <h3 class="pa">Parameters</h3><ul><li><span class="pre">The</span> : Region<div class="sub-desc"><p>region to copy from.</p>
82 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Point</span>&nbsp; &nbsp;<p>this This point</p>
83 </li></ul></div></div></div><div id="method-equals" class="member ni"><a href="Ext.util.Point.html#method-equals" rel="method-equals" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Point.html" class="definedIn docClass">Ext.util.Point</a><br/><a href="../source/Point.html#Ext-util.Point-method-equals" class="viewSource">view source</a></div><a name="equals"></a><a name="method-equals"></a><a href="Ext.util.Point.html#" rel="method-equals" class="cls expand">equals</a>(
84 <span class="pre">Ext.util.Point/Object The</span>)
85  : Boolean</div><div class="description"><div class="short"><p>Compare this point and another point</p>
86 </div><div class="long"><p>Compare this point and another point</p>
87 <h3 class="pa">Parameters</h3><ul><li><span class="pre">The</span> : Ext.util.Point/Object<div class="sub-desc"><p>point to compare with, either an instance
88 of <a href="Ext.util.Point.html" rel="Ext.util.Point" class="docClass">Ext.util.Point</a> or an object with left and top properties</p>
89 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>Returns whether they are equivalent</p>
90 </li></ul></div></div></div><div id="method-from" class="member inherited"><a href="Ext.util.Point.html#method-from" rel="method-from" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-from" class="viewSource">view source</a></div><a name="from"></a><a name="method-from"></a><a href="Ext.util.Point.html#" rel="method-from" class="cls expand">from</a>(
91 <span class="pre">Object o</span>)
92  : Ext.util.Region</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
93 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object<div class="sub-desc"><p>An object with top, right, bottom, left properties</p>
94 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region</span>&nbsp; &nbsp;<p>region The region constructed based on the passed object</p>
95 </li></ul></div></div></div><div id="method-fromEvent" class="member ni"><a href="Ext.util.Point.html#method-fromEvent" rel="method-fromEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Point.html" class="definedIn docClass">Ext.util.Point</a><br/><a href="../source/Point.html#Ext-util.Point-method-fromEvent" class="viewSource">view source</a></div><a name="fromEvent"></a><a name="method-fromEvent"></a><a href="Ext.util.Point.html#" rel="method-fromEvent" class="cls expand">fromEvent</a>(
96 <span class="pre">Event e</span>)
97  : void</div><div class="description"><div class="short"><p>Returns a new instance of <a href="Ext.util.Point.html" rel="Ext.util.Point" class="docClass">Ext.util.Point</a> base on the pageX / pageY values of the given event</p>
98 </div><div class="long"><p>Returns a new instance of <a href="Ext.util.Point.html" rel="Ext.util.Point" class="docClass">Ext.util.Point</a> base on the pageX / pageY values of the given event</p>
99 <h3 class="pa">Parameters</h3><ul><li><span class="pre">e</span> : Event<div class="sub-desc"><p>The event</p>
100 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;<p>Ext.util.Point</p>
101 </li></ul></div></div></div><div id="method-getOutOfBoundOffset" class="member inherited"><a href="Ext.util.Point.html#method-getOutOfBoundOffset" rel="method-getOutOfBoundOffset" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-getOutOfBoundOffset" class="viewSource">view source</a></div><a name="getOutOfBoundOffset"></a><a name="method-getOutOfBoundOffset"></a><a href="Ext.util.Point.html#" rel="method-getOutOfBoundOffset" class="cls expand">getOutOfBoundOffset</a>(
102 <span class="pre">String axis, Ext.util.Point p</span>)
103  : Ext.util.Offset</div><div class="description"><div class="short"><p>Get the offset amount of a point outside the region</p>
104 </div><div class="long"><p>Get the offset amount of a point outside the region</p>
105 <h3 class="pa">Parameters</h3><ul><li><span class="pre">axis</span> : String<div class="sub-desc"><p>optional</p>
106 </div></li><li><span class="pre">p</span> : Ext.util.Point<div class="sub-desc"><p>the point</p>
107 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Offset</span>&nbsp; &nbsp;
108 </li></ul></div></div></div><div id="method-getOutOfBoundOffsetX" class="member inherited"><a href="Ext.util.Point.html#method-getOutOfBoundOffsetX" rel="method-getOutOfBoundOffsetX" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-getOutOfBoundOffsetX" class="viewSource">view source</a></div><a name="getOutOfBoundOffsetX"></a><a name="method-getOutOfBoundOffsetX"></a><a href="Ext.util.Point.html#" rel="method-getOutOfBoundOffsetX" class="cls expand">getOutOfBoundOffsetX</a>(
109 <span class="pre">Number p</span>)
110  : Number</div><div class="description"><div class="short"><p>Get the offset amount on the x-axis</p>
111 </div><div class="long"><p>Get the offset amount on the x-axis</p>
112 <h3 class="pa">Parameters</h3><ul><li><span class="pre">p</span> : Number<div class="sub-desc"><p>the offset</p>
113 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
114 </li></ul></div></div></div><div id="method-getOutOfBoundOffsetY" class="member inherited"><a href="Ext.util.Point.html#method-getOutOfBoundOffsetY" rel="method-getOutOfBoundOffsetY" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-getOutOfBoundOffsetY" class="viewSource">view source</a></div><a name="getOutOfBoundOffsetY"></a><a name="method-getOutOfBoundOffsetY"></a><a href="Ext.util.Point.html#" rel="method-getOutOfBoundOffsetY" class="cls expand">getOutOfBoundOffsetY</a>(
115 <span class="pre">Number p</span>)
116  : Number</div><div class="description"><div class="short"><p>Get the offset amount on the y-axis</p>
117 </div><div class="long"><p>Get the offset amount on the y-axis</p>
118 <h3 class="pa">Parameters</h3><ul><li><span class="pre">p</span> : Number<div class="sub-desc"><p>the offset</p>
119 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Number</span>&nbsp; &nbsp;
120 </li></ul></div></div></div><div id="method-getRegion" class="member inherited"><a href="Ext.util.Point.html#method-getRegion" rel="method-getRegion" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-getRegion" class="viewSource">view source</a></div><a name="getRegion"></a><a name="method-getRegion"></a><a href="Ext.util.Point.html#" rel="method-getRegion" class="cls expand">getRegion</a>(
121 <span class="pre">Mixed el</span>)
122  : Ext.util.Region</div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
123 <h3 class="pa">Parameters</h3><ul><li><span class="pre">el</span> : Mixed<div class="sub-desc"><p>A string, DomElement or <a href="Ext.core.Element.html" rel="Ext.core.Element" class="docClass">Ext.core.Element</a> representing an element
124 on the page.</p>
125 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region</span>&nbsp; &nbsp;<p>region
126 Retrieves an <a href="Ext.util.Region.html" rel="Ext.util.Region" class="docClass">Ext.util.Region</a> for a particular element.</p>
127 </li></ul></div></div></div><div id="method-intersect" class="member inherited"><a href="Ext.util.Point.html#method-intersect" rel="method-intersect" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-intersect" class="viewSource">view source</a></div><a name="intersect"></a><a name="method-intersect"></a><a href="Ext.util.Point.html#" rel="method-intersect" class="cls expand">intersect</a>(
128 <span class="pre">Ext.util.Region region</span>)
129  : Ext.util.Region/Boolean</div><div class="description"><div class="short"><p>Checks if this region intersects the region passed in.</p>
130 </div><div class="long"><p>Checks if this region intersects the region passed in.</p>
131 <h3 class="pa">Parameters</h3><ul><li><span class="pre">region</span> : Ext.util.Region<div class="sub-desc">
132 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region/Boolean</span>&nbsp; &nbsp;<p>Returns the intersected region or false if there is no intersection.</p>
133 </li></ul></div></div></div><div id="method-isOutOfBound" class="member inherited"><a href="Ext.util.Point.html#method-isOutOfBound" rel="method-isOutOfBound" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-isOutOfBound" class="viewSource">view source</a></div><a name="isOutOfBound"></a><a name="method-isOutOfBound"></a><a href="Ext.util.Point.html#" rel="method-isOutOfBound" class="cls expand">isOutOfBound</a>(
134 <span class="pre">String axis, Ext.util.Point/Number p</span>)
135  : Boolean</div><div class="description"><div class="short"><p>Check whether the point / offset is out of bound</p>
136 </div><div class="long"><p>Check whether the point / offset is out of bound</p>
137 <h3 class="pa">Parameters</h3><ul><li><span class="pre">axis</span> : String<div class="sub-desc"><p>optional</p>
138 </div></li><li><span class="pre">p</span> : Ext.util.Point/Number<div class="sub-desc"><p>the point / offset</p>
139 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
140 </li></ul></div></div></div><div id="method-isOutOfBoundX" class="member inherited"><a href="Ext.util.Point.html#method-isOutOfBoundX" rel="method-isOutOfBoundX" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-isOutOfBoundX" class="viewSource">view source</a></div><a name="isOutOfBoundX"></a><a name="method-isOutOfBoundX"></a><a href="Ext.util.Point.html#" rel="method-isOutOfBoundX" class="cls expand">isOutOfBoundX</a>(
141 <span class="pre">Number p</span>)
142  : Boolean</div><div class="description"><div class="short"><p>Check whether the offset is out of bound in the x-axis</p>
143 </div><div class="long"><p>Check whether the offset is out of bound in the x-axis</p>
144 <h3 class="pa">Parameters</h3><ul><li><span class="pre">p</span> : Number<div class="sub-desc"><p>the offset</p>
145 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
146 </li></ul></div></div></div><div id="method-isOutOfBoundY" class="member inherited"><a href="Ext.util.Point.html#method-isOutOfBoundY" rel="method-isOutOfBoundY" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-isOutOfBoundY" class="viewSource">view source</a></div><a name="isOutOfBoundY"></a><a name="method-isOutOfBoundY"></a><a href="Ext.util.Point.html#" rel="method-isOutOfBoundY" class="cls expand">isOutOfBoundY</a>(
147 <span class="pre">Number p</span>)
148  : Boolean</div><div class="description"><div class="short"><p>Check whether the offset is out of bound in the y-axis</p>
149 </div><div class="long"><p>Check whether the offset is out of bound in the y-axis</p>
150 <h3 class="pa">Parameters</h3><ul><li><span class="pre">p</span> : Number<div class="sub-desc"><p>the offset</p>
151 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
152 </li></ul></div></div></div><div id="method-isWithin" class="member ni"><a href="Ext.util.Point.html#method-isWithin" rel="method-isWithin" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Point.html" class="definedIn docClass">Ext.util.Point</a><br/><a href="../source/Point.html#Ext-util.Point-method-isWithin" class="viewSource">view source</a></div><a name="isWithin"></a><a name="method-isWithin"></a><a href="Ext.util.Point.html#" rel="method-isWithin" class="cls expand">isWithin</a>(
153 <span class="pre">Ext.util.Point/Object The, Object/Number threshold</span>)
154  : Boolean</div><div class="description"><div class="short"><p>Whether the given point is not away from this point within the given threshold amount.
155 TODO: Rename this isNear.</p>
156 </div><div class="long"><p>Whether the given point is not away from this point within the given threshold amount.
157 TODO: Rename this isNear.</p>
158 <h3 class="pa">Parameters</h3><ul><li><span class="pre">The</span> : Ext.util.Point/Object<div class="sub-desc"><p>point to check with, either an instance
159 of <a href="Ext.util.Point.html" rel="Ext.util.Point" class="docClass">Ext.util.Point</a> or an object with left and top properties</p>
160 </div></li><li><span class="pre">threshold</span> : Object/Number<div class="sub-desc"><p>Can be either an object with x and y properties or a number</p>
161 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
162 </li></ul></div></div></div><div id="method-round" class="member inherited"><a href="Ext.util.Point.html#method-round" rel="method-round" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-round" class="viewSource">view source</a></div><a name="round"></a><a name="method-round"></a><a href="Ext.util.Point.html#" rel="method-round" class="cls expand">round</a> : Ext.util.Region</div><div class="description"><div class="short"><p>Round all the properties of this region</p>
163 </div><div class="long"><p>Round all the properties of this region</p>
164 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region</span>&nbsp; &nbsp;<p>this This Region</p>
165 </li></ul></div></div></div><div id="method-roundedEquals" class="member ni"><a href="Ext.util.Point.html#method-roundedEquals" rel="method-roundedEquals" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Point.html" class="definedIn docClass">Ext.util.Point</a><br/><a href="../source/Point.html#Ext-util.Point-method-roundedEquals" class="viewSource">view source</a></div><a name="roundedEquals"></a><a name="method-roundedEquals"></a><a href="Ext.util.Point.html#" rel="method-roundedEquals" class="cls expand">roundedEquals</a>(
166 <span class="pre">Ext.util.Point/Object The</span>)
167  : Boolean</div><div class="description"><div class="short">Compare this point with another point when the x and y values of both points are rounded. E.g:
168 [100.3,199.8] will equ...</div><div class="long"><p>Compare this point with another point when the x and y values of both points are rounded. E.g:
169 [100.3,199.8] will equals to [100, 200]</p>
170 <h3 class="pa">Parameters</h3><ul><li><span class="pre">The</span> : Ext.util.Point/Object<div class="sub-desc"><p>point to compare with, either an instance
171 of <a href="Ext.util.Point.html" rel="Ext.util.Point" class="docClass">Ext.util.Point</a> or an object with x and y properties</p>
172 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;
173 </li></ul></div></div></div><div id="method-toString" class="member ni"><a href="Ext.util.Point.html#method-toString" rel="method-toString" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Point.html" class="definedIn docClass">Ext.util.Point</a><br/><a href="../source/Point.html#Ext-util.Point-method-toString" class="viewSource">view source</a></div><a name="toString"></a><a name="method-toString"></a><a href="Ext.util.Point.html#" rel="method-toString" class="cls expand">toString</a> : String</div><div class="description"><div class="short"><p>Returns a human-eye-friendly string that represents this point,
174 useful for debugging</p>
175 </div><div class="long"><p>Returns a human-eye-friendly string that represents this point,
176 useful for debugging</p>
177 <h3 class="pa">Returns</h3><ul><li><span class="pre">String</span>&nbsp; &nbsp;
178 </li></ul></div></div></div><div id="method-translateBy" class="member inherited"><a href="Ext.util.Point.html#method-translateBy" rel="method-translateBy" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-translateBy" class="viewSource">view source</a></div><a name="translateBy"></a><a name="method-translateBy"></a><a href="Ext.util.Point.html#" rel="method-translateBy" class="cls expand">translateBy</a>(
179 <span class="pre">Ext.util.Offset/Object offset, Number The</span>)
180  : Ext.util.Region</div><div class="description"><div class="short"><p>Translate this region by the given offset amount</p>
181 </div><div class="long"><p>Translate this region by the given offset amount</p>
182 <h3 class="pa">Parameters</h3><ul><li><span class="pre">offset</span> : Ext.util.Offset/Object<div class="sub-desc"><p>Object containing the <code>x</code> and <code>y</code> properties.
183 Or the x value is using the two argument form.</p>
184 </div></li><li><span class="pre">The</span> : Number<div class="sub-desc"><p>y value unless using an Offset object.</p>
185 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.util.Region</span>&nbsp; &nbsp;<p>this This Region</p>
186 </li></ul></div></div></div><div id="method-union" class="member inherited"><a href="Ext.util.Point.html#method-union" rel="method-union" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Region.html" class="definedIn docClass">Ext.util.Region</a><br/><a href="../source/Region.html#Ext-util.Region-method-union" class="viewSource">view source</a></div><a name="union"></a><a name="method-union"></a><a href="Ext.util.Point.html#" rel="method-union" class="cls expand">union</a>(
187 <span class="pre">Ext.util.Region region</span>)
188  : void</div><div class="description"><div class="short"><p>Returns the smallest region that contains the current AND targetRegion.</p>
189 </div><div class="long"><p>Returns the smallest region that contains the current AND targetRegion.</p>
190 <h3 class="pa">Parameters</h3><ul><li><span class="pre">region</span> : Ext.util.Region<div class="sub-desc">
191 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
192 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>