An assigned story.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| filePath | string | readonly | The file path (a colon delimited path for Mac). Can also accept: File. |
| id | number | readonly | The unique ID of the AssignedStory. |
| index | number | readonly | The index of the AssignedStory within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the AssignedStory. |
| parent | Assignment | readonly | The parent of the AssignedStory (a Assignment). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| storyReference | any | readonly | A reference to the assigned story. Can return: Story, PageItem, Oval, Rectangle or Polygon. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of AssignedStory
getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
AssignedStory
move ([to:
LocationOptions=AT_END][, reference:
any])
Moves the assigned story to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions
: BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location of the assigned story relative to the reference object or within the containing object. (Optional) (default: AT_END) |
| reference |
Assignment
AssignedStory |
The reference object. Note: Required when the to parameter specifies before or after. Can accept: Assignment or AssignedStory. (Optional) |
string toSource ()
Generates a string which, if executed, will return the AssignedStory.
string toSpecifier ()
Retrieves the object specifier.
Used in:
AssignedStories.previousItem ( obj: AssignedStory)AssignedStories.nextItem ( obj: AssignedStory)
Returned by:
AssignedStory AssignedStories.anyItem ( )Array of AssignedStory AssignedStories.everyItem ( )
AssignedStory AssignedStories.firstItem ( )
AssignedStory AssignedStories.item ( index: any )
AssignedStory AssignedStories.itemByID ( id: number )
AssignedStory AssignedStories.itemByName ( name: string )
Array of AssignedStory AssignedStories.itemByRange ( from: any, to: any )
AssignedStory AssignedStories.lastItem ( )
AssignedStory AssignedStories.middleItem ( )
AssignedStory AssignedStories.nextItem ( obj: AssignedStory )
AssignedStory AssignedStories.previousItem ( obj: AssignedStory )
Array of AssignedStory AssignedStory.getElements ( )
AssignedStory AssignedStory.move ( [to: LocationOptions=AT_END][, reference: any] )