K4 InDesign Javascript API Documentation

LayoutGraphicLines

A collection of graphic lines.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → GraphicLine
anyItem(
)
  → GraphicLine
count(
)
  → number
everyItem(
)
  → GraphicLine
firstItem(
)
  → GraphicLine
item(
index)
  → GraphicLine
itemByID(
id)
  → GraphicLine
itemByName(
name)
  → GraphicLine
itemByRange(
from, to)
  → GraphicLine
lastItem(
)
  → GraphicLine
middleItem(
)
  → GraphicLine
nextItem(
obj)
  → GraphicLine
previousItem(
obj)
  → GraphicLine
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → GraphicLine
Creates a new GraphicLine
layer Layer The layer on which to create the GraphicLine. (Optional)
at LocationOptions The location at which to insert the GraphicLine relative to the reference object or within the container object. (Optional)
reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties Object Initial values for properties of the new GraphicLine (Optional)
anyItem(
)
  → GraphicLine
Returns any GraphicLine in the collection.
count(
)
  → number
Displays the number of elements in the GraphicLine.
everyItem(
)
  → GraphicLine
Returns every GraphicLine in the collection.
firstItem(
)
  → GraphicLine
Returns the first GraphicLine in the collection.
item(
index)
  → GraphicLine
Returns the GraphicLine with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → GraphicLine
Returns the GraphicLine with the specified ID.
id number The ID.
itemByName(
name)
  → GraphicLine
Returns the GraphicLine with the specified name.
name string The name.
itemByRange(
from, to)
  → GraphicLine
Returns the GraphicLines within the specified range.
from The GraphicLine, index, or name at the beginning of the range. Can accept: GraphicLine, Long Integer or String.
to The GraphicLine, index, or name at the end of the range. Can accept: GraphicLine, Long Integer or String.
lastItem(
)
  → GraphicLine
Returns the last GraphicLine in the collection.
middleItem(
)
  → GraphicLine
Returns the middle GraphicLine in the collection.
nextItem(
obj)
  → GraphicLine
Returns the GraphicLine whose index follows the specified GraphicLine in the collection.
obj GraphicLine The GraphicLine whose index comes before the desired GraphicLine.
previousItem(
obj)
  → GraphicLine
Returns the GraphicLine with the index previous to the specified index.
obj GraphicLine The index of the GraphicLine that follows the desired GraphicLine.
toSource(
)
  → string
Generates a string which, if executed, will return the GraphicLine.