LayoutPaths

A collection of paths.

Instance Properties

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

Methods

add(
[withProperties])
 → Path
anyItem(
)
 → Path
count(
)
 → number
everyItem(
)
 → Path
firstItem(
)
 → Path
item(
index)
 → Path
itemByRange(
from, to)
 → Path
lastItem(
)
 → Path
middleItem(
)
 → Path
nextItem(
obj)
 → Path
previousItem(
obj)
 → Path
toSource(
)
 → string
add(
[withProperties])
 → Path
Creates a new Path.
withProperties Object Initial values for properties of the new Path (Optional)
anyItem(
)
 → Path
Returns any Path in the collection.
count(
)
 → number
Displays the number of elements in the Path.
everyItem(
)
 → Path
Returns every Path in the collection.
firstItem(
)
 → Path
Returns the first Path in the collection.
item(
index)
 → Path
Returns the Path with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByRange(
from, to)
 → Path
Returns the Paths within the specified range.
from The Path, index, or name at the beginning of the range. Can accept: Path, Long Integer or String.
to The Path, index, or name at the end of the range. Can accept: Path, Long Integer or String.
lastItem(
)
 → Path
Returns the last Path in the collection.
middleItem(
)
 → Path
Returns the middle Path in the collection.
nextItem(
obj)
 → Path
Returns the Path whose index follows the specified Path in the collection.
obj Path The Path whose index comes before the desired Path.
previousItem(
obj)
 → Path
Returns the Path with the index previous to the specified index.
obj Path The index of the Path that follows the desired Path.
toSource(
)
 → string
Generates a string which, if executed, will return the Path.