Class: Guide | K4 InDesign Javascript API Documentation

A guide.

Static Properties

Name	Description
AFTER_PLACE = "afterPlace"	string Dispatched after a Guide is placed. This event bubbles. This event is not cancelable.

Instance Properties

Name	Description	Access
allowOverrides	bool If true, the master page item can be overridden.	read-write
eventListeners	EventListeners A collection of event listeners.	read-only
events	Events A collection of events.	read-only
fitToPage	bool 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.	read-write
guideColor	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.	read-write
guideType	GuideTypeOptions The type of the guide.	read-write
guideZone	Measurement Unit (Number or String)=any The zone of the guide.	read-write
id	number The unique ID of the Guide.	read-only
index	number The index of the Guide within its containing object.	read-only
isValid	bool Returns true if the object specifier resolves to valid objects.	read-only
itemLayer	Layer The layer that the Guide is on.	read-write
label	string A property that can be set to any string.	read-write
location	Measurement Unit (Number or String)=any The location at which to place the guide relative to the current ruler zero point.	read-write
locked	bool If true, the Guide is locked.	read-write
name	string The name of the Guide; this is an alias to the Guide's label property.	read-write
orientation	HorizontalOrVertical The orientation of the guide.	read-write
overridden	bool If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.	read-only
overriddenMasterPageItem	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.	read-only
parent	The parent of the Guide (a Spread or MasterSpread).	read-only
parentPage	Page The page on which this page item appears.	read-only
properties	Object A property that allows setting of several properties at the same time.	read-write
viewThreshold	number The view magnification as a percentage below which guides are no longer displayed. (Range: 5.0 to 4000.0)	read-write

Methods

addEventListener(

eventType, handler [, captures])

→ EventListener

detach(

)

duplicate(

)

→ Guide

extractLabel(

key)

→ string

getElements(

)

→ Guide

key, value)

[to] [, by])

destinationPage)

)

eventType, handler [, captures])

→ bool

removeOverride(

)

resolve(

location, in [, consideringRulerUnits])

select(

[existingSelection])

toSource(

)

→ string

toSpecifier(

)

→ string

transformValuesOf(

in)

→ TransformationMatrix

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)

detach( )

Detaches an overridden master page item from the master page.

duplicate( ) → Guide

Duplicates the Guide.

extractLabel( key) → string

Gets the label value associated with the specified key.

key string The key.

getElements( ) → Guide

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] [, by])

Moves the guide to a new location. Note: Either the to or the by parameter is required; if both parameters are defined, only the to value is used.

`to`	Array<Measurement Unit (Number or String)=any> The new location of the guide, in the format [x, y]. (Optional)
`by`	Array<Measurement Unit (Number or String)=any> The amount to move the guide relative to its current position, in the format [x, y]. (Optional)

override( destinationPage)

Overrides a master page item and places the item on the document page as a new object.

destinationPage Page The document page that contains the master page item to override.

remove( )

Deletes the Guide.

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)

removeOverride( )

Removes the override from a previously overridden master page item.

resolve( location, in [, consideringRulerUnits=false])

Get the coordinates of the given location in the specified coordinate system.

`location`	The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.
`in`	CoordinateSpaces The coordinate space to use.
`consideringRulerUnits`	bool If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional)

select( [existingSelection=SelectionOptions.REPLACE_WITH])

Selects the object.

existingSelection SelectionOptions The selection status of the Guide in relation to previously selected objects. (Optional)

toSource( ) → string

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

toSpecifier( ) → string

Retrieves the object specifier.

transformValuesOf( in) → TransformationMatrix

Get the transformation values of the page item.

`in`	CoordinateSpaces The coordinate space to use