Adobe InDesign CS2 (4.0) Object Model JS: PathPoints

InDesign CS2

Class

PathPoints

 A collection of path points.

QuickLinks

add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

PathPoint add ([withProperties: Object])
Creates a new PathPoint.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new PathPoint (Optional)

PathPoint anyItem ()
Returns any PathPoint in the collection.

number count ()
Displays the number of elements in the PathPoint.

Array of PathPoint everyItem ()
Returns every PathPoint in the collection.

PathPoint firstItem ()
Returns the first PathPoint in the collection.

PathPoint item (index: any)
Returns the PathPoint with the specified index or name.

ParameterTypeDescription
indexLong
String
The index or name. Can accept: Long or String.

PathPoint itemByName (name: string)
Returns the PathPoint with the specified name.

ParameterTypeDescription
namestringThe name.

Array of PathPoint itemByRange (from: any, to: any)
Returns the PathPoints within the specified range.

ParameterTypeDescription
fromLong
PathPoint
String
The PathPoint, index, or name at the beginning of the range. Can accept: PathPoint, Long or String.
toLong
PathPoint
String
The PathPoint, index, or name at the end of the range. Can accept: PathPoint, Long or String.

PathPoint lastItem ()
Returns the last PathPoint in the collection.

PathPoint middleItem ()
Returns the middle PathPoint in the collection.

PathPoint nextItem (obj: PathPoint)
Returns the PathPoint whose index follows the specified PathPoint in the collection.

ParameterTypeDescription
objPathPointThe PathPoint whose index comes before the desired PathPoint.

PathPoint previousItem (obj: PathPoint)
Returns the PathPoint with the index previous to the specified index.

ParameterTypeDescription
objPathPointThe index of the PathPoint that follows the desired PathPoint.

string toSource ()
Generates a string which, if executed, will return the PathPoint.

Element of

Path.pathPoints

Jongware, 27-Jun-2010 v3.0.3dContents :: Index