K4 InDesign Javascript API Documentation

LayoutPathPoints

A collection of path points.

Instance Properties

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

Methods

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