mirror of
https://github.com/AdaCore/ace.git
synced 2026-02-12 13:03:02 -08:00
67 lines
59 KiB
HTML
67 lines
59 KiB
HTML
<!DOCTYPE html><!--[if lt IE 7]> <html class="no-js ie6 oldie" lang="en"> <![endif]-->
|
|
<!--[if IE 7]> <html class="no-js ie7 oldie" lang="en"> <![endif]-->
|
|
<!--[if IE 8]> <html class="no-js ie8 oldie" lang="en"> <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]--><html xmlns="http://www.w3.org/1999/xhtml"><head><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"><title>Range - Ace API</title><meta name="generator" content="c9-doc-build"><meta name="description" content="Ace API documentation for the online code editor."><meta name="author" content="Garen J. Torikian"><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="stylesheet" href="./resources/csses/bootstrap.min.css"><link rel="stylesheet" href="./resources/csses/prettify.css"><link rel="stylesheet" href="./resources/csses/ace_api.css"><link href="./resources/images/favicon.ico" rel="icon" type="image/x-icon"><script src="./resources/javascripts/jquery.js"></script><script src="./resources/javascripts/clicker.js"></script><script src="./resources/javascripts/jquery.collapse.js"></script><script src="./resources/javascripts/jquery.cookie.js"></script><script src="./resources/javascripts/bootstrap-dropdown.js"></script><script src="./resources/javascripts/jquery-scrollspy.js"></script><script script src="./resources/javascripts/prettify-extension.js"></script></head><body><div class="navbar navbar-fixed-top"><div class="navbar-inner"><div id="topSection" class="container"><span class="brand"></span><ul class="nav topLinks"><li id="ace_site"><a href="../index.html">Ace</a></li><li id="ace_api" class="active"><a href="index.html">Ace API Reference</a></li></ul><form id="searchbox" action="" class="navbar-search pull-right"> <input name="query" type="text" placeholder="Search the API" title="Search across all the documentation" class="search-query span3"></form></div></div></div><div id="nonFooter"><div id="wrapper"><div class="content"><div class="row centerpiece"><div id="sidebarContainer" class="span3"><div id="sidebar"><div id="well"><h3>Ace Reference</h3><div class="swirl_divider"> </div><ul class="menu"><li><div class="menu-item"><a href="ace.html" class="menuLink namespace">Ace</a></div></li><li><div class="menu-item"><a href="anchor.html" class="menuLink namespace">Anchor</a></div></li><li><div class="menu-item"><a href="background_tokenizer.html" class="menuLink namespace">BackgroundTokenizer </a></div></li><li><div class="menu-item"><a href="document.html" class="menuLink namespace">Document </a></div></li><li><div class="menu-item"><a href="edit_session.html" class="menuLink namespace">EditSession </a></div></li><li><div class="menu-item"><a href="editor.html" class="menuLink namespace">Editor</a></div></li><li><div class="menu-item"><a href="range.html" class="menuLink namespace">Range</a></div></li><li><div class="menu-item"><a href="scrollbar.html" class="menuLink namespace">Scrollbar</a></div></li><li><div class="menu-item"><a href="search.html" class="menuLink namespace">Search </a></div></li><li><div class="menu-item"><a href="selection.html" class="menuLink namespace">Selection </a></div></li><li><div class="menu-item"><a href="token_iterator.html" class="menuLink namespace">TokenIterator</a></div></li><li><div class="menu-item"><a href="tokenizer.html" class="menuLink namespace">Tokenizer</a></div></li><li><div class="menu-item"><a href="undomanager.html" class="menuLink namespace">UndoManager</a></div></li><li><div class="menu-item"><a href="virtual_renderer.html" class="menuLink namespace">VirtualRenderer</a></div></li></ul></div></div></div><div id="mainContent" class="span9"><div id="documentation"><div class="classContent"><div class="membersBackground"></div><div class=" members pos0"><div class=" membersContent pos0"><h1 class="memberHeader"><span class="name">Range<span class="editInC9"><a href='http://c9.io/open/git/?url=git%3A%2F%2Fgithub.com%2Fajaxorg%2Face.git' title='Edit in Cloud9 IDE'>[edit]</a></span></span></h1><ul data-tabs="tabs" class="nav tabs pos0"><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Constructors (1)</span><b class="caret"></b></a><ul class="dropdown-menu"><li data-id="new Range" class="memberLink"><a href="#Range.new" class="" title="Range.new (constructor)" data-id="Range.new">new</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (25)</span><b class="caret"></b></a><ul class="dropdown-menu"><li data-id="Range.clipRows" class="memberLink"><a href="#Range.clipRows" class="" title="Range.clipRows (class method)" data-id="Range.clipRows">clipRows</a></li><li data-id="Range.clone" class="memberLink"><a href="#Range.clone" class="" title="Range.clone (class method)" data-id="Range.clone">clone</a></li><li data-id="Range.collapseRows" class="memberLink"><a href="#Range.collapseRows" class="" title="Range.collapseRows (class method)" data-id="Range.collapseRows">collapseRows</a></li><li data-id="Range.compare" class="memberLink"><a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">compare</a></li><li data-id="Range.compareEnd" class="memberLink"><a href="#Range.compareEnd" class="" title="Range.compareEnd (class method)" data-id="Range.compareEnd">compareEnd</a></li><li data-id="Range.compareInside" class="memberLink"><a href="#Range.compareInside" class="" title="Range.compareInside (class method)" data-id="Range.compareInside">compareInside</a></li><li data-id="Range.comparePoint" class="memberLink"><a href="#Range.comparePoint" class="" title="Range.comparePoint (class method)" data-id="Range.comparePoint">comparePoint</a></li><li data-id="Range.compareRange" class="memberLink"><a href="#Range.compareRange" class="" title="Range.compareRange (class method)" data-id="Range.compareRange">compareRange</a></li><li data-id="Range.compareStart" class="memberLink"><a href="#Range.compareStart" class="" title="Range.compareStart (class method)" data-id="Range.compareStart">compareStart</a></li><li data-id="Range.contains" class="memberLink"><a href="#Range.contains" class="" title="Range.contains (class method)" data-id="Range.contains">contains</a></li><li data-id="Range.containsRange" class="memberLink"><a href="#Range.containsRange" class="" title="Range.containsRange (class method)" data-id="Range.containsRange">containsRange</a></li><li data-id="Range.extend" class="memberLink"><a href="#Range.extend" class="" title="Range.extend (class method)" data-id="Range.extend">extend</a></li><li data-id="Range.fromPoints" class="memberLink"><a href="#Range.fromPoints" class="" title="Range.fromPoints (class method)" data-id="Range.fromPoints">fromPoints</a></li><li data-id="Range.inside" class="memberLink"><a href="#Range.inside" class="" title="Range.inside (class method)" data-id="Range.inside">inside</a></li><li data-id="Range.insideEnd" class="memberLink"><a href="#Range.insideEnd" class="" title="Range.insideEnd (class method)" data-id="Range.insideEnd">insideEnd</a></li><li data-id="Range.insideStart" class="memberLink"><a href="#Range.insideStart" class="" title="Range.insideStart (class method)" data-id="Range.insideStart">insideStart</a></li><li data-id="Range.intersects" class="memberLink"><a href="#Range.intersects" class="" title="Range.intersects (class method)" data-id="Range.intersects">intersects</a></li><li data-id="Range.isEnd" class="memberLink"><a href="#Range.isEnd" class="" title="Range.isEnd (class method)" data-id="Range.isEnd">isEnd</a></li><li data-id="Range.isEqual" class="memberLink"><a href="#Range.isEqual" class="" title="Range.isEqual (class method)" data-id="Range.isEqual">isEqual</a></li><li data-id="Range.isMultiLine" class="memberLink"><a href="#Range.isMultiLine" class="" title="Range.isMultiLine (class method)" data-id="Range.isMultiLine">isMultiLine</a></li><li data-id="Range.isStart" class="memberLink"><a href="#Range.isStart" class="" title="Range.isStart (class method)" data-id="Range.isStart">isStart</a></li><li data-id="Range.setEnd" class="memberLink"><a href="#Range.setEnd" class="" title="Range.setEnd (class method)" data-id="Range.setEnd">setEnd</a></li><li data-id="Range.setStart" class="memberLink"><a href="#Range.setStart" class="" title="Range.setStart (class method)" data-id="Range.setStart">setStart</a></li><li data-id="Range.toScreenRange" class="memberLink"><a href="#Range.toScreenRange" class="" title="Range.toScreenRange (class method)" data-id="Range.toScreenRange">toScreenRange</a></li><li data-id="Range.toString" class="memberLink"><a href="#Range.toString" class="" title="Range.toString (class method)" data-id="Range.toString">toString</a></li></ul></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li><li data-dropdown="dropdown" class="dropdown"></li></ul></div></div><article id="Range" data-title="Range (class)" class="article"><div class="section description"><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>
|
|
</div></div></article><h3 class="sectionHeader">Constructors</h3><article id="Range.new" data-title="Range.new (constructor)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><li class="signature-call"><span class="constructorIdentifier">new </span><span id="Range.new" class="member-name methodClicker">Range</span>(<span class="sigArgList"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> startRow, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> startColumn, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> endRow, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> endColumn</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.new" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Creates a new <code>Range</code> object with the given starting and ending row and column points.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. The starting row</td></tr><tr class="argumentRow "><td class="argName ">startColumn</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. The starting column</td></tr><tr class="argumentRow "><td class="argName ">endRow</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. The ending row</td></tr><tr class="argumentRow "><td class="argName ">endColumn</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. The ending column</td></tr></table></div></div></div></div></article><h3 class="sectionHeader">Methods</h3><article id="Range.clipRows" data-title="Range.clipRows (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> firstRow, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> lastRow</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#Range" class="returnType " title="Range (class)" data-id="Range">Range</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.clipRows" class="methodToggle methodClicker inactive"> </h3><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>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. The starting row</td></tr><tr class="argumentRow "><td class="argName ">lastRow</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. The ending row</td></tr></table></div></div></div></div></article><article id="Range.clone" data-title="Range.clone (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#Range" class="returnType " title="Range (class)" data-id="Range">Range</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.clone" class="ellipsis_description"><p>Returns a duplicate of the calling range.</p>
|
|
</div><h3 id="Range.clone" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns a duplicate of the calling range.</p>
|
|
</div></div></div></div></article><article id="Range.collapseRows" data-title="Range.collapseRows (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#Range" class="returnType " title="Range (class)" data-id="Range">Range</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.collapseRows" class="methodToggle methodClicker inactive"> </h3><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>
|
|
</div></div></div></div></article><article id="Range.compare" data-title="Range.compare (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.compare" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.compareEnd" data-title="Range.compareEnd (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.compareEnd" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.compareInside" data-title="Range.compareInside (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.compareInside" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.comparePoint" data-title="Range.comparePoint (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> p</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label related-to">Related to <a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">Range.compare</a> </span></li></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.comparePoint" class="methodToggle methodClicker inactive"> </h3><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>
|
|
<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" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription ">Required. A point to compare with</td></tr></table></div></div></div></div></article><article id="Range.compareRange" data-title="Range.compareRange (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label related-to">Related to <a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">Range.compare</a> </span></li></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.compareRange" class="ellipsis_description"><p>Compares <code>this</code> range (A) with another range (B).</p>
|
|
</div><h3 id="Range.compareRange" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Compares <code>this</code> range (A) with another range (B).</p>
|
|
<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" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription ">Required. A range to compare with</td></tr></table></div></div></div></div></article><article id="Range.compareStart" data-title="Range.compareStart (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="returnType " title="Number" data-id="Number">Number</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.compareStart" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.contains" data-title="Range.contains (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label related-to">Related to <a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">Range.compare</a> </span></li></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.contains" class="methodToggle methodClicker inactive"> </h3><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>
|
|
<p> this.start.row <= row <= this.end.row &&
|
|
this.start.column <= column <= this.end.column</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row to check for</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column to check for</td></tr></table></div></div></div></div></article><article id="Range.containsRange" data-title="Range.containsRange (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label related-to">Related to <a href="#Range.comparePoint" class="" title="Range.comparePoint (class method)" data-id="Range.comparePoint">Range.comparePoint</a> </span></li></ul></li></ul></div><div class="sideToggler"><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's range.</p>
|
|
</div><h3 id="Range.containsRange" class="methodToggle methodClicker inactive"> </h3><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's range.</p>
|
|
<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" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription ">Required. A range to compare with</td></tr></table></div></div></div></div></article><article id="Range.extend" data-title="Range.extend (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#Range" class="returnType " title="Range (class)" data-id="Range">Range</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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. This method returns that range with a new row.</p>
|
|
</div><h3 id="Range.extend" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A new row to extend to</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A new column to extend to</td></tr></table></div></div></div></div></article><article id="Range.fromPoints" data-title="Range.fromPoints (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> start, <a href="#Range" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> end</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#Range" class="returnType " title="Range (class)" data-id="Range">Range</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.fromPoints" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Creates and returns a new <code>Range</code> based on the row and column of the given parameters.</p>
|
|
<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" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription ">Required. A starting point to use</td></tr><tr class="argumentRow "><td class="argName ">end</td><td class="argType" "><a href="#Range" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription ">Required. An ending point to use</td></tr></table></div></div></div></div></article><article id="Range.inside" data-title="Range.inside (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label related-to">Related to <a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">Range.compare</a> </span></li></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.inside" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.insideEnd" data-title="Range.insideEnd (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label related-to">Related to <a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">Range.compare</a> </span></li></ul></li></ul></div><div class="sideToggler"><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's ending points.</p>
|
|
</div><h3 id="Range.insideEnd" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range's ending points.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.insideStart" data-title="Range.insideStart (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"><li><span class="label related-to">Related to <a href="#Range.compare" class="" title="Range.compare (class method)" data-id="Range.compare">Range.compare</a> </span></li></ul></li></ul></div><div class="sideToggler"><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's starting points.</p>
|
|
</div><h3 id="Range.insideStart" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range's starting points.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.intersects" data-title="Range.intersects (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.intersects" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns <code>true</code> if passed in <code>range</code> intersects with the one calling this method.</p>
|
|
<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" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription ">Required. A range to compare with</td></tr></table></div></div></div></div></article><article id="Range.isEnd" data-title="Range.isEnd (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.isEnd" class="ellipsis_description"><p>Returns <code>true</code> if the caller's ending row point is the same as <code>row</code>, and if the caller's ending column is the same as <code>column</code>.</p>
|
|
</div><h3 id="Range.isEnd" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns <code>true</code> if the caller's ending row point is the same as <code>row</code>, and if the caller's ending column is the same as <code>column</code>.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.isEqual" data-title="Range.isEqual (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.isEqual" class="ellipsis_description"><p>Returns <code>true</code> if and only if the starting row and column, and ending tow and column, are equivalent to those given by <code>range</code>.</p>
|
|
</div><h3 id="Range.isEqual" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns <code>true</code> if and only if the starting row and column, and ending tow and column, are equivalent to those given by <code>range</code>.</p>
|
|
<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" class="" title="Range (class)" data-id="Range">Range</a></td><td class="argDescription ">Required. A range to check against</td></tr></table></div></div></div></div></article><article id="Range.isMultiLine" data-title="Range.isMultiLine (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.isMultiLine" class="ellipsis_description"><p>Returns true if the range spans across multiple lines.</p>
|
|
</div><h3 id="Range.isMultiLine" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns true if the range spans across multiple lines.</p>
|
|
</div></div></div></div></article><article id="Range.isStart" data-title="Range.isStart (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/Boolean.html" class="returnType " title="Boolean" data-id="Boolean">Boolean</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.isStart" class="ellipsis_description"><p>Returns <code>true</code> if the caller's starting row point is the same as <code>row</code>, and if the caller's starting column is the same as <code>column</code>.</p>
|
|
</div><h3 id="Range.isStart" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns <code>true</code> if the caller's starting row point is the same as <code>row</code>, and if the caller's starting column is the same as <code>column</code>.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to compare with</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to compare with</td></tr></table></div></div></div></div></article><article id="Range.setEnd" data-title="Range.setEnd (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.setEnd" class="ellipsis_description"><p>Sets the starting row and column for the range.</p>
|
|
</div><h3 id="Range.setEnd" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Sets the starting row and column for the range.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to set</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to set</td></tr></table></div></div></div></div></article><article id="Range.setStart" data-title="Range.setStart (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> row, <a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="argument methodClicker" title="Number" data-id="Number">Number</a> column</span>)</li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.setStart" class="ellipsis_description"><p>Sets the starting row and column for the range.</p>
|
|
</div><h3 id="Range.setStart" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Sets the starting row and column for the range.</p>
|
|
<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="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A row point to set</td></tr><tr class="argumentRow "><td class="argName ">column</td><td class="argType" "><a href="http://www.nodemanual.org/latest/js_doc/Number.html" class="" title="Number" data-id="Number">Number</a></td><td class="argDescription ">Required. A column point to set</td></tr></table></div></div></div></div></article><article id="Range.toScreenRange" data-title="Range.toScreenRange (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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#EditSession" class="argument methodClicker" title="EditSession (class)" data-id="EditSession">EditSession</a> session</span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="#Range" class="returnType " title="Range (class)" data-id="Range">Range</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><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>
|
|
</div><h3 id="Range.toScreenRange" class="methodToggle methodClicker inactive"> </h3><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>
|
|
<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#EditSession" class="" title="EditSession (class)" data-id="EditSession">EditSession</a></td><td class="argDescription ">Required. The <code>EditSession</code> to retrieve coordinates from</td></tr></table></div></div></div></div></article><article id="Range.toString" data-title="Range.toString (class method)" class="article"><div class="section method"><div class="memberContent"><div class="title"><ul class="signatures"><li class="signature"><ul><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="sigArgList"></span>)<li class="signature-returns"><ul class="argument-types"><li class="argument-type"><a href="http://www.nodemanual.org/latest/js_doc/String.html" class="returnType " title="String" data-id="String">String</a></li></ul></li></li></ul><ul class="metaInfo"></ul></li></ul></div><div class="sideToggler"><div id="ellipsis_Range.toString" class="ellipsis_description"><p>Returns a string containing the range's row and column information, given like this:</p>
|
|
</div><h3 id="Range.toString" class="methodToggle methodClicker inactive"> </h3><div class="description"><p>Returns a string containing the range's row and column information, given like this:</p>
|
|
<p> [start.row/start.column] -> [end.row/end.column]</p>
|
|
</div></div></div></div></article></div></div><div id="disqus_thread"></div></div></div></div></div><div class="push"></div></div><div id="footer"><div class="footerInner"><div class="footer-text pull-right"> <p><a href="http://www.c9.io">About Cloud9</a> | Ace & Cloud9 IDE are © <a href="http://ajax.org">Ajax.org</a> 2012</p></div></div></div><!-- scripts concatenated and minified via ant build script--><script defer src="./resources/javascripts/plugins.js"></script>
|
|
<script defer src="./resources/javascripts/prettify.js"></script>
|
|
<script defer src="./resources/javascripts/prettify-extension.js"></script>
|
|
<script defer src="./resources/javascripts/ux.js"></script>
|
|
<script defer src="./resources/javascripts/disqus-ext.js"></script>
|
|
<script defer src="./resources/javascripts/ga.js"></script><!-- end scripts--><!--[if lt IE 7]><script src="//ajax.googleapis.com/ajax/libs/chrome-frame/1.0.3/CFInstall.min.js"></script><script>window.attachEvent('onload',function(){CFInstall.check({mode:'overlay'})})
|
|
|
|
</script><![endif]--></body></html> |