K4 InDesign Javascript API Documentation

LayoutPathPoint

A path point of a path.

Instance Properties

Name Description Access
anchor Measurement Unit (Number or String)=any The location of the path point on the page, in the format [x, y]. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
index number The index of the PathPoint within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
leftDirection Measurement Unit (Number or String)=any The left-direction point, which controls the curve of the line segment preceding the path point on the path, in the format [x, y]. read-write
parent Path The parent of the PathPoint (a Path). read-only
pointType PointType The path point type. read-write
properties Object A property that allows setting of several properties at the same time. read-write
rightDirection Measurement Unit (Number or String)=any The right-direction point, which controls the curve of the line segment following the path point on the path, in the format [x, y]. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → PathPoint
join(
reference ​[, given])
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → PathPoint
Resolves the object specifier, creating an array of object references.
join(
reference ​[, given])
Join this path point to another path point. The two points must be end points and their paths combined into a single path on a single page item.
reference PathPoint The reference object. The path point to join to
given JoinOptions The join option to use. (Optional)
remove(
)
Deletes the PathPoint.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the PathPoint.
toSpecifier(
)
  → string
Retrieves the object specifier.