Update API docs
This commit is contained in:
Garen Torikian
parent
330ca76bfe
commit
17fcc42923
27 changed files with 1176 additions and 1186 deletions
|
|
@ -198,7 +198,7 @@
|
|||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_new Range" class="ellipsis_description"><p>Creates a new <code>Range</code> object with the given starting and ending row and column points. ...</p>
|
||||
<div id="ellipsis_new Range" class="ellipsis_description"><p>Creates a new <code>Range</code> object with the given starting and ending row and column points.</p>
|
||||
|
||||
</div>
|
||||
<div id="short_new Range" class="short_description hiddenSpan"><p>Creates a new <code>Range</code> object with the given starting and ending row and column points.</p>
|
||||
|
|
@ -233,7 +233,7 @@
|
|||
</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 `Rang...</p>
|
||||
<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>
|
||||
<div id="short_Range.clipRows" class="short_description hiddenSpan"><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>
|
||||
|
|
@ -267,7 +267,7 @@
|
|||
</ul>
|
||||
</div>
|
||||
<div class="sideToggler">
|
||||
<div id="ellipsis_Range.clone" class="ellipsis_description"><p>Returns a duplicate of the calling range. ...</p>
|
||||
<div id="ellipsis_Range.clone" class="ellipsis_description"><p>Returns a duplicate of the calling range.</p>
|
||||
|
||||
</div>
|
||||
<div id="short_Range.clone" class="short_description hiddenSpan"><p>Returns a duplicate of the calling range.</p>
|
||||
|
|
@ -300,7 +300,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.collapseRows" class="short_description hiddenSpan"><p>Returns a range containing the starting and ending rows of the original range, but with a column value of <code>0</code>.</p>
|
||||
|
|
@ -333,7 +333,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.compare" class="short_description hiddenSpan"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
||||
|
|
@ -368,7 +368,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.compareEnd" class="short_description hiddenSpan"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
||||
|
|
@ -403,7 +403,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.compareInside" class="short_description hiddenSpan"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
||||
|
|
@ -439,7 +439,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.comparePoint" class="short_description hiddenSpan"><p>Checks the row and column points of <code>p</code> with the row and column points of the calling range.</p>
|
||||
|
|
@ -475,7 +475,7 @@
|
|||
</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 id="ellipsis_Range.compareRange" class="ellipsis_description"><p>Compares <code>this</code> range (A) with another range (B).</p>
|
||||
|
||||
</div>
|
||||
<div id="short_Range.compareRange" class="short_description hiddenSpan"><p>Compares <code>this</code> range (A) with another range (B).</p>
|
||||
|
|
@ -510,7 +510,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.compareStart" class="short_description hiddenSpan"><p>Checks the row and column points with the row and column points of the calling range.</p>
|
||||
|
|
@ -546,11 +546,12 @@
|
|||
</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 return...</p>
|
||||
<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>
|
||||
<div id="short_Range.contains" class="short_description hiddenSpan"><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 id="short_Range.contains" class="short_description hiddenSpan"><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>
|
||||
|
||||
</div>
|
||||
<h3 id="Range.contains" class="methodToggle methodClicker inactive"> </h3>
|
||||
|
|
@ -584,7 +585,7 @@
|
|||
</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 ...</p>
|
||||
<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>
|
||||
<div id="short_Range.containsRange" class="short_description hiddenSpan"><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>
|
||||
|
|
@ -618,7 +619,7 @@
|
|||
</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...</p>
|
||||
<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>
|
||||
<div id="short_Range.extend" class="short_description hiddenSpan"><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>
|
||||
|
|
@ -652,7 +653,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.fromPoints" class="short_description hiddenSpan"><p>Creates and returns a new <code>Range</code> based on the row and column of the given parameters.</p>
|
||||
|
|
@ -687,7 +688,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.inside" class="short_description hiddenSpan"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range.</p>
|
||||
|
|
@ -722,7 +723,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.insideEnd" class="short_description hiddenSpan"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range's ending points.</p>
|
||||
|
|
@ -757,7 +758,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.insideStart" class="short_description hiddenSpan"><p>Returns <code>true</code> if the <code>row</code> and <code>column</code> are within the given range's starting points.</p>
|
||||
|
|
@ -791,7 +792,7 @@
|
|||
</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 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>
|
||||
<div id="short_Range.intersects" class="short_description hiddenSpan"><p>Returns <code>true</code> if passed in <code>range</code> intersects with the one calling this method.</p>
|
||||
|
|
@ -825,7 +826,7 @@
|
|||
</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 ...</p>
|
||||
<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>
|
||||
<div id="short_Range.isEnd" class="short_description hiddenSpan"><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>
|
||||
|
|
@ -859,7 +860,7 @@
|
|||
</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 ...</p>
|
||||
<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>
|
||||
<div id="short_Range.isEqual" class="short_description hiddenSpan"><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>
|
||||
|
|
@ -893,7 +894,7 @@
|
|||
</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 id="ellipsis_Range.isMultiLine" class="ellipsis_description"><p>Returns true if the range spans across multiple lines.</p>
|
||||
|
||||
</div>
|
||||
<div id="short_Range.isMultiLine" class="short_description hiddenSpan"><p>Returns true if the range spans across multiple lines.</p>
|
||||
|
|
@ -926,7 +927,7 @@
|
|||
</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 s...</p>
|
||||
<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>
|
||||
<div id="short_Range.isStart" class="short_description hiddenSpan"><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>
|
||||
|
|
@ -955,7 +956,7 @@
|
|||
</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 id="ellipsis_Range.setEnd" class="ellipsis_description"><p>Sets the starting row and column for the range.</p>
|
||||
|
||||
</div>
|
||||
<div id="short_Range.setEnd" class="short_description hiddenSpan"><p>Sets the starting row and column for the range.</p>
|
||||
|
|
@ -984,7 +985,7 @@
|
|||
</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 id="ellipsis_Range.setStart" class="ellipsis_description"><p>Sets the starting row and column for the range.</p>
|
||||
|
||||
</div>
|
||||
<div id="short_Range.setStart" class="short_description hiddenSpan"><p>Sets the starting row and column for the range.</p>
|
||||
|
|
@ -1018,7 +1019,7 @@
|
|||
</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 r...</p>
|
||||
<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>
|
||||
<div id="short_Range.toScreenRange" class="short_description hiddenSpan"><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>
|
||||
|
|
@ -1052,12 +1053,11 @@
|
|||
</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 id="ellipsis_Range.toString" class="ellipsis_description"><p>Returns a string containing the range's row and column information, given like this:</p>
|
||||
|
||||
</div>
|
||||
<div id="short_Range.toString" class="short_description hiddenSpan"><p>Returns a string containing the range's row and column information, given like this:
|
||||
</p>
|
||||
<div id="short_Range.toString" class="short_description hiddenSpan"><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>
|
||||
<h3 id="Range.toString" class="methodToggle methodClicker inactive"> </h3>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue