K4 InDesign Javascript API Documentation

ColorMixedInkGroups

A collection of mixed ink groups.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
inkList ​[, inkPercentages] ​[, repeatValues] ​[, incrementValues] ​[, withProperties])
  → MixedInkGroup
anyItem(
)
  → MixedInkGroup
count(
)
  → number
everyItem(
)
  → MixedInkGroup
firstItem(
)
  → MixedInkGroup
item(
index)
  → MixedInkGroup
itemByID(
id)
  → MixedInkGroup
itemByName(
name)
  → MixedInkGroup
itemByRange(
from, to)
  → MixedInkGroup
lastItem(
)
  → MixedInkGroup
middleItem(
)
  → MixedInkGroup
nextItem(
obj)
  → MixedInkGroup
previousItem(
obj)
  → MixedInkGroup
toSource(
)
  → string
add(
inkList ​[, inkPercentages] ​[, repeatValues] ​[, incrementValues] ​[, withProperties])
  → MixedInkGroup
Creates a new mixed ink group.
inkList Array<Ink> The inks to include in the mix.
inkPercentages Array<number> The percent of each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
repeatValues Array<number> The number of repetitions for each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
incrementValues Array<number> 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)
anyItem(
)
  → MixedInkGroup
Returns any MixedInkGroup in the collection.
count(
)
  → number
Displays the number of elements in the MixedInkGroup.
everyItem(
)
  → MixedInkGroup
Returns every MixedInkGroup in the collection.
firstItem(
)
  → MixedInkGroup
Returns the first MixedInkGroup in the collection.
item(
index)
  → MixedInkGroup
Returns the MixedInkGroup with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → MixedInkGroup
Returns the MixedInkGroup with the specified ID.
id number The ID.
itemByName(
name)
  → MixedInkGroup
Returns the MixedInkGroup with the specified name.
name string The name.
itemByRange(
from, to)
  → MixedInkGroup
Returns the MixedInkGroups within the specified range.
from The MixedInkGroup, index, or name at the beginning of the range. Can accept: MixedInkGroup, Long Integer or String.
to The MixedInkGroup, index, or name at the end of the range. Can accept: MixedInkGroup, Long Integer or String.
lastItem(
)
  → MixedInkGroup
Returns the last MixedInkGroup in the collection.
middleItem(
)
  → MixedInkGroup
Returns the middle MixedInkGroup in the collection.
nextItem(
obj)
  → MixedInkGroup
Returns the MixedInkGroup whose index follows the specified MixedInkGroup in the collection.
obj MixedInkGroup The MixedInkGroup whose index comes before the desired MixedInkGroup.
previousItem(
obj)
  → MixedInkGroup
Returns the MixedInkGroup with the index previous to the specified index.
obj MixedInkGroup The index of the MixedInkGroup that follows the desired MixedInkGroup.
toSource(
)
  → string
Generates a string which, if executed, will return the MixedInkGroup.