range.html 70 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968
  1. <div id="documentation" class="span9">
  2. <div class="classContent">
  3. <div class="membersBackground"></div>
  4. <div class=" members pos0">
  5. <div class=" membersContent pos0">
  6. <h1 class="memberHeader"><span class="name">Range</span>
  7. </h1>
  8. <ul data-tabs="tabs" class="nav tabs pos0">
  9. <li data-dropdown="dropdown" class="dropdown">
  10. <ul class="dropdown-menu">
  11. </ul>
  12. </li>
  13. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Constructors (1)</span><b class="caret"></b></a>
  14. <ul class="dropdown-menu">
  15. <li id="dropdown_Range.new" data-id="Range.new" class="memberLink"><a href="#Range.new" class="" title="Range.new (constructor)" data-id="Range.new">new</a>
  16. </li>
  17. </ul>
  18. </li>
  19. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (26)</span><b class="caret"></b></a>
  20. <ul class="dropdown-menu">
  21. <li id="dropdown_Range.clipRows" data-id="Range.clipRows" class="memberLink"><a href="#Range.clipRows" class="" title="Range.clipRows (class method)" data-id="Range.clipRows">clipRows</a>
  22. </li>
  23. <li id="dropdown_Range.clone" data-id="Range.clone" class="memberLink"><a href="#Range.clone" class="" title="Range.clone (class method)" data-id="Range.clone">clone</a>
  24. </li>
  25. <li id="dropdown_Range.collapseRows" data-id="Range.collapseRows" class="memberLink"><a href="#Range.collapseRows" class="" title="Range.collapseRows (class method)" data-id="Range.collapseRows">collapseRows</a>
  26. </li>
  27. <li id="dropdown_Range.compare" data-id="Range.compare" class="memberLink"><a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">compare</a>
  28. </li>
  29. <li id="dropdown_Range.compareEnd" data-id="Range.compareEnd" class="memberLink"><a href="#Range.compareEnd" class="" title="Range.compareEnd (class method)" data-id="Range.compareEnd">compareEnd</a>
  30. </li>
  31. <li id="dropdown_Range.compareInside" data-id="Range.compareInside" class="memberLink"><a href="#Range.compareInside" class="" title="Range.compareInside (class method)" data-id="Range.compareInside">compareInside</a>
  32. </li>
  33. <li id="dropdown_Range.comparePoint" data-id="Range.comparePoint" class="memberLink"><a href="#Range.comparePoint" class="" title="Range.comparePoint (class method)" data-id="Range.comparePoint">comparePoint</a>
  34. </li>
  35. <li id="dropdown_Range.compareRange" data-id="Range.compareRange" class="memberLink"><a href="#Range.compareRange" class="" title="Range.compareRange (class method)" data-id="Range.compareRange">compareRange</a>
  36. </li>
  37. <li id="dropdown_Range.compareStart" data-id="Range.compareStart" class="memberLink"><a href="#Range.compareStart" class="" title="Range.compareStart (class method)" data-id="Range.compareStart">compareStart</a>
  38. </li>
  39. <li id="dropdown_Range.contains" data-id="Range.contains" class="memberLink"><a href="#Range.contains" class="" title="Range.contains (class method)" data-id="Range.contains">contains</a>
  40. </li>
  41. <li id="dropdown_Range.containsRange" data-id="Range.containsRange" class="memberLink"><a href="#Range.containsRange" class="" title="Range.containsRange (class method)" data-id="Range.containsRange">containsRange</a>
  42. </li>
  43. <li id="dropdown_Range.extend" data-id="Range.extend" class="memberLink"><a href="#Range.extend" class="" title="Range.extend (class method)" data-id="Range.extend">extend</a>
  44. </li>
  45. <li id="dropdown_Range.fromPoints" data-id="Range.fromPoints" class="memberLink"><a href="#Range.fromPoints" class="" title="Range.fromPoints (class method)" data-id="Range.fromPoints">fromPoints</a>
  46. </li>
  47. <li id="dropdown_Range.inside" data-id="Range.inside" class="memberLink"><a href="#Range.inside" class="" title="Range.inside (class method)" data-id="Range.inside">inside</a>
  48. </li>
  49. <li id="dropdown_Range.insideEnd" data-id="Range.insideEnd" class="memberLink"><a href="#Range.insideEnd" class="" title="Range.insideEnd (class method)" data-id="Range.insideEnd">insideEnd</a>
  50. </li>
  51. <li id="dropdown_Range.insideStart" data-id="Range.insideStart" class="memberLink"><a href="#Range.insideStart" class="" title="Range.insideStart (class method)" data-id="Range.insideStart">insideStart</a>
  52. </li>
  53. <li id="dropdown_Range.intersects" data-id="Range.intersects" class="memberLink"><a href="#Range.intersects" class="" title="Range.intersects (class method)" data-id="Range.intersects">intersects</a>
  54. </li>
  55. <li id="dropdown_Range.isEmpty" data-id="Range.isEmpty" class="memberLink"><a href="#Range.isEmpty" class="" title="Range.isEmpty (class method)" data-id="Range.isEmpty">isEmpty</a>
  56. </li>
  57. <li id="dropdown_Range.isEnd" data-id="Range.isEnd" class="memberLink"><a href="#Range.isEnd" class="" title="Range.isEnd (class method)" data-id="Range.isEnd">isEnd</a>
  58. </li>
  59. <li id="dropdown_Range.isEqual" data-id="Range.isEqual" class="memberLink"><a href="#Range.isEqual" class="" title="Range.isEqual (class method)" data-id="Range.isEqual">isEqual</a>
  60. </li>
  61. <li id="dropdown_Range.isMultiLine" data-id="Range.isMultiLine" class="memberLink"><a href="#Range.isMultiLine" class="" title="Range.isMultiLine (class method)" data-id="Range.isMultiLine">isMultiLine</a>
  62. </li>
  63. <li id="dropdown_Range.isStart" data-id="Range.isStart" class="memberLink"><a href="#Range.isStart" class="" title="Range.isStart (class method)" data-id="Range.isStart">isStart</a>
  64. </li>
  65. <li id="dropdown_Range.setEnd" data-id="Range.setEnd" class="memberLink"><a href="#Range.setEnd" class="" title="Range.setEnd (class method)" data-id="Range.setEnd">setEnd</a>
  66. </li>
  67. <li id="dropdown_Range.setStart" data-id="Range.setStart" class="memberLink"><a href="#Range.setStart" class="" title="Range.setStart (class method)" data-id="Range.setStart">setStart</a>
  68. </li>
  69. <li id="dropdown_Range.toScreenRange" data-id="Range.toScreenRange" class="memberLink"><a href="#Range.toScreenRange" class="" title="Range.toScreenRange (class method)" data-id="Range.toScreenRange">toScreenRange</a>
  70. </li>
  71. <li id="dropdown_Range.toString" data-id="Range.toString" class="memberLink"><a href="#Range.toString" class="" title="Range.toString (class method)" data-id="Range.toString">toString</a>
  72. </li>
  73. </ul>
  74. </li>
  75. <li data-dropdown="dropdown" class="dropdown">
  76. <ul class="dropdown-menu">
  77. </ul>
  78. </li>
  79. <li data-dropdown="dropdown" class="dropdown">
  80. <ul class="dropdown-menu">
  81. </ul>
  82. </li>
  83. <li data-dropdown="dropdown" class="dropdown">
  84. <ul class="dropdown-menu">
  85. </ul>
  86. </li>
  87. <li data-dropdown="dropdown" class="dropdown">
  88. <ul class="dropdown-menu">
  89. </ul>
  90. </li>
  91. </ul>
  92. </div>
  93. </div>
  94. <article id="Range" data-title="Range (class)" class="article">
  95. <div class="section description">
  96. <div class="memberContent"><p>This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.</p>
  97. </div>
  98. </div>
  99. </article>
  100. <h3 class="sectionHeader">Constructors</h3>
  101. <article id="Range.new" data-title="Range.new (constructor)" class="article">
  102. <div class="section method">
  103. <div class="memberContent">
  104. <div class="title"><i id="Range.new" class="methodToggle methodClicker inactive icon-caret-right"></i>
  105. <ul class="signatures">
  106. <li class="signature">
  107. <ul>
  108. <li class="signature-call"><span class="constructorIdentifier">new </span><span id="Range.new" class="member-name methodClicker">Range</span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> startRow, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> startColumn, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> endRow, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> endColumn</span>)</li>
  109. </ul>
  110. <ul class="metaInfo">
  111. </ul>
  112. </li>
  113. </ul>
  114. </div>
  115. <div class="sideToggler">
  116. <div id="ellipsis_Range.new" class="ellipsis_description"><p>Creates a new <code>Range</code> object with the given starting and ending row and column points.</p>
  117. </div>
  118. <div class="description"><p>Creates a new <code>Range</code> object with the given starting and ending row and column points.</p>
  119. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">startRow</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The starting row</p>
  120. </td></tr><tr class="argumentRow "><td class="argName ">startColumn</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The starting column</p>
  121. </td></tr><tr class="argumentRow "><td class="argName ">endRow</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The ending row</p>
  122. </td></tr><tr class="argumentRow "><td class="argName ">endColumn</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The ending column</p>
  123. </td></tr></table>
  124. </div>
  125. </div>
  126. </div>
  127. </div>
  128. </article>
  129. <h3 class="sectionHeader">Methods</h3>
  130. <article id="Range.clipRows" data-title="Range.clipRows (class method)" class="article">
  131. <div class="section method">
  132. <div class="memberContent">
  133. <div class="title"><i id="Range.clipRows" class="methodToggle methodClicker inactive icon-caret-right"></i>
  134. <ul class="signatures">
  135. <li class="signature">
  136. <ul>
  137. <li class="signature-call"><span id="Range.clipRows" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">clipRows</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> firstRow, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> lastRow</span>)
  138. <li class="signature-returns">
  139. <ul class="argument-types">
  140. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  141. </ul>
  142. </li></li>
  143. </ul>
  144. <ul class="metaInfo">
  145. </ul>
  146. </li>
  147. </ul>
  148. </div>
  149. <div class="sideToggler">
  150. <div id="ellipsis_Range.clipRows" class="ellipsis_description"><p>Returns the part of the current <code>Range</code> that occurs within the boundaries of <code>firstRow</code> and <code>lastRow</code> as a new <code>Range</code> object.</p>
  151. </div>
  152. <div class="description"><p>Returns the part of the current <code>Range</code> that occurs within the boundaries of <code>firstRow</code> and <code>lastRow</code> as a new <code>Range</code> object.</p>
  153. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">firstRow</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The starting row</p>
  154. </td></tr><tr class="argumentRow "><td class="argName ">lastRow</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. The ending row</p>
  155. </td></tr></table>
  156. </div>
  157. </div>
  158. </div>
  159. </div>
  160. </article>
  161. <article id="Range.clone" data-title="Range.clone (class method)" class="article">
  162. <div class="section method">
  163. <div class="memberContent">
  164. <div class="title"><i id="Range.clone" class="methodToggle methodClicker inactive icon-caret-right"></i>
  165. <ul class="signatures">
  166. <li class="signature">
  167. <ul>
  168. <li class="signature-call"><span id="Range.clone" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">clone</span></span><span class="emptyArgumentList">()</span>
  169. <li class="signature-returns">
  170. <ul class="argument-types">
  171. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  172. </ul>
  173. </li></li>
  174. </ul>
  175. <ul class="metaInfo">
  176. </ul>
  177. </li>
  178. </ul>
  179. </div>
  180. <div class="sideToggler">
  181. <div id="ellipsis_Range.clone" class="ellipsis_description"><p>Returns a duplicate of the calling range.</p>
  182. </div>
  183. <div class="description"><p>Returns a duplicate of the calling range.</p>
  184. </div>
  185. </div>
  186. </div>
  187. </div>
  188. </article>
  189. <article id="Range.collapseRows" data-title="Range.collapseRows (class method)" class="article">
  190. <div class="section method">
  191. <div class="memberContent">
  192. <div class="title"><i id="Range.collapseRows" class="methodToggle methodClicker inactive icon-caret-right"></i>
  193. <ul class="signatures">
  194. <li class="signature">
  195. <ul>
  196. <li class="signature-call"><span id="Range.collapseRows" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">collapseRows</span></span><span class="emptyArgumentList">()</span>
  197. <li class="signature-returns">
  198. <ul class="argument-types">
  199. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  200. </ul>
  201. </li></li>
  202. </ul>
  203. <ul class="metaInfo">
  204. </ul>
  205. </li>
  206. </ul>
  207. </div>
  208. <div class="sideToggler">
  209. <div id="ellipsis_Range.collapseRows" class="ellipsis_description"><p>Returns a range containing the starting and ending rows of the original range, but with a column value of <code>0</code>.</p>
  210. </div>
  211. <div class="description"><p>Returns a range containing the starting and ending rows of the original range, but with a column value of <code>0</code>.</p>
  212. </div>
  213. </div>
  214. </div>
  215. </div>
  216. </article>
  217. <article id="Range.compare" data-title="Range.compare (class method)" class="article">
  218. <div class="section method">
  219. <div class="memberContent">
  220. <div class="title"><i id="Range.compare" class="methodToggle methodClicker inactive icon-caret-right"></i>
  221. <ul class="signatures">
  222. <li class="signature">
  223. <ul>
  224. <li class="signature-call"><span id="Range.compare" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">compare</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  225. <li class="signature-returns">
  226. <ul class="argument-types">
  227. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  228. </ul>
  229. </li></li>
  230. </ul>
  231. <ul class="metaInfo">
  232. </ul>
  233. </li>
  234. </ul>
  235. </div>
  236. <div class="sideToggler">
  237. <div id="ellipsis_Range.compare" class="ellipsis_description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  238. </div>
  239. <div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  240. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  241. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  242. </td></tr></table>
  243. </div>
  244. </div>
  245. </div>
  246. </div>
  247. </article>
  248. <article id="Range.compareEnd" data-title="Range.compareEnd (class method)" class="article">
  249. <div class="section method">
  250. <div class="memberContent">
  251. <div class="title"><i id="Range.compareEnd" class="methodToggle methodClicker inactive icon-caret-right"></i>
  252. <ul class="signatures">
  253. <li class="signature">
  254. <ul>
  255. <li class="signature-call"><span id="Range.compareEnd" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">compareEnd</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  256. <li class="signature-returns">
  257. <ul class="argument-types">
  258. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  259. </ul>
  260. </li></li>
  261. </ul>
  262. <ul class="metaInfo">
  263. </ul>
  264. </li>
  265. </ul>
  266. </div>
  267. <div class="sideToggler">
  268. <div id="ellipsis_Range.compareEnd" class="ellipsis_description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  269. </div>
  270. <div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  271. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  272. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  273. </td></tr></table>
  274. </div>
  275. </div>
  276. </div>
  277. </div>
  278. </article>
  279. <article id="Range.compareInside" data-title="Range.compareInside (class method)" class="article">
  280. <div class="section method">
  281. <div class="memberContent">
  282. <div class="title"><i id="Range.compareInside" class="methodToggle methodClicker inactive icon-caret-right"></i>
  283. <ul class="signatures">
  284. <li class="signature">
  285. <ul>
  286. <li class="signature-call"><span id="Range.compareInside" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">compareInside</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  287. <li class="signature-returns">
  288. <ul class="argument-types">
  289. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  290. </ul>
  291. </li></li>
  292. </ul>
  293. <ul class="metaInfo">
  294. </ul>
  295. </li>
  296. </ul>
  297. </div>
  298. <div class="sideToggler">
  299. <div id="ellipsis_Range.compareInside" class="ellipsis_description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  300. </div>
  301. <div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  302. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  303. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  304. </td></tr></table>
  305. </div>
  306. </div>
  307. </div>
  308. </div>
  309. </article>
  310. <article id="Range.comparePoint" data-title="Range.comparePoint (class method)" class="article">
  311. <div class="section method">
  312. <div class="memberContent">
  313. <div class="title"><i id="Range.comparePoint" class="methodToggle methodClicker inactive icon-caret-right"></i>
  314. <ul class="signatures">
  315. <li class="signature">
  316. <ul>
  317. <li class="signature-call"><span id="Range.comparePoint" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">comparePoint</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> p</span>)
  318. <li class="signature-returns">
  319. <ul class="argument-types">
  320. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  321. </ul>
  322. </li></li>
  323. </ul>
  324. <ul class="metaInfo">
  325. </ul>
  326. </li>
  327. </ul>
  328. </div>
  329. <div class="sideToggler">
  330. <div id="ellipsis_Range.comparePoint" class="ellipsis_description"><p>Checks the row and column points of <code>p</code> with the row and column points of the calling range.</p>
  331. </div>
  332. <div class="description"><p>Checks the row and column points of <code>p</code> with the row and column points of the calling range.</p>
  333. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">p</td><td class="argType" "><a href="range.html" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription "><p>Required. A point to compare with</p>
  334. </td></tr></table>
  335. </div>
  336. </div>
  337. </div>
  338. </div>
  339. </article>
  340. <article id="Range.compareRange" data-title="Range.compareRange (class method)" class="article">
  341. <div class="section method">
  342. <div class="memberContent">
  343. <div class="title"><i id="Range.compareRange" class="methodToggle methodClicker inactive icon-caret-right"></i>
  344. <ul class="signatures">
  345. <li class="signature">
  346. <ul>
  347. <li class="signature-call"><span id="Range.compareRange" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">compareRange</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)
  348. <li class="signature-returns">
  349. <ul class="argument-types">
  350. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  351. </ul>
  352. </li></li>
  353. </ul>
  354. <ul class="metaInfo">
  355. </ul>
  356. </li>
  357. </ul>
  358. </div>
  359. <div class="sideToggler">
  360. <div id="ellipsis_Range.compareRange" class="ellipsis_description"><p>Compares <code>this</code> range (A) with another range (B).</p>
  361. </div>
  362. <div class="description"><p>Compares <code>this</code> range (A) with another range (B).</p>
  363. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">range</td><td class="argType" "><a href="range.html" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription "><p>Required. A range to compare with</p>
  364. </td></tr></table>
  365. </div>
  366. </div>
  367. </div>
  368. </div>
  369. </article>
  370. <article id="Range.compareStart" data-title="Range.compareStart (class method)" class="article">
  371. <div class="section method">
  372. <div class="memberContent">
  373. <div class="title"><i id="Range.compareStart" class="methodToggle methodClicker inactive icon-caret-right"></i>
  374. <ul class="signatures">
  375. <li class="signature">
  376. <ul>
  377. <li class="signature-call"><span id="Range.compareStart" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">compareStart</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  378. <li class="signature-returns">
  379. <ul class="argument-types">
  380. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="returnType " title="Number" data-id="Number">Number</a></li>
  381. </ul>
  382. </li></li>
  383. </ul>
  384. <ul class="metaInfo">
  385. </ul>
  386. </li>
  387. </ul>
  388. </div>
  389. <div class="sideToggler">
  390. <div id="ellipsis_Range.compareStart" class="ellipsis_description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  391. </div>
  392. <div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
  393. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  394. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  395. </td></tr></table>
  396. </div>
  397. </div>
  398. </div>
  399. </div>
  400. </article>
  401. <article id="Range.contains" data-title="Range.contains (class method)" class="article">
  402. <div class="section method">
  403. <div class="memberContent">
  404. <div class="title"><i id="Range.contains" class="methodToggle methodClicker inactive icon-caret-right"></i>
  405. <ul class="signatures">
  406. <li class="signature">
  407. <ul>
  408. <li class="signature-call"><span id="Range.contains" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">contains</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  409. <li class="signature-returns">
  410. <ul class="argument-types">
  411. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  412. </ul>
  413. </li></li>
  414. </ul>
  415. <ul class="metaInfo">
  416. </ul>
  417. </li>
  418. </ul>
  419. </div>
  420. <div class="sideToggler">
  421. <div id="ellipsis_Range.contains" class="ellipsis_description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> provided are within the given range. This can better be expressed as returning <code>true</code> if:</p>
  422. <pre><code class="language-javascript"> <span class="keyword">this</span>.start.row &lt;= row &lt;= <span class="keyword">this</span>.end.row &amp;&amp;
  423. <span class="keyword">this</span>.start.column &lt;= column &lt;= <span class="keyword">this</span>.end.column</code></pre>
  424. </div>
  425. <div class="description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> provided are within the given range. This can better be expressed as returning <code>true</code> if:</p>
  426. <pre><code class="language-javascript"> <span class="keyword">this</span>.start.row &lt;= row &lt;= <span class="keyword">this</span>.end.row &amp;&amp;
  427. <span class="keyword">this</span>.start.column &lt;= column &lt;= <span class="keyword">this</span>.end.column</code></pre>
  428. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row to check for</p>
  429. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column to check for</p>
  430. </td></tr></table>
  431. </div>
  432. </div>
  433. </div>
  434. </div>
  435. </article>
  436. <article id="Range.containsRange" data-title="Range.containsRange (class method)" class="article">
  437. <div class="section method">
  438. <div class="memberContent">
  439. <div class="title"><i id="Range.containsRange" class="methodToggle methodClicker inactive icon-caret-right"></i>
  440. <ul class="signatures">
  441. <li class="signature">
  442. <ul>
  443. <li class="signature-call"><span id="Range.containsRange" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">containsRange</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)
  444. <li class="signature-returns">
  445. <ul class="argument-types">
  446. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  447. </ul>
  448. </li></li>
  449. </ul>
  450. <ul class="metaInfo">
  451. </ul>
  452. </li>
  453. </ul>
  454. </div>
  455. <div class="sideToggler">
  456. <div id="ellipsis_Range.containsRange" class="ellipsis_description"><p>Checks the start and end points of <code>range</code> and compares them to the calling range. Returns <code>true</code> if the <code>range</code> is contained within the caller&#39;s range.</p>
  457. </div>
  458. <div class="description"><p>Checks the start and end points of <code>range</code> and compares them to the calling range. Returns <code>true</code> if the <code>range</code> is contained within the caller&#39;s range.</p>
  459. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">range</td><td class="argType" "><a href="range.html" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription "><p>Required. A range to compare with</p>
  460. </td></tr></table>
  461. </div>
  462. </div>
  463. </div>
  464. </div>
  465. </article>
  466. <article id="Range.extend" data-title="Range.extend (class method)" class="article">
  467. <div class="section method">
  468. <div class="memberContent">
  469. <div class="title"><i id="Range.extend" class="methodToggle methodClicker inactive icon-caret-right"></i>
  470. <ul class="signatures">
  471. <li class="signature">
  472. <ul>
  473. <li class="signature-call"><span id="Range.extend" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">extend</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  474. <li class="signature-returns">
  475. <ul class="argument-types">
  476. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  477. </ul>
  478. </li></li>
  479. </ul>
  480. <ul class="metaInfo">
  481. </ul>
  482. </li>
  483. </ul>
  484. </div>
  485. <div class="sideToggler">
  486. <div id="ellipsis_Range.extend" class="ellipsis_description"><p>Changes the row and column points for the calling range for both the starting and ending points.</p>
  487. </div>
  488. <div class="description"><p>Changes the row and column points for the calling range for both the starting and ending points.</p>
  489. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A new row to extend to</p>
  490. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A new column to extend to</p>
  491. </td></tr></table>
  492. </div>
  493. </div>
  494. </div>
  495. </div>
  496. </article>
  497. <article id="Range.fromPoints" data-title="Range.fromPoints (class method)" class="article">
  498. <div class="section method">
  499. <div class="memberContent">
  500. <div class="title"><i id="Range.fromPoints" class="methodToggle methodClicker inactive icon-caret-right"></i>
  501. <ul class="signatures">
  502. <li class="signature">
  503. <ul>
  504. <li class="signature-call"><span id="Range.fromPoints" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">fromPoints</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> start, <a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> end</span>)
  505. <li class="signature-returns">
  506. <ul class="argument-types">
  507. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  508. </ul>
  509. </li></li>
  510. </ul>
  511. <ul class="metaInfo">
  512. </ul>
  513. </li>
  514. </ul>
  515. </div>
  516. <div class="sideToggler">
  517. <div id="ellipsis_Range.fromPoints" class="ellipsis_description"><p>Creates and returns a new <code>Range</code> based on the row and column of the given parameters.</p>
  518. </div>
  519. <div class="description"><p>Creates and returns a new <code>Range</code> based on the row and column of the given parameters.</p>
  520. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">start</td><td class="argType" "><a href="range.html" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription "><p>Required. A starting point to use</p>
  521. </td></tr><tr class="argumentRow "><td class="argName ">end</td><td class="argType" "><a href="range.html" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription "><p>Required. An ending point to use</p>
  522. </td></tr></table>
  523. </div>
  524. </div>
  525. </div>
  526. </div>
  527. </article>
  528. <article id="Range.inside" data-title="Range.inside (class method)" class="article">
  529. <div class="section method">
  530. <div class="memberContent">
  531. <div class="title"><i id="Range.inside" class="methodToggle methodClicker inactive icon-caret-right"></i>
  532. <ul class="signatures">
  533. <li class="signature">
  534. <ul>
  535. <li class="signature-call"><span id="Range.inside" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">inside</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  536. <li class="signature-returns">
  537. <ul class="argument-types">
  538. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  539. </ul>
  540. </li></li>
  541. </ul>
  542. <ul class="metaInfo">
  543. </ul>
  544. </li>
  545. </ul>
  546. </div>
  547. <div class="sideToggler">
  548. <div id="ellipsis_Range.inside" class="ellipsis_description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range.</p>
  549. </div>
  550. <div class="description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range.</p>
  551. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  552. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  553. </td></tr></table>
  554. </div>
  555. </div>
  556. </div>
  557. </div>
  558. </article>
  559. <article id="Range.insideEnd" data-title="Range.insideEnd (class method)" class="article">
  560. <div class="section method">
  561. <div class="memberContent">
  562. <div class="title"><i id="Range.insideEnd" class="methodToggle methodClicker inactive icon-caret-right"></i>
  563. <ul class="signatures">
  564. <li class="signature">
  565. <ul>
  566. <li class="signature-call"><span id="Range.insideEnd" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">insideEnd</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  567. <li class="signature-returns">
  568. <ul class="argument-types">
  569. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  570. </ul>
  571. </li></li>
  572. </ul>
  573. <ul class="metaInfo">
  574. </ul>
  575. </li>
  576. </ul>
  577. </div>
  578. <div class="sideToggler">
  579. <div id="ellipsis_Range.insideEnd" class="ellipsis_description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range&#39;s ending points.</p>
  580. </div>
  581. <div class="description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range&#39;s ending points.</p>
  582. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  583. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  584. </td></tr></table>
  585. </div>
  586. </div>
  587. </div>
  588. </div>
  589. </article>
  590. <article id="Range.insideStart" data-title="Range.insideStart (class method)" class="article">
  591. <div class="section method">
  592. <div class="memberContent">
  593. <div class="title"><i id="Range.insideStart" class="methodToggle methodClicker inactive icon-caret-right"></i>
  594. <ul class="signatures">
  595. <li class="signature">
  596. <ul>
  597. <li class="signature-call"><span id="Range.insideStart" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">insideStart</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  598. <li class="signature-returns">
  599. <ul class="argument-types">
  600. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  601. </ul>
  602. </li></li>
  603. </ul>
  604. <ul class="metaInfo">
  605. </ul>
  606. </li>
  607. </ul>
  608. </div>
  609. <div class="sideToggler">
  610. <div id="ellipsis_Range.insideStart" class="ellipsis_description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range&#39;s starting points.</p>
  611. </div>
  612. <div class="description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range&#39;s starting points.</p>
  613. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  614. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  615. </td></tr></table>
  616. </div>
  617. </div>
  618. </div>
  619. </div>
  620. </article>
  621. <article id="Range.intersects" data-title="Range.intersects (class method)" class="article">
  622. <div class="section method">
  623. <div class="memberContent">
  624. <div class="title"><i id="Range.intersects" class="methodToggle methodClicker inactive icon-caret-right"></i>
  625. <ul class="signatures">
  626. <li class="signature">
  627. <ul>
  628. <li class="signature-call"><span id="Range.intersects" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">intersects</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)
  629. <li class="signature-returns">
  630. <ul class="argument-types">
  631. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  632. </ul>
  633. </li></li>
  634. </ul>
  635. <ul class="metaInfo">
  636. </ul>
  637. </li>
  638. </ul>
  639. </div>
  640. <div class="sideToggler">
  641. <div id="ellipsis_Range.intersects" class="ellipsis_description"><p>Returns <code>true</code> if passed in <code>range</code> intersects with the one calling this method.</p>
  642. </div>
  643. <div class="description"><p>Returns <code>true</code> if passed in <code>range</code> intersects with the one calling this method.</p>
  644. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">range</td><td class="argType" "><a href="range.html" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription "><p>Required. A range to compare with</p>
  645. </td></tr></table>
  646. </div>
  647. </div>
  648. </div>
  649. </div>
  650. </article>
  651. <article id="Range.isEmpty" data-title="Range.isEmpty (class method)" class="article">
  652. <div class="section method">
  653. <div class="memberContent">
  654. <div class="title"><i id="Range.isEmpty" class="methodToggle methodClicker inactive icon-caret-right"></i>
  655. <ul class="signatures">
  656. <li class="signature">
  657. <ul>
  658. <li class="signature-call"><span id="Range.isEmpty" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">isEmpty</span></span><span class="emptyArgumentList">()</span></li>
  659. </ul>
  660. <ul class="metaInfo">
  661. <li><span class="label undocumented">Undocumented</span></li>
  662. </ul>
  663. </li>
  664. </ul>
  665. </div>
  666. <div class="sideToggler">
  667. <div id="ellipsis_Range.isEmpty" class="ellipsis_description">
  668. </div>
  669. <div class="description">
  670. </div>
  671. </div>
  672. </div>
  673. </div>
  674. </article>
  675. <article id="Range.isEnd" data-title="Range.isEnd (class method)" class="article">
  676. <div class="section method">
  677. <div class="memberContent">
  678. <div class="title"><i id="Range.isEnd" class="methodToggle methodClicker inactive icon-caret-right"></i>
  679. <ul class="signatures">
  680. <li class="signature">
  681. <ul>
  682. <li class="signature-call"><span id="Range.isEnd" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">isEnd</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  683. <li class="signature-returns">
  684. <ul class="argument-types">
  685. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  686. </ul>
  687. </li></li>
  688. </ul>
  689. <ul class="metaInfo">
  690. </ul>
  691. </li>
  692. </ul>
  693. </div>
  694. <div class="sideToggler">
  695. <div id="ellipsis_Range.isEnd" class="ellipsis_description"><p>Returns <code>true</code> if the caller&#39;s ending row point is the same as <code>row</code>, and if the caller&#39;s ending column is the same as <code>column</code>.</p>
  696. </div>
  697. <div class="description"><p>Returns <code>true</code> if the caller&#39;s ending row point is the same as <code>row</code>, and if the caller&#39;s ending column is the same as <code>column</code>.</p>
  698. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  699. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  700. </td></tr></table>
  701. </div>
  702. </div>
  703. </div>
  704. </div>
  705. </article>
  706. <article id="Range.isEqual" data-title="Range.isEqual (class method)" class="article">
  707. <div class="section method">
  708. <div class="memberContent">
  709. <div class="title"><i id="Range.isEqual" class="methodToggle methodClicker inactive icon-caret-right"></i>
  710. <ul class="signatures">
  711. <li class="signature">
  712. <ul>
  713. <li class="signature-call"><span id="Range.isEqual" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">isEqual</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)
  714. <li class="signature-returns">
  715. <ul class="argument-types">
  716. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  717. </ul>
  718. </li></li>
  719. </ul>
  720. <ul class="metaInfo">
  721. </ul>
  722. </li>
  723. </ul>
  724. </div>
  725. <div class="sideToggler">
  726. <div id="ellipsis_Range.isEqual" class="ellipsis_description"><p>Returns <code>true</code> if and only if the starting row and column, and ending row and column, are equivalent to those given by <code>range</code>.</p>
  727. </div>
  728. <div class="description"><p>Returns <code>true</code> if and only if the starting row and column, and ending row and column, are equivalent to those given by <code>range</code>.</p>
  729. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">range</td><td class="argType" "><a href="range.html" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription "><p>Required. A range to check against</p>
  730. </td></tr></table>
  731. </div>
  732. </div>
  733. </div>
  734. </div>
  735. </article>
  736. <article id="Range.isMultiLine" data-title="Range.isMultiLine (class method)" class="article">
  737. <div class="section method">
  738. <div class="memberContent">
  739. <div class="title"><i id="Range.isMultiLine" class="methodToggle methodClicker inactive icon-caret-right"></i>
  740. <ul class="signatures">
  741. <li class="signature">
  742. <ul>
  743. <li class="signature-call"><span id="Range.isMultiLine" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">isMultiLine</span></span><span class="emptyArgumentList">()</span>
  744. <li class="signature-returns">
  745. <ul class="argument-types">
  746. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  747. </ul>
  748. </li></li>
  749. </ul>
  750. <ul class="metaInfo">
  751. </ul>
  752. </li>
  753. </ul>
  754. </div>
  755. <div class="sideToggler">
  756. <div id="ellipsis_Range.isMultiLine" class="ellipsis_description"><p>Returns <code>true</code> if the range spans across multiple lines.</p>
  757. </div>
  758. <div class="description"><p>Returns <code>true</code> if the range spans across multiple lines.</p>
  759. </div>
  760. </div>
  761. </div>
  762. </div>
  763. </article>
  764. <article id="Range.isStart" data-title="Range.isStart (class method)" class="article">
  765. <div class="section method">
  766. <div class="memberContent">
  767. <div class="title"><i id="Range.isStart" class="methodToggle methodClicker inactive icon-caret-right"></i>
  768. <ul class="signatures">
  769. <li class="signature">
  770. <ul>
  771. <li class="signature-call"><span id="Range.isStart" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">isStart</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)
  772. <li class="signature-returns">
  773. <ul class="argument-types">
  774. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Boolean" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li>
  775. </ul>
  776. </li></li>
  777. </ul>
  778. <ul class="metaInfo">
  779. </ul>
  780. </li>
  781. </ul>
  782. </div>
  783. <div class="sideToggler">
  784. <div id="ellipsis_Range.isStart" class="ellipsis_description"><p>Returns <code>true</code> if the caller&#39;s starting row point is the same as <code>row</code>, and if the caller&#39;s starting column is the same as <code>column</code>.</p>
  785. </div>
  786. <div class="description"><p>Returns <code>true</code> if the caller&#39;s starting row point is the same as <code>row</code>, and if the caller&#39;s starting column is the same as <code>column</code>.</p>
  787. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to compare with</p>
  788. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to compare with</p>
  789. </td></tr></table>
  790. </div>
  791. </div>
  792. </div>
  793. </div>
  794. </article>
  795. <article id="Range.setEnd" data-title="Range.setEnd (class method)" class="article">
  796. <div class="section method">
  797. <div class="memberContent">
  798. <div class="title"><i id="Range.setEnd" class="methodToggle methodClicker inactive icon-caret-right"></i>
  799. <ul class="signatures">
  800. <li class="signature">
  801. <ul>
  802. <li class="signature-call"><span id="Range.setEnd" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">setEnd</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)</li>
  803. </ul>
  804. <ul class="metaInfo">
  805. </ul>
  806. </li>
  807. </ul>
  808. </div>
  809. <div class="sideToggler">
  810. <div id="ellipsis_Range.setEnd" class="ellipsis_description"><p>Sets the starting row and column for the range.</p>
  811. </div>
  812. <div class="description"><p>Sets the starting row and column for the range.</p>
  813. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to set</p>
  814. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to set</p>
  815. </td></tr></table>
  816. </div>
  817. </div>
  818. </div>
  819. </div>
  820. </article>
  821. <article id="Range.setStart" data-title="Range.setStart (class method)" class="article">
  822. <div class="section method">
  823. <div class="memberContent">
  824. <div class="title"><i id="Range.setStart" class="methodToggle methodClicker inactive icon-caret-right"></i>
  825. <ul class="signatures">
  826. <li class="signature">
  827. <ul>
  828. <li class="signature-call"><span id="Range.setStart" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">setStart</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)</li>
  829. </ul>
  830. <ul class="metaInfo">
  831. </ul>
  832. </li>
  833. </ul>
  834. </div>
  835. <div class="sideToggler">
  836. <div id="ellipsis_Range.setStart" class="ellipsis_description"><p>Sets the starting row and column for the range.</p>
  837. </div>
  838. <div class="description"><p>Sets the starting row and column for the range.</p>
  839. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">row</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A row point to set</p>
  840. </td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Number" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription "><p>Required. A column point to set</p>
  841. </td></tr></table>
  842. </div>
  843. </div>
  844. </div>
  845. </div>
  846. </article>
  847. <article id="Range.toScreenRange" data-title="Range.toScreenRange (class method)" class="article">
  848. <div class="section method">
  849. <div class="memberContent">
  850. <div class="title"><i id="Range.toScreenRange" class="methodToggle methodClicker inactive icon-caret-right"></i>
  851. <ul class="signatures">
  852. <li class="signature">
  853. <ul>
  854. <li class="signature-call"><span id="Range.toScreenRange" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">toScreenRange</span></span>(<span class="sigArgList"><a href="edit_session.html" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)
  855. <li class="signature-returns">
  856. <ul class="argument-types">
  857. <li class="argument-type"><a href="range.html" class="returnType " title="Range (class)" data-id="Range">Range</a></li>
  858. </ul>
  859. </li></li>
  860. </ul>
  861. <ul class="metaInfo">
  862. </ul>
  863. </li>
  864. </ul>
  865. </div>
  866. <div class="sideToggler">
  867. <div id="ellipsis_Range.toScreenRange" class="ellipsis_description"><p>Given the current <code>Range</code>, this function converts those starting and ending points into screen positions, and then returns a new <code>Range</code> object.</p>
  868. </div>
  869. <div class="description"><p>Given the current <code>Range</code>, this function converts those starting and ending points into screen positions, and then returns a new <code>Range</code> object.</p>
  870. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">session</td><td class="argType" "><a href="edit_session.html" class="" title="EditSession (class)" data-id="EditSession">EditSession</a></td><td class="argDescription "><p>Required. The <code>EditSession</code> to retrieve coordinates from</p>
  871. </td></tr></table>
  872. </div>
  873. </div>
  874. </div>
  875. </div>
  876. </article>
  877. <article id="Range.toString" data-title="Range.toString (class method)" class="article">
  878. <div class="section method">
  879. <div class="memberContent">
  880. <div class="title"><i id="Range.toString" class="methodToggle methodClicker inactive icon-caret-right"></i>
  881. <ul class="signatures">
  882. <li class="signature">
  883. <ul>
  884. <li class="signature-call"><span id="Range.toString" class="member-name methodClicker"><span class="sigClassName">Range.</span><span class="sigMemberName">toString</span></span><span class="emptyArgumentList">()</span>
  885. <li class="signature-returns">
  886. <ul class="argument-types">
  887. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="returnType " title="String" data-id="String">String</a></li>
  888. </ul>
  889. </li></li>
  890. </ul>
  891. <ul class="metaInfo">
  892. </ul>
  893. </li>
  894. </ul>
  895. </div>
  896. <div class="sideToggler">
  897. <div id="ellipsis_Range.toString" class="ellipsis_description"><p>Returns a string containing the range&#39;s row and column information, given like this:</p>
  898. <pre><code> [<span class="operator"><span class="keyword">start</span>.row/<span class="keyword">start</span>.<span class="keyword">column</span>] -&gt; [<span class="keyword">end</span>.row/<span class="keyword">end</span>.<span class="keyword">column</span>]</code></pre>
  899. </div>
  900. <div class="description"><p>Returns a string containing the range&#39;s row and column information, given like this:</p>
  901. <pre><code> [<span class="operator"><span class="keyword">start</span>.row/<span class="keyword">start</span>.<span class="keyword">column</span>] -&gt; [<span class="keyword">end</span>.row/<span class="keyword">end</span>.<span class="keyword">column</span>]</code></pre>
  902. </div>
  903. </div>
  904. </div>
  905. </div>
  906. </article>
  907. </div>
  908. <script defer src="./resources/javascripts/ux.js"></script>
  909. <script src="./resources/javascripts/clicker.js"></script>
  910. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  911. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  912. <script defer src="./resources/javascripts/ga.js"></script>
  913. <div id="disqus_thread"></div>
  914. </div>