AutofitRelation

AutoFit relation object

Methods:

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

AnchorPoint, Boolean, EventListeners, Events, Graphic, Number, Object, PageItem, String,

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

horizontalDistance

Number

readonly

The horizontal distance between the two points

id

Number

readonly

The unique ID of the AutofitRelation.

index

Number

readonly

The index of the AutofitRelation within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the AutofitRelation; this is an alias to the AutofitRelation's label property.

parent

Document

readonly

The parent of the AutofitRelation (a Document).

properties

Object

read/write

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

sourceAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

readonly

The anchor point of the object from where we want to keep the distance

sourceObject

PageItem

Graphic

readonly

The frame from where we start. Can return: PageItem or Graphic.

targetAnchor

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

readonly

The anchor point of the object to which we want to keep the distance

targetObject

PageItem

Graphic

readonly

The frame to which we want to keep the distance. Can return: PageItem or Graphic.

verticalDistance

Number

readonly

The vertical distance between the two points

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

AutofitRelation getElements ()

Resolves the object specifier, creating an array of object references.

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.

undefined remove ()

Deletes the AutofitRelation.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

AutofitSourceRelations.add()

AutofitTargetRelations.add()

AutofitPageItemRelations.list()

AutofitSourceRelations.list()

AutofitTargetRelations.list()

AutofitDocumentRelations.list()

AutofitDocumentRelations.item()

AutofitPageItemRelations.item()

AutofitSourceRelations.item()

AutofitTargetRelations.item()

AutofitDocumentRelations.get()

AutofitSourceRelations.get()

AutofitTargetRelations.get()

AutofitRelation.getElements()

AutofitRelations.anyItem()

AutofitRelations.everyItem()

AutofitRelations.nextItem()

AutofitRelations.previousItem()

AutofitRelations.itemByID()

AutofitRelations.item()

AutofitRelations.[]()

AutofitRelations.itemByName()

AutofitRelations.itemByRange()

AutofitRelations.firstItem()

AutofitRelations.lastItem()

AutofitRelations.middleItem()

AutofitDocumentRelations.add()