K4 InDesign Javascript API Documentation

AssignmentAssignedStory

An assigned story.

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
filePath string The file path (colon delimited on the Mac OS). Can also accept: File. read-only
id number The unique ID of the AssignedStory. read-only
index number The index of the AssignedStory within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the AssignedStory. read-write
parent Assignment The parent of the AssignedStory (a Assignment). read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyReference A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → AssignedStory
insertLabel(
key, value)
move(
[to], reference)
  → AssignedStory
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)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → AssignedStory
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
move(
[to=LocationOptions.AT_END], reference)
  → AssignedStory
Moves the assigned story to the specified location.
to LocationOptions The location of the assigned story relative to the reference object or within the containing object. (Optional)
reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Assignment or AssignedStory. (Optional)
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 AssignedStory.
toSpecifier(
)
  → string
Retrieves the object specifier.