document.html 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927
  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">Document</span>
  7. </h1>
  8. <ul data-tabs="tabs" class="nav tabs pos0">
  9. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Events (1)</span><b class="caret"></b></a>
  10. <ul class="dropdown-menu">
  11. <li id="dropdown_Document.event.change" data-id="Document.event.change" class="memberLink"><a href="#Document.event.change" class="" title="Document.event.change (event)" data-id="Document.event.change">change</a>
  12. </li>
  13. </ul>
  14. </li>
  15. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Constructors (1)</span><b class="caret"></b></a>
  16. <ul class="dropdown-menu">
  17. <li id="dropdown_Document.new" data-id="Document.new" class="memberLink"><a href="#Document.new" class="" title="Document.new (constructor)" data-id="Document.new">new</a>
  18. </li>
  19. </ul>
  20. </li>
  21. <li data-dropdown="dropdown" class="dropdown"><a href="#" data-toggle="dropdown" class="dropdown-toggle"><span>Functions (26)</span><b class="caret"></b></a>
  22. <ul class="dropdown-menu">
  23. <li id="dropdown_Document.applyDeltas" data-id="Document.applyDeltas" class="memberLink"><a href="#Document.applyDeltas" class="" title="Document.applyDeltas (class method)" data-id="Document.applyDeltas">applyDeltas</a>
  24. </li>
  25. <li id="dropdown_Document.createAnchor" data-id="Document.createAnchor" class="memberLink"><a href="#Document.createAnchor" class="" title="Document.createAnchor (class method)" data-id="Document.createAnchor">createAnchor</a>
  26. </li>
  27. <li id="dropdown_Document.getAllLines" data-id="Document.getAllLines" class="memberLink"><a href="#Document.getAllLines" class="" title="Document.getAllLines (class method)" data-id="Document.getAllLines">getAllLines</a>
  28. </li>
  29. <li id="dropdown_Document.getLength" data-id="Document.getLength" class="memberLink"><a href="#Document.getLength" class="" title="Document.getLength (class method)" data-id="Document.getLength">getLength</a>
  30. </li>
  31. <li id="dropdown_Document.getLine" data-id="Document.getLine" class="memberLink"><a href="#Document.getLine" class="" title="Document.getLine (class method)" data-id="Document.getLine">getLine</a>
  32. </li>
  33. <li id="dropdown_Document.getLines" data-id="Document.getLines" class="memberLink"><a href="#Document.getLines" class="" title="Document.getLines (class method)" data-id="Document.getLines">getLines</a>
  34. </li>
  35. <li id="dropdown_Document.getNewLineCharacter" data-id="Document.getNewLineCharacter" class="memberLink"><a href="#Document.getNewLineCharacter" class="" title="Document.getNewLineCharacter (class method)" data-id="Document.getNewLineCharacter">getNewLineCharacter</a>
  36. </li>
  37. <li id="dropdown_Document.getNewLineMode" data-id="Document.getNewLineMode" class="memberLink"><a href="#Document.getNewLineMode" class="" title="Document.getNewLineMode (class method)" data-id="Document.getNewLineMode">getNewLineMode</a>
  38. </li>
  39. <li id="dropdown_Document.getTextRange" data-id="Document.getTextRange" class="memberLink"><a href="#Document.getTextRange" class="" title="Document.getTextRange (class method)" data-id="Document.getTextRange">getTextRange</a>
  40. </li>
  41. <li id="dropdown_Document.getValue" data-id="Document.getValue" class="memberLink"><a href="#Document.getValue" class="" title="Document.getValue (class method)" data-id="Document.getValue">getValue</a>
  42. </li>
  43. <li id="dropdown_Document.indexToPosition" data-id="Document.indexToPosition" class="memberLink"><a href="#Document.indexToPosition" class="" title="Document.indexToPosition (class method)" data-id="Document.indexToPosition">indexToPosition</a>
  44. </li>
  45. <li id="dropdown_Document.insert" data-id="Document.insert" class="memberLink"><a href="#Document.insert" class="" title="Document.insert (class method)" data-id="Document.insert">insert</a>
  46. </li>
  47. <li id="dropdown_Document.insertInLine" data-id="Document.insertInLine" class="memberLink"><a href="#Document.insertInLine" class="" title="Document.insertInLine (class method)" data-id="Document.insertInLine">insertInLine</a>
  48. </li>
  49. <li id="dropdown_Document.insertLines" data-id="Document.insertLines" class="memberLink"><a href="#Document.insertLines" class="" title="Document.insertLines (class method)" data-id="Document.insertLines">insertLines</a>
  50. </li>
  51. <li id="dropdown_Document.insertNewLine" data-id="Document.insertNewLine" class="memberLink"><a href="#Document.insertNewLine" class="" title="Document.insertNewLine (class method)" data-id="Document.insertNewLine">insertNewLine</a>
  52. </li>
  53. <li id="dropdown_Document.isNewLine" data-id="Document.isNewLine" class="memberLink"><a href="#Document.isNewLine" class="" title="Document.isNewLine (class method)" data-id="Document.isNewLine">isNewLine</a>
  54. </li>
  55. <li id="dropdown_Document.positionToIndex" data-id="Document.positionToIndex" class="memberLink"><a href="#Document.positionToIndex" class="" title="Document.positionToIndex (class method)" data-id="Document.positionToIndex">positionToIndex</a>
  56. </li>
  57. <li id="dropdown_Document.remove" data-id="Document.remove" class="memberLink"><a href="#Document.remove" class="" title="Document.remove (class method)" data-id="Document.remove">remove</a>
  58. </li>
  59. <li id="dropdown_Document.removeInLine" data-id="Document.removeInLine" class="memberLink"><a href="#Document.removeInLine" class="" title="Document.removeInLine (class method)" data-id="Document.removeInLine">removeInLine</a>
  60. </li>
  61. <li id="dropdown_Document.removeLines" data-id="Document.removeLines" class="memberLink"><a href="#Document.removeLines" class="" title="Document.removeLines (class method)" data-id="Document.removeLines">removeLines</a>
  62. </li>
  63. <li id="dropdown_Document.removeNewLine" data-id="Document.removeNewLine" class="memberLink"><a href="#Document.removeNewLine" class="" title="Document.removeNewLine (class method)" data-id="Document.removeNewLine">removeNewLine</a>
  64. </li>
  65. <li id="dropdown_Document.replace" data-id="Document.replace" class="memberLink"><a href="#Document.replace" class="" title="Document.replace (class method)" data-id="Document.replace">replace</a>
  66. </li>
  67. <li id="dropdown_Document.revertDeltas" data-id="Document.revertDeltas" class="memberLink"><a href="#Document.revertDeltas" class="" title="Document.revertDeltas (class method)" data-id="Document.revertDeltas">revertDeltas</a>
  68. </li>
  69. <li id="dropdown_Document.setNewLineMode" data-id="Document.setNewLineMode" class="memberLink"><a href="#Document.setNewLineMode" class="" title="Document.setNewLineMode (class method)" data-id="Document.setNewLineMode">setNewLineMode</a>
  70. </li>
  71. <li id="dropdown_Document.setValue" data-id="Document.setValue" class="memberLink"><a href="#Document.setValue" class="" title="Document.setValue (class method)" data-id="Document.setValue">setValue</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="Document" data-title="Document (class)" class="article">
  95. <div class="section description">
  96. <div class="memberContent"><p>Contains the text of the document. Document can be attached to several <a href="edit_session.html" class="link-short" title="EditSession (class)" data-id="EditSession"><code>EditSession</code></a>s. </p>
  97. <p>At its core, <code>Document</code>s are just an array of strings, with each row in the document matching up to the array index.</p>
  98. </div>
  99. </div>
  100. </article>
  101. <h3 class="sectionHeader">Constructors</h3>
  102. <article id="Document.new" data-title="Document.new (constructor)" class="article">
  103. <div class="section method">
  104. <div class="memberContent">
  105. <div class="title"><i id="Document.new" class="methodToggle methodClicker inactive icon-caret-right"></i>
  106. <ul class="signatures">
  107. <li class="signature">
  108. <ul>
  109. <li class="signature-call"><span class="constructorIdentifier">new </span><span id="Document.new" class="member-name methodClicker">Document</span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array" class="argument methodClicker" title="Array" data-id="Array">Array</a> text</span>)</li>
  110. </ul>
  111. <ul class="metaInfo">
  112. </ul>
  113. </li>
  114. </ul>
  115. </div>
  116. <div class="sideToggler">
  117. <div id="ellipsis_Document.new" class="ellipsis_description"><p>Creates a new <code>Document</code>. If <code>text</code> is included, the <code>Document</code> contains those strings; otherwise, it&#39;s empty.</p>
  118. </div>
  119. <div class="description"><p>Creates a new <code>Document</code>. If <code>text</code> is included, the <code>Document</code> contains those strings; otherwise, it&#39;s empty.</p>
  120. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">text</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a> | <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array" class="" title="Array" data-id="Array">Array</a></td><td class="argDescription "><p>Required. The starting text</p>
  121. </td></tr></table>
  122. </div>
  123. </div>
  124. </div>
  125. </div>
  126. </article>
  127. <h3 class="sectionHeader">Events</h3>
  128. <article id="Document.event.change" data-title="Document.event.change (event)" class="article">
  129. <div class="section method">
  130. <div class="memberContent">
  131. <div class="title"><i id="Document.event.change" class="methodToggle methodClicker inactive icon-caret-right"></i>
  132. <ul class="signatures">
  133. <li class="signature">
  134. <ul>
  135. <li class="signature-call"><span class="eventObjName">Document</span><span class="eventListenerStart">.on("</span><span id="Document.event.change" class="member-name eventMember methodClicker">change</span><span class="eventListenerClose">", </span><span class="eventFunctionOpen">function(</span><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> e<span class="eventFunctionClose">))</span></li>
  136. </ul>
  137. <ul class="metaInfo">
  138. </ul>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="sideToggler">
  143. <div id="ellipsis_Document.event.change" class="ellipsis_description"><p>Fires whenever the document changes.</p>
  144. </div>
  145. <div class="description"><p>Fires whenever the document changes.</p>
  146. <p>Several methods trigger different <code>&quot;change&quot;</code> events. Below is a list of each action type, followed by each property that&#39;s also available:</p>
  147. <ul>
  148. <li><code>&quot;insertLines&quot;</code> (emitted by <a href="#Document.insertLines" class="link-short" title="Document.insertLines (class method)" data-id="Document.insertLines"><code>Document.insertLines()</code></a>)</li>
  149. <li><code>range</code>: the <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> of the change within the document</li>
  150. <li><code>lines</code>: the lines in the document that are changing</li>
  151. <li><code>&quot;insertText&quot;</code> (emitted by <a href="#Document.insertNewLine" class="link-short" title="Document.insertNewLine (class method)" data-id="Document.insertNewLine"><code>Document.insertNewLine()</code></a>)</li>
  152. <li><code>range</code>: the <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> of the change within the document</li>
  153. <li><code>text</code>: the text that&#39;s being added</li>
  154. <li><code>&quot;removeLines&quot;</code> (emitted by <a href="#Document.insertLines" class="link-short" title="Document.insertLines (class method)" data-id="Document.insertLines"><code>Document.insertLines()</code></a>)</li>
  155. <li><code>range</code>: the <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> of the change within the document</li>
  156. <li><code>lines</code>: the lines in the document that were removed</li>
  157. <li><code>nl</code>: the new line character (as defined by <a href="#Document.getNewLineCharacter" class="link-short" title="Document.getNewLineCharacter (class method)" data-id="Document.getNewLineCharacter"><code>Document.getNewLineCharacter()</code></a>)</li>
  158. <li><code>&quot;removeText&quot;</code> (emitted by <a href="#Document.removeInLine" class="link-short" title="Document.removeInLine (class method)" data-id="Document.removeInLine"><code>Document.removeInLine()</code></a> and <a href="#Document.removeNewLine" class="link-short" title="Document.removeNewLine (class method)" data-id="Document.removeNewLine"><code>Document.removeNewLine()</code></a>)</li>
  159. <li><code>range</code>: the <a href="range.html" class="link-short" title="Range (class)" data-id="Range"><code>Range</code></a> of the change within the document</li>
  160. <li><code>text</code>: the text that&#39;s being removed</li>
  161. </ul>
  162. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">e</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. Contains at least one property called <code>&quot;action&quot;</code>. <code>&quot;action&quot;</code> indicates the action that triggered the change. Each action also has a set of additional properties.</p>
  163. </td></tr></table>
  164. </div>
  165. </div>
  166. </div>
  167. </div>
  168. </article>
  169. <h3 class="sectionHeader">Methods</h3>
  170. <article id="Document.applyDeltas" data-title="Document.applyDeltas (class method)" class="article">
  171. <div class="section method">
  172. <div class="memberContent">
  173. <div class="title"><i id="Document.applyDeltas" class="methodToggle methodClicker inactive icon-caret-right"></i>
  174. <ul class="signatures">
  175. <li class="signature">
  176. <ul>
  177. <li class="signature-call"><span id="Document.applyDeltas" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">applyDeltas</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> deltas</span>)</li>
  178. </ul>
  179. <ul class="metaInfo">
  180. </ul>
  181. </li>
  182. </ul>
  183. </div>
  184. <div class="sideToggler">
  185. <div id="ellipsis_Document.applyDeltas" class="ellipsis_description"><p>Applies all the changes previously accumulated. These can be either <code>&#39;includeText&#39;</code>, <code>&#39;insertLines&#39;</code>, <code>&#39;removeText&#39;</code>, and <code>&#39;removeLines&#39;</code>.</p>
  186. </div>
  187. <div class="description"><p>Applies all the changes previously accumulated. These can be either <code>&#39;includeText&#39;</code>, <code>&#39;insertLines&#39;</code>, <code>&#39;removeText&#39;</code>, and <code>&#39;removeLines&#39;</code>.</p>
  188. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">deltas</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. </p>
  189. </td></tr></table>
  190. </div>
  191. </div>
  192. </div>
  193. </div>
  194. </article>
  195. <article id="Document.createAnchor" data-title="Document.createAnchor (class method)" class="article">
  196. <div class="section method">
  197. <div class="memberContent">
  198. <div class="title"><i id="Document.createAnchor" class="methodToggle methodClicker inactive icon-caret-right"></i>
  199. <ul class="signatures">
  200. <li class="signature">
  201. <ul>
  202. <li class="signature-call"><span id="Document.createAnchor" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">createAnchor</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>
  203. </ul>
  204. <ul class="metaInfo">
  205. </ul>
  206. </li>
  207. </ul>
  208. </div>
  209. <div class="sideToggler">
  210. <div id="ellipsis_Document.createAnchor" class="ellipsis_description"><p>Creates a new <code>Anchor</code> to define a floating point in the document.</p>
  211. </div>
  212. <div class="description"><p>Creates a new <code>Anchor</code> to define a floating point in the document.</p>
  213. <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. The row number to use</p>
  214. </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. The column number to use</p>
  215. </td></tr></table>
  216. </div>
  217. </div>
  218. </div>
  219. </div>
  220. </article>
  221. <article id="Document.getAllLines" data-title="Document.getAllLines (class method)" class="article">
  222. <div class="section method">
  223. <div class="memberContent">
  224. <div class="title"><i id="Document.getAllLines" class="methodToggle methodClicker inactive icon-caret-right"></i>
  225. <ul class="signatures">
  226. <li class="signature">
  227. <ul>
  228. <li class="signature-call"><span id="Document.getAllLines" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getAllLines</span></span><span class="emptyArgumentList">()</span></li>
  229. </ul>
  230. <ul class="metaInfo">
  231. </ul>
  232. </li>
  233. </ul>
  234. </div>
  235. <div class="sideToggler">
  236. <div id="ellipsis_Document.getAllLines" class="ellipsis_description"><p>Returns all lines in the document as string array.</p>
  237. </div>
  238. <div class="description"><p>Returns all lines in the document as string array. Warning: The caller should not modify this array!</p>
  239. </div>
  240. </div>
  241. </div>
  242. </div>
  243. </article>
  244. <article id="Document.getLength" data-title="Document.getLength (class method)" class="article">
  245. <div class="section method">
  246. <div class="memberContent">
  247. <div class="title"><i id="Document.getLength" class="methodToggle methodClicker inactive icon-caret-right"></i>
  248. <ul class="signatures">
  249. <li class="signature">
  250. <ul>
  251. <li class="signature-call"><span id="Document.getLength" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getLength</span></span><span class="emptyArgumentList">()</span></li>
  252. </ul>
  253. <ul class="metaInfo">
  254. </ul>
  255. </li>
  256. </ul>
  257. </div>
  258. <div class="sideToggler">
  259. <div id="ellipsis_Document.getLength" class="ellipsis_description"><p>Returns the number of rows in the document.</p>
  260. </div>
  261. <div class="description"><p>Returns the number of rows in the document.</p>
  262. </div>
  263. </div>
  264. </div>
  265. </div>
  266. </article>
  267. <article id="Document.getLine" data-title="Document.getLine (class method)" class="article">
  268. <div class="section method">
  269. <div class="memberContent">
  270. <div class="title"><i id="Document.getLine" class="methodToggle methodClicker inactive icon-caret-right"></i>
  271. <ul class="signatures">
  272. <li class="signature">
  273. <ul>
  274. <li class="signature-call"><span id="Document.getLine" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getLine</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</span>)</li>
  275. </ul>
  276. <ul class="metaInfo">
  277. </ul>
  278. </li>
  279. </ul>
  280. </div>
  281. <div class="sideToggler">
  282. <div id="ellipsis_Document.getLine" class="ellipsis_description"><p>Returns a verbatim copy of the given line as it is in the document</p>
  283. </div>
  284. <div class="description"><p>Returns a verbatim copy of the given line as it is in the document</p>
  285. <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. The row index to retrieve</p>
  286. </td></tr></table>
  287. </div>
  288. </div>
  289. </div>
  290. </div>
  291. </article>
  292. <article id="Document.getLines" data-title="Document.getLines (class method)" class="article">
  293. <div class="section method">
  294. <div class="memberContent">
  295. <div class="title"><i id="Document.getLines" class="methodToggle methodClicker inactive icon-caret-right"></i>
  296. <ul class="signatures">
  297. <li class="signature">
  298. <ul>
  299. <li class="signature-call"><span id="Document.getLines" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getLines</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>)</li>
  300. </ul>
  301. <ul class="metaInfo">
  302. </ul>
  303. </li>
  304. </ul>
  305. </div>
  306. <div class="sideToggler">
  307. <div id="ellipsis_Document.getLines" class="ellipsis_description"><p>Returns an array of strings of the rows between <code>firstRow</code> and <code>lastRow</code>. This function is inclusive of <code>lastRow</code>.</p>
  308. </div>
  309. <div class="description"><p>Returns an array of strings of the rows between <code>firstRow</code> and <code>lastRow</code>. This function is inclusive of <code>lastRow</code>.</p>
  310. <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 first row index to retrieve</p>
  311. </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 final row index to retrieve</p>
  312. </td></tr></table>
  313. </div>
  314. </div>
  315. </div>
  316. </div>
  317. </article>
  318. <article id="Document.getNewLineCharacter" data-title="Document.getNewLineCharacter (class method)" class="article">
  319. <div class="section method">
  320. <div class="memberContent">
  321. <div class="title"><i id="Document.getNewLineCharacter" class="methodToggle methodClicker inactive icon-caret-right"></i>
  322. <ul class="signatures">
  323. <li class="signature">
  324. <ul>
  325. <li class="signature-call"><span id="Document.getNewLineCharacter" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getNewLineCharacter</span></span><span class="emptyArgumentList">()</span>
  326. <li class="signature-returns">
  327. <ul class="argument-types">
  328. <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>
  329. </ul>
  330. </li></li>
  331. </ul>
  332. <ul class="metaInfo">
  333. </ul>
  334. </li>
  335. </ul>
  336. </div>
  337. <div class="sideToggler">
  338. <div id="ellipsis_Document.getNewLineCharacter" class="ellipsis_description"><p>Returns the newline character that&#39;s being used, depending on the value of <code>newLineMode</code>.</p>
  339. </div>
  340. <div class="description"><p>Returns the newline character that&#39;s being used, depending on the value of <code>newLineMode</code>.</p>
  341. </div>
  342. </div>
  343. </div>
  344. </div>
  345. </article>
  346. <article id="Document.getNewLineMode" data-title="Document.getNewLineMode (class method)" class="article">
  347. <div class="section method">
  348. <div class="memberContent">
  349. <div class="title"><i id="Document.getNewLineMode" class="methodToggle methodClicker inactive icon-caret-right"></i>
  350. <ul class="signatures">
  351. <li class="signature">
  352. <ul>
  353. <li class="signature-call"><span id="Document.getNewLineMode" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getNewLineMode</span></span><span class="emptyArgumentList">()</span>
  354. <li class="signature-returns">
  355. <ul class="argument-types">
  356. <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>
  357. </ul>
  358. </li></li>
  359. </ul>
  360. <ul class="metaInfo">
  361. </ul>
  362. </li>
  363. </ul>
  364. </div>
  365. <div class="sideToggler">
  366. <div id="ellipsis_Document.getNewLineMode" class="ellipsis_description"><p>Returns the type of newlines being used; either <code>windows</code>, <code>unix</code>, or <code>auto</code></p>
  367. </div>
  368. <div class="description"><p>Returns the type of newlines being used; either <code>windows</code>, <code>unix</code>, or <code>auto</code></p>
  369. </div>
  370. </div>
  371. </div>
  372. </div>
  373. </article>
  374. <article id="Document.getTextRange" data-title="Document.getTextRange (class method)" class="article">
  375. <div class="section method">
  376. <div class="memberContent">
  377. <div class="title"><i id="Document.getTextRange" class="methodToggle methodClicker inactive icon-caret-right"></i>
  378. <ul class="signatures">
  379. <li class="signature">
  380. <ul>
  381. <li class="signature-call"><span id="Document.getTextRange" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getTextRange</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)</li>
  382. </ul>
  383. <ul class="metaInfo">
  384. </ul>
  385. </li>
  386. </ul>
  387. </div>
  388. <div class="sideToggler">
  389. <div id="ellipsis_Document.getTextRange" class="ellipsis_description"><p>Given a range within the document, this function returns all the text within that range as a single string.</p>
  390. </div>
  391. <div class="description"><p>Given a range within the document, this function returns all the text within that range as a single string.</p>
  392. <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. The range to work with</p>
  393. </td></tr></table>
  394. </div>
  395. </div>
  396. </div>
  397. </div>
  398. </article>
  399. <article id="Document.getValue" data-title="Document.getValue (class method)" class="article">
  400. <div class="section method">
  401. <div class="memberContent">
  402. <div class="title"><i id="Document.getValue" class="methodToggle methodClicker inactive icon-caret-right"></i>
  403. <ul class="signatures">
  404. <li class="signature">
  405. <ul>
  406. <li class="signature-call"><span id="Document.getValue" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">getValue</span></span><span class="emptyArgumentList">()</span></li>
  407. </ul>
  408. <ul class="metaInfo">
  409. </ul>
  410. </li>
  411. </ul>
  412. </div>
  413. <div class="sideToggler">
  414. <div id="ellipsis_Document.getValue" class="ellipsis_description"><p>Returns all the lines in the document as a single string, split by the new line character.</p>
  415. </div>
  416. <div class="description"><p>Returns all the lines in the document as a single string, split by the new line character.</p>
  417. </div>
  418. </div>
  419. </div>
  420. </div>
  421. </article>
  422. <article id="Document.indexToPosition" data-title="Document.indexToPosition (class method)" class="article">
  423. <div class="section method">
  424. <div class="memberContent">
  425. <div class="title"><i id="Document.indexToPosition" class="methodToggle methodClicker inactive icon-caret-right"></i>
  426. <ul class="signatures">
  427. <li class="signature">
  428. <ul>
  429. <li class="signature-call"><span id="Document.indexToPosition" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">indexToPosition</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> index, <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</span>)
  430. <li class="signature-returns">
  431. <ul class="argument-types">
  432. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  433. </ul>
  434. </li></li>
  435. </ul>
  436. <ul class="metaInfo">
  437. </ul>
  438. </li>
  439. </ul>
  440. </div>
  441. <div class="sideToggler">
  442. <div id="ellipsis_Document.indexToPosition" class="ellipsis_description"><p>Converts an index position in a document to a <code>{row, column}</code> object.</p>
  443. </div>
  444. <div class="description"><p>Converts an index position in a document to a <code>{row, column}</code> object.</p>
  445. <p>Index refers to the &quot;absolute position&quot; of a character in the document. For example:</p>
  446. <pre><code class="language-javascript"><span class="keyword">var</span> x = <span class="number">0</span>; <span class="comment">// 10 characters, plus one for newline</span>
  447. <span class="keyword">var</span> y = -<span class="number">1</span>;</code></pre>
  448. <p>Here, <code>y</code> is an index 15: 11 characters for the first row, and 5 characters until <code>y</code> in the second.</p>
  449. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">index</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. An index to convert</p>
  450. </td></tr><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. =0 The row from which to start the conversion</p>
  451. </td></tr></table>
  452. </div>
  453. </div>
  454. </div>
  455. </div>
  456. </article>
  457. <article id="Document.insert" data-title="Document.insert (class method)" class="article">
  458. <div class="section method">
  459. <div class="memberContent">
  460. <div class="title"><i id="Document.insert" class="methodToggle methodClicker inactive icon-caret-right"></i>
  461. <ul class="signatures">
  462. <li class="signature">
  463. <ul>
  464. <li class="signature-call"><span id="Document.insert" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">insert</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> position, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> text</span>)
  465. <li class="signature-returns">
  466. <ul class="argument-types">
  467. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  468. </ul>
  469. </li></li>
  470. </ul>
  471. <ul class="metaInfo">
  472. </ul>
  473. </li>
  474. </ul>
  475. </div>
  476. <div class="sideToggler">
  477. <div id="ellipsis_Document.insert" class="ellipsis_description"><p>Inserts a block of <code>text</code> and the indicated <code>position</code>.</p>
  478. </div>
  479. <div class="description"><p>Inserts a block of <code>text</code> and the indicated <code>position</code>.</p>
  480. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">position</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. The position to start inserting at</p>
  481. </td></tr><tr class="argumentRow "><td class="argName ">text</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. A chunk of text to insert</p>
  482. </td></tr></table>
  483. </div>
  484. </div>
  485. </div>
  486. </div>
  487. </article>
  488. <article id="Document.insertInLine" data-title="Document.insertInLine (class method)" class="article">
  489. <div class="section method">
  490. <div class="memberContent">
  491. <div class="title"><i id="Document.insertInLine" class="methodToggle methodClicker inactive icon-caret-right"></i>
  492. <ul class="signatures">
  493. <li class="signature">
  494. <ul>
  495. <li class="signature-call"><span id="Document.insertInLine" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">insertInLine</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> position, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> text</span>)
  496. <li class="signature-returns">
  497. <ul class="argument-types">
  498. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  499. </ul>
  500. </li></li>
  501. </ul>
  502. <ul class="metaInfo">
  503. </ul>
  504. </li>
  505. </ul>
  506. </div>
  507. <div class="sideToggler">
  508. <div id="ellipsis_Document.insertInLine" class="ellipsis_description"><p>Inserts <code>text</code> into the <code>position</code> at the current row. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  509. </div>
  510. <div class="description"><p>Inserts <code>text</code> into the <code>position</code> at the current row. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  511. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">position</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. The position to insert at</p>
  512. </td></tr><tr class="argumentRow "><td class="argName ">text</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. A chunk of text</p>
  513. </td></tr></table>
  514. </div>
  515. </div>
  516. </div>
  517. </div>
  518. </article>
  519. <article id="Document.insertLines" data-title="Document.insertLines (class method)" class="article">
  520. <div class="section method">
  521. <div class="memberContent">
  522. <div class="title"><i id="Document.insertLines" class="methodToggle methodClicker inactive icon-caret-right"></i>
  523. <ul class="signatures">
  524. <li class="signature">
  525. <ul>
  526. <li class="signature-call"><span id="Document.insertLines" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">insertLines</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/Array" class="argument methodClicker" title="Array" data-id="Array">Array</a> lines</span>)
  527. <li class="signature-returns">
  528. <ul class="argument-types">
  529. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  530. </ul>
  531. </li></li>
  532. </ul>
  533. <ul class="metaInfo">
  534. </ul>
  535. </li>
  536. </ul>
  537. </div>
  538. <div class="sideToggler">
  539. <div id="ellipsis_Document.insertLines" class="ellipsis_description"><p>Inserts the elements in <code>lines</code> into the document, starting at the row index given by <code>row</code>. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  540. </div>
  541. <div class="description"><p>Inserts the elements in <code>lines</code> into the document, starting at the row index given by <code>row</code>. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  542. <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. The index of the row to insert at</p>
  543. </td></tr><tr class="argumentRow "><td class="argName ">lines</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Array" class="" title="Array" data-id="Array">Array</a></td><td class="argDescription "><p>Required. An array of strings</p>
  544. </td></tr></table>
  545. </div>
  546. </div>
  547. </div>
  548. </div>
  549. </article>
  550. <article id="Document.insertNewLine" data-title="Document.insertNewLine (class method)" class="article">
  551. <div class="section method">
  552. <div class="memberContent">
  553. <div class="title"><i id="Document.insertNewLine" class="methodToggle methodClicker inactive icon-caret-right"></i>
  554. <ul class="signatures">
  555. <li class="signature">
  556. <ul>
  557. <li class="signature-call"><span id="Document.insertNewLine" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">insertNewLine</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> position</span>)
  558. <li class="signature-returns">
  559. <ul class="argument-types">
  560. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  561. </ul>
  562. </li></li>
  563. </ul>
  564. <ul class="metaInfo">
  565. </ul>
  566. </li>
  567. </ul>
  568. </div>
  569. <div class="sideToggler">
  570. <div id="ellipsis_Document.insertNewLine" class="ellipsis_description"><p>Inserts a new line into the document at the current row&#39;s <code>position</code>. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  571. </div>
  572. <div class="description"><p>Inserts a new line into the document at the current row&#39;s <code>position</code>. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  573. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">position</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. The position to insert at</p>
  574. </td></tr></table>
  575. </div>
  576. </div>
  577. </div>
  578. </div>
  579. </article>
  580. <article id="Document.isNewLine" data-title="Document.isNewLine (class method)" class="article">
  581. <div class="section method">
  582. <div class="memberContent">
  583. <div class="title"><i id="Document.isNewLine" class="methodToggle methodClicker inactive icon-caret-right"></i>
  584. <ul class="signatures">
  585. <li class="signature">
  586. <ul>
  587. <li class="signature-call"><span id="Document.isNewLine" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">isNewLine</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> text</span>)</li>
  588. </ul>
  589. <ul class="metaInfo">
  590. </ul>
  591. </li>
  592. </ul>
  593. </div>
  594. <div class="sideToggler">
  595. <div id="ellipsis_Document.isNewLine" class="ellipsis_description"><p>Returns <code>true</code> if <code>text</code> is a newline character (either <code>\r\n</code>, <code>\r</code>, or <code>\n</code>).</p>
  596. </div>
  597. <div class="description"><p>Returns <code>true</code> if <code>text</code> is a newline character (either <code>\r\n</code>, <code>\r</code>, or <code>\n</code>).</p>
  598. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">text</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. The text to check</p>
  599. </td></tr></table>
  600. </div>
  601. </div>
  602. </div>
  603. </div>
  604. </article>
  605. <article id="Document.positionToIndex" data-title="Document.positionToIndex (class method)" class="article">
  606. <div class="section method">
  607. <div class="memberContent">
  608. <div class="title"><i id="Document.positionToIndex" class="methodToggle methodClicker inactive icon-caret-right"></i>
  609. <ul class="signatures">
  610. <li class="signature">
  611. <ul>
  612. <li class="signature-call"><span id="Document.positionToIndex" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">positionToIndex</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> pos, <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</span>)
  613. <li class="signature-returns">
  614. <ul class="argument-types">
  615. <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>
  616. </ul>
  617. </li></li>
  618. </ul>
  619. <ul class="metaInfo">
  620. </ul>
  621. </li>
  622. </ul>
  623. </div>
  624. <div class="sideToggler">
  625. <div id="ellipsis_Document.positionToIndex" class="ellipsis_description"><p>Converts the <code>{row, column}</code> position in a document to the character&#39;s index.</p>
  626. </div>
  627. <div class="description"><p>Converts the <code>{row, column}</code> position in a document to the character&#39;s index.</p>
  628. <p>Index refers to the &quot;absolute position&quot; of a character in the document. For example:</p>
  629. <pre><code class="language-javascript"><span class="keyword">var</span> x = <span class="number">0</span>; <span class="comment">// 10 characters, plus one for newline</span>
  630. <span class="keyword">var</span> y = -<span class="number">1</span>;</code></pre>
  631. <p>Here, <code>y</code> is an index 15: 11 characters for the first row, and 5 characters until <code>y</code> in the second.</p>
  632. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">pos</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. The <code>{row, column}</code> to convert</p>
  633. </td></tr><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. =0 The row from which to start the conversion</p>
  634. </td></tr></table>
  635. </div>
  636. </div>
  637. </div>
  638. </div>
  639. </article>
  640. <article id="Document.remove" data-title="Document.remove (class method)" class="article">
  641. <div class="section method">
  642. <div class="memberContent">
  643. <div class="title"><i id="Document.remove" class="methodToggle methodClicker inactive icon-caret-right"></i>
  644. <ul class="signatures">
  645. <li class="signature">
  646. <ul>
  647. <li class="signature-call"><span id="Document.remove" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">remove</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range</span>)
  648. <li class="signature-returns">
  649. <ul class="argument-types">
  650. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  651. </ul>
  652. </li></li>
  653. </ul>
  654. <ul class="metaInfo">
  655. </ul>
  656. </li>
  657. </ul>
  658. </div>
  659. <div class="sideToggler">
  660. <div id="ellipsis_Document.remove" class="ellipsis_description"><p>Removes the <code>range</code> from the document.</p>
  661. </div>
  662. <div class="description"><p>Removes the <code>range</code> from the document.</p>
  663. <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 specified Range to remove</p>
  664. </td></tr></table>
  665. </div>
  666. </div>
  667. </div>
  668. </div>
  669. </article>
  670. <article id="Document.removeInLine" data-title="Document.removeInLine (class method)" class="article">
  671. <div class="section method">
  672. <div class="memberContent">
  673. <div class="title"><i id="Document.removeInLine" class="methodToggle methodClicker inactive icon-caret-right"></i>
  674. <ul class="signatures">
  675. <li class="signature">
  676. <ul>
  677. <li class="signature-call"><span id="Document.removeInLine" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">removeInLine</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> 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> endColumn</span>)
  678. <li class="signature-returns">
  679. <ul class="argument-types">
  680. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  681. </ul>
  682. </li></li>
  683. </ul>
  684. <ul class="metaInfo">
  685. </ul>
  686. </li>
  687. </ul>
  688. </div>
  689. <div class="sideToggler">
  690. <div id="ellipsis_Document.removeInLine" class="ellipsis_description"><p>Removes the specified columns from the <code>row</code>. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  691. </div>
  692. <div class="description"><p>Removes the specified columns from the <code>row</code>. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  693. <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. The row to remove from</p>
  694. </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 column to start removing at</p>
  695. </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 column to stop removing at</p>
  696. </td></tr></table>
  697. </div>
  698. </div>
  699. </div>
  700. </div>
  701. </article>
  702. <article id="Document.removeLines" data-title="Document.removeLines (class method)" class="article">
  703. <div class="section method">
  704. <div class="memberContent">
  705. <div class="title"><i id="Document.removeLines" class="methodToggle methodClicker inactive icon-caret-right"></i>
  706. <ul class="signatures">
  707. <li class="signature">
  708. <ul>
  709. <li class="signature-call"><span id="Document.removeLines" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">removeLines</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>)
  710. <li class="signature-returns">
  711. <ul class="argument-types">
  712. <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>
  713. </ul>
  714. </li></li>
  715. </ul>
  716. <ul class="metaInfo">
  717. </ul>
  718. </li>
  719. </ul>
  720. </div>
  721. <div class="sideToggler">
  722. <div id="ellipsis_Document.removeLines" class="ellipsis_description"><p>Removes a range of full lines. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  723. </div>
  724. <div class="description"><p>Removes a range of full lines. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  725. <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 first row to be removed</p>
  726. </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 last row to be removed</p>
  727. </td></tr></table>
  728. </div>
  729. </div>
  730. </div>
  731. </div>
  732. </article>
  733. <article id="Document.removeNewLine" data-title="Document.removeNewLine (class method)" class="article">
  734. <div class="section method">
  735. <div class="memberContent">
  736. <div class="title"><i id="Document.removeNewLine" class="methodToggle methodClicker inactive icon-caret-right"></i>
  737. <ul class="signatures">
  738. <li class="signature">
  739. <ul>
  740. <li class="signature-call"><span id="Document.removeNewLine" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">removeNewLine</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</span>)</li>
  741. </ul>
  742. <ul class="metaInfo">
  743. </ul>
  744. </li>
  745. </ul>
  746. </div>
  747. <div class="sideToggler">
  748. <div id="ellipsis_Document.removeNewLine" class="ellipsis_description"><p>Removes the new line between <code>row</code> and the row immediately following it. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  749. </div>
  750. <div class="description"><p>Removes the new line between <code>row</code> and the row immediately following it. This method also triggers the <code>&#39;change&#39;</code> event.</p>
  751. <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. The row to check</p>
  752. </td></tr></table>
  753. </div>
  754. </div>
  755. </div>
  756. </div>
  757. </article>
  758. <article id="Document.replace" data-title="Document.replace (class method)" class="article">
  759. <div class="section method">
  760. <div class="memberContent">
  761. <div class="title"><i id="Document.replace" class="methodToggle methodClicker inactive icon-caret-right"></i>
  762. <ul class="signatures">
  763. <li class="signature">
  764. <ul>
  765. <li class="signature-call"><span id="Document.replace" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">replace</span></span>(<span class="sigArgList"><a href="range.html" class="argument methodClicker" title="Range (class)" data-id="Range">Range</a> range, <a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> text</span>)
  766. <li class="signature-returns">
  767. <ul class="argument-types">
  768. <li class="argument-type"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="returnType " title="Object" data-id="Object">Object</a></li>
  769. </ul>
  770. </li></li>
  771. </ul>
  772. <ul class="metaInfo">
  773. </ul>
  774. </li>
  775. </ul>
  776. </div>
  777. <div class="sideToggler">
  778. <div id="ellipsis_Document.replace" class="ellipsis_description"><p>Replaces a range in the document with the new <code>text</code>.</p>
  779. </div>
  780. <div class="description"><p>Replaces a range in the document with the new <code>text</code>.</p>
  781. <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 specified Range to replace</p>
  782. </td></tr><tr class="argumentRow "><td class="argName ">text</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. The new text to use as a replacement</p>
  783. </td></tr></table>
  784. </div>
  785. </div>
  786. </div>
  787. </div>
  788. </article>
  789. <article id="Document.revertDeltas" data-title="Document.revertDeltas (class method)" class="article">
  790. <div class="section method">
  791. <div class="memberContent">
  792. <div class="title"><i id="Document.revertDeltas" class="methodToggle methodClicker inactive icon-caret-right"></i>
  793. <ul class="signatures">
  794. <li class="signature">
  795. <ul>
  796. <li class="signature-call"><span id="Document.revertDeltas" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">revertDeltas</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="argument methodClicker" title="Object" data-id="Object">Object</a> deltas</span>)</li>
  797. </ul>
  798. <ul class="metaInfo">
  799. </ul>
  800. </li>
  801. </ul>
  802. </div>
  803. <div class="sideToggler">
  804. <div id="ellipsis_Document.revertDeltas" class="ellipsis_description"><p>Reverts any changes previously applied. These can be either <code>&#39;includeText&#39;</code>, <code>&#39;insertLines&#39;</code>, <code>&#39;removeText&#39;</code>, and <code>&#39;removeLines&#39;</code>.</p>
  805. </div>
  806. <div class="description"><p>Reverts any changes previously applied. These can be either <code>&#39;includeText&#39;</code>, <code>&#39;insertLines&#39;</code>, <code>&#39;removeText&#39;</code>, and <code>&#39;removeLines&#39;</code>.</p>
  807. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">deltas</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/Object" class="" title="Object" data-id="Object">Object</a></td><td class="argDescription "><p>Required. </p>
  808. </td></tr></table>
  809. </div>
  810. </div>
  811. </div>
  812. </div>
  813. </article>
  814. <article id="Document.setNewLineMode" data-title="Document.setNewLineMode (class method)" class="article">
  815. <div class="section method">
  816. <div class="memberContent">
  817. <div class="title"><i id="Document.setNewLineMode" class="methodToggle methodClicker inactive icon-caret-right"></i>
  818. <ul class="signatures">
  819. <li class="signature">
  820. <ul>
  821. <li class="signature-call"><span id="Document.setNewLineMode" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">setNewLineMode</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> newLineMode</span>)</li>
  822. </ul>
  823. <ul class="metaInfo">
  824. </ul>
  825. </li>
  826. </ul>
  827. </div>
  828. <div class="sideToggler">
  829. <div id="ellipsis_Document.setNewLineMode" class="ellipsis_description"><p>Sets the new line mode.</p>
  830. </div>
  831. <div class="description"><p>Sets the new line mode.</p>
  832. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">newLineMode</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. The newline mode to use; can be either <code>windows</code>, <code>unix</code>, or <code>auto</code></p>
  833. </td></tr></table>
  834. </div>
  835. </div>
  836. </div>
  837. </div>
  838. </article>
  839. <article id="Document.setValue" data-title="Document.setValue (class method)" class="article">
  840. <div class="section method">
  841. <div class="memberContent">
  842. <div class="title"><i id="Document.setValue" class="methodToggle methodClicker inactive icon-caret-right"></i>
  843. <ul class="signatures">
  844. <li class="signature">
  845. <ul>
  846. <li class="signature-call"><span id="Document.setValue" class="member-name methodClicker"><span class="sigClassName">Document.</span><span class="sigMemberName">setValue</span></span>(<span class="sigArgList"><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="argument methodClicker" title="String" data-id="String">String</a> text</span>)</li>
  847. </ul>
  848. <ul class="metaInfo">
  849. </ul>
  850. </li>
  851. </ul>
  852. </div>
  853. <div class="sideToggler">
  854. <div id="ellipsis_Document.setValue" class="ellipsis_description"><p>Replaces all the lines in the current <code>Document</code> with the value of <code>text</code>.</p>
  855. </div>
  856. <div class="description"><p>Replaces all the lines in the current <code>Document</code> with the value of <code>text</code>.</p>
  857. <h4>Arguments</h4><table class="argumentTable argument-list table table-striped table-bordered"><tr class="argumentRow "><td class="argName ">text</td><td class="argType" "><a href="https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String" class="" title="String" data-id="String">String</a></td><td class="argDescription "><p>Required. The text to use</p>
  858. </td></tr></table>
  859. </div>
  860. </div>
  861. </div>
  862. </div>
  863. </article>
  864. </div>
  865. <script defer src="./resources/javascripts/ux.js"></script>
  866. <script src="./resources/javascripts/clicker.js"></script>
  867. <script src="./resources/javascripts/jquery-scrollspy.js"></script>
  868. <script defer src="./resources/javascripts/disqus-ext.js"></script>
  869. <script defer src="./resources/javascripts/ga.js"></script>
  870. <div id="disqus_thread"></div>
  871. </div>