K4 InDesign Javascript API Documentation

LayoutSplineItems

The spline items collection.

Instance Properties

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

Methods

anyItem(
)
  → SplineItem
count(
)
  → number
everyItem(
)
  → SplineItem
firstItem(
)
  → SplineItem
item(
index)
  → SplineItem
itemByID(
id)
  → SplineItem
itemByName(
name)
  → SplineItem
itemByRange(
from, to)
  → SplineItem
lastItem(
)
  → SplineItem
middleItem(
)
  → SplineItem
nextItem(
obj)
  → SplineItem
previousItem(
obj)
  → SplineItem
toSource(
)
  → string
anyItem(
)
  → SplineItem
Returns any SplineItem in the collection.
count(
)
  → number
Displays the number of elements in the SplineItem.
everyItem(
)
  → SplineItem
Returns every SplineItem in the collection.
firstItem(
)
  → SplineItem
Returns the first SplineItem in the collection.
item(
index)
  → SplineItem
Returns the SplineItem with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → SplineItem
Returns the SplineItem with the specified ID.
id number The ID.
itemByName(
name)
  → SplineItem
Returns the SplineItem with the specified name.
name string The name.
itemByRange(
from, to)
  → SplineItem
Returns the SplineItems within the specified range.
from The SplineItem, index, or name at the beginning of the range. Can accept: SplineItem, Long Integer or String.
to The SplineItem, index, or name at the end of the range. Can accept: SplineItem, Long Integer or String.
lastItem(
)
  → SplineItem
Returns the last SplineItem in the collection.
middleItem(
)
  → SplineItem
Returns the middle SplineItem in the collection.
nextItem(
obj)
  → SplineItem
Returns the SplineItem whose index follows the specified SplineItem in the collection.
obj SplineItem The SplineItem whose index comes before the desired SplineItem.
previousItem(
obj)
  → SplineItem
Returns the SplineItem with the index previous to the specified index.
obj SplineItem The index of the SplineItem that follows the desired SplineItem.
toSource(
)
  → string
Generates a string which, if executed, will return the SplineItem.