Groups

A collection of groups.

Methods:

add, count

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Group add (groupItems:Array of PageItem, layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document MasterSpread Page Spread Layer, withProperties:Object)

Create a new Group

Parameter

Type

Description

groupItems

Array of PageItem

A list of page items to group

layer

Layer

The layer on which to create the Group (Optional)

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

Location (Optional)

(default: LocationOptions.UNKNOWN)

reference

Document

MasterSpread

Page

Spread

Layer

Before/after this Group or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (Optional)

withProperties

Object

Initial values for properties of the new Group (Optional)

Number count ()

Displays the number of elements in the Group.

Object of

Document.groups

Button.groups

State.groups

Layer.groups

Spread.groups

Page.groups

MasterSpread.groups

PageItem.groups

Oval.groups

Rectangle.groups

GraphicLine.groups

Polygon.groups

Group.groups

Cell.groups

Table.groups

Text.groups

Character.groups

Word.groups

Line.groups

TextColumn.groups

Paragraph.groups

TextStyleRange.groups

InsertionPoint.groups

TextFrame.groups

Story.groups