LayoutGuides

A collection of guides.

Instance Properties

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

Methods

[layer] [, withProperties])

→ Guide

)

→ Guide

)

→ number

)

→ Guide

)

→ Guide

index)

→ Guide

id)

→ Guide

name)

→ Guide

from, to)

→ Guide

)

→ Guide

)

→ Guide

obj)

→ Guide

obj)

→ Guide

)

→ string

add( [layer] [, withProperties]) → Guide

Creates a new guide.

`layer`	Layer The layer on which to create the guide. (Optional)
`withProperties`	Object Initial values for properties of the new Guide (Optional)

anyItem( ) → Guide

Returns any Guide in the collection.

count( ) → number

Displays the number of elements in the Guide.

everyItem( ) → Guide

Returns every Guide in the collection.

firstItem( ) → Guide

Returns the first Guide in the collection.

item( index) → Guide

Returns the Guide with the specified index or name.

index The index or name. Can accept: Long Integer or String.

itemByID( id) → Guide

Returns the Guide with the specified ID.

`id`	number The ID.

itemByName( name) → Guide

Returns the Guide with the specified name.

name string The name.

itemByRange( from, to) → Guide

Returns the Guides within the specified range.

`from`	The Guide, index, or name at the beginning of the range. Can accept: Guide, Long Integer or String.
`to`	The Guide, index, or name at the end of the range. Can accept: Guide, Long Integer or String.

lastItem( ) → Guide

Returns the last Guide in the collection.

middleItem( ) → Guide

Returns the middle Guide in the collection.

nextItem( obj) → Guide

Returns the Guide whose index follows the specified Guide in the collection.

obj Guide The Guide whose index comes before the desired Guide.

previousItem( obj) → Guide

Returns the Guide with the index previous to the specified index.

obj Guide The index of the Guide that follows the desired Guide.

toSource( ) → string

Generates a string which, if executed, will return the Guide.