Guide

A guide.

Methods:

extractLabel, insertLabel, override, remove, removeOverride, select

Objects:

Boolean, HorizontalOrVertical, Layer, Number, Object, String, UIColors,

Property Listing

Property

Type

Access

Description

fitToPage

Boolean

read/write

If true, horizontal orientation guides stop at the edges of the specified page. If false, the guides extends across the width of the spread and into the pasteboard area.

guideColor

Array of 3 Reals (0 - 255)

UIColors

read/write

The color of the guide, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.

id

Number

readonly

The unique ID of the Guide.

index

Number

readonly

The index of the Guide within its containing object.

itemLayer

Layer

read/write

The layer that the Guide is on.

label

String

read/write

A property that can be set to any string.

location

Number

String

read/write

The location at which to place the guide relative to the current ruler zero point.

locked

Boolean

read/write

If true, the Guide is locked.

orientation

HorizontalOrVertical

HorizontalOrVertical.HORIZONTAL

HorizontalOrVertical.VERTICAL

read/write

The orientation of the guide.

parent

Document

MasterSpread

Spread

Layer

Page

readonly

The parent of the Guide (a Page, Spread, MasterSpread, Document or Layer).

properties

Object

read/write

A property that allows setting of several properties at the same time.

viewThreshold

Number

read/write

The guide's view threshold

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

undefined 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.

PageItem override (destinationPage:Page)

Overrides a master page item and places it on the page

Parameter

Type

Description

destinationPage

Page

The document page on which the master page item will be overridden.

undefined remove ()

Deletes the Guide.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Select this object.

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE

How to handle the existing selection (Optional)

(default: SelectionOptions.REPLACE)

Return

Guides.add()