AutofitDocumentRelations

Proxy object for methods related to AutoFit relations on the document level

Methods:

add, addEventListener, count, exist, get, getElements, item, list, remove, removeEventListener, resetAllToDefaults, toSource, toSpecifier

Hierarchy:

Superclass: Preference

Class: AutofitDocumentRelations

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

AutofitDocumentSettings

readonly

The parent of the AutofitDocumentRelations (a AutofitDocumentSettings).

properties

Object

read/write

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

Method Listing

AutofitRelation add (sourceObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetObject:Varies PageItem Graphic, targetAnchor:AnchorPoint, withProperties:Object)

Try to add a relation for the given parameters. May give an error

Parameter

Type

Description

sourceObject

PageItem

Graphic

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

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

The anchor point of this object to link from

targetObject

PageItem

Graphic

The page item to link to. Can accept: 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

The anchor point of the other object to link to

withProperties

Object

Initial values for properties of the new AutofitDocumentRelations (Optional)

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)

Number count (sourceObject:Varies PageItem Graphic, targetObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint)

Get the number of AutoFit relations. Could be limited by the given parameters

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where we start. Can accept: PageItem or Graphic. (Optional)

targetObject

PageItem

Graphic

The page item to link to. Can accept: PageItem or Graphic. (Optional)

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

The anchor point of this object to link from (Optional)

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

The anchor point of the other object to link to (Optional)

Boolean exist (sourceObject:Varies PageItem Graphic, targetObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint)

Test whether some AutoFit relation exists. Could be limited by the given parameters

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where we start. Can accept: PageItem or Graphic. (Optional)

targetObject

PageItem

Graphic

The page item to link to. Can accept: PageItem or Graphic. (Optional)

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

The anchor point of this object to link from (Optional)

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

The anchor point of the other object to link to (Optional)

AutofitRelation get (sourceObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetObject:Varies PageItem Graphic, targetAnchor:AnchorPoint)

Get the relation for the given parameters

Parameter

Type

Description

sourceObject

PageItem

Graphic

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

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

The anchor point of this object to link from

targetObject

PageItem

Graphic

The page item to link to. Can accept: 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

The anchor point of the other object to link to

AutofitDocumentRelations getElements ()

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

AutofitRelation item (index:Number)

Get the nth relation from AutofitDocumentRelations

Parameter

Type

Description

index

Number

The index into the list of AutofitDocumentRelations

AutofitRelation list (sourceObject:Varies PageItem Graphic, targetObject:Varies PageItem Graphic, sourceAnchor:AnchorPoint, targetAnchor:AnchorPoint)

Get the list of AutoFit relations of AutofitDocumentRelations. Could be limited by the given parameters

Parameter

Type

Description

sourceObject

PageItem

Graphic

The frame from where we start. Can accept: PageItem or Graphic. (Optional)

targetObject

PageItem

Graphic

The page item to link to. Can accept: PageItem or Graphic. (Optional)

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

The anchor point of this object to link from (Optional)

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

The anchor point of the other object to link to (Optional)

undefined remove (relations:Array of AutofitRelation)

Delete the provided relations or all relations

Parameter

Type

Description

relations

Array of AutofitRelation

The optional list of relations to be deleted (Optional)

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)

undefined resetAllToDefaults ()

Reset the AutoFit specific data of AutofitDocumentRelations to the default values

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

AutofitDocumentSettings.relations

Event.parent

EventListener.parent

MutationEvent.parent

Return

AutofitDocumentRelations.getElements()