MixedInkGroups

A collection of mixed ink groups.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

MixedInkGroup [] (index:Number)

Returns the MixedInkGroup with the specified index.

Parameter

Type

Description

index

Number

The index.

MixedInkGroup add (inkList:Array of Ink, inkPercentages:Array of Number, repeatValues:Array of Number, incrementValues:Array of Number, withProperties:Object)

Creates a new mixed ink group.

Parameter

Type

Description

inkList

Array of Ink

The inks to include in the mix.

inkPercentages

Array of Number (range 0 - 100)

The percent of each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)

repeatValues

Array of Number (range 0 - 100)

The number of repetitions for each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)

incrementValues

Array of Number (range 0 - 100)

The increment percent per repetition for each ink. (Range: 0 to 100) Note: The cumulative ink percentage per ink cannot exceed 100.) (Optional)

withProperties

Object

Initial values for properties of the new MixedInkGroup (Optional)

MixedInkGroup anyItem ()

Returns any MixedInkGroup in the collection.

Number count ()

Displays the number of elements in the MixedInkGroup.

MixedInkGroup everyItem ()

Returns every MixedInkGroup in the collection.

MixedInkGroup firstItem ()

Returns the first MixedInkGroup in the collection.

MixedInkGroup item (index:Varies LongInteger String)

Returns the MixedInkGroup with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

MixedInkGroup itemByID (id:Number)

Returns the MixedInkGroup with the specified ID.

Parameter

Type

Description

id

Number

The ID.

MixedInkGroup itemByName (name:String)

Returns the MixedInkGroup with the specified name.

Parameter

Type

Description

name

String

The name.

MixedInkGroup itemByRange (from:Varies LongInteger MixedInkGroup String, to:Varies LongInteger MixedInkGroup String)

Returns the MixedInkGroups within the specified range.

Parameter

Type

Description

from

LongInteger

MixedInkGroup

String

The MixedInkGroup, index, or name at the beginning of the range. Can accept: MixedInkGroup, Long Integer or String.

to

LongInteger

MixedInkGroup

String

The MixedInkGroup, index, or name at the end of the range. Can accept: MixedInkGroup, Long Integer or String.

MixedInkGroup lastItem ()

Returns the last MixedInkGroup in the collection.

MixedInkGroup middleItem ()

Returns the middle MixedInkGroup in the collection.

MixedInkGroup nextItem (obj:MixedInkGroup)

Returns the MixedInkGroup whose index follows the specified MixedInkGroup in the collection.

Parameter

Type

Description

obj

MixedInkGroup

The MixedInkGroup whose index comes before the desired MixedInkGroup.

MixedInkGroup previousItem (obj:MixedInkGroup)

Returns the MixedInkGroup with the index previous to the specified index.

Parameter

Type

Description

obj

MixedInkGroup

The index of the MixedInkGroup that follows the desired MixedInkGroup.

String toSource ()

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

Object of

Application.mixedInkGroups

Document.mixedInkGroups