K4 InDesign Javascript API Documentation

TablesRows

A collection of table rows.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[at], reference ​[, withProperties])
anyItem(
)
  → Row
count(
)
  → number
everyItem(
)
  → Row
firstItem(
)
  → Row
item(
index)
  → Row
itemByName(
name)
  → Row
itemByRange(
from, to)
  → Row
lastItem(
)
  → Row
middleItem(
)
  → Row
nextItem(
obj)
  → Row
previousItem(
obj)
  → Row
toSource(
)
  → string
add(
[at=LocationOptions.UNKNOWN], reference ​[, withProperties])
Creates a new Row.
at LocationOptions The Row's location relative to the reference object or within the table. (Optional)
reference The reference object. Note: The reference object must be within the table. Required only when the at value contains before or after. Can accept: Row, Column, Cell or Table. (Optional)
withProperties Object Initial values for properties of the new Row (Optional)
anyItem(
)
  → Row
Returns any Row in the collection.
count(
)
  → number
Displays the number of elements in the Row.
everyItem(
)
  → Row
Returns every Row in the collection.
firstItem(
)
  → Row
Returns the first Row in the collection.
item(
index)
  → Row
Returns the Row with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByName(
name)
  → Row
Returns the Row with the specified name.
name string The name.
itemByRange(
from, to)
  → Row
Returns the Rows within the specified range.
from The Row, index, or name at the beginning of the range. Can accept: Row, Long Integer or String.
to The Row, index, or name at the end of the range. Can accept: Row, Long Integer or String.
lastItem(
)
  → Row
Returns the last Row in the collection.
middleItem(
)
  → Row
Returns the middle Row in the collection.
nextItem(
obj)
  → Row
Returns the Row whose index follows the specified Row in the collection.
obj Row The Row whose index comes before the desired Row.
previousItem(
obj)
  → Row
Returns the Row with the index previous to the specified index.
obj Row The index of the Row that follows the desired Row.
toSource(
)
  → string
Generates a string which, if executed, will return the Row.