Adobe InDesign CS2 (4.0) Object Model JS: Tint

InDesign CS2

Class

Tint

 A tint swatch. Base Class: Color

QuickLinks

duplicate, extractLabel, getElements, insertLabel, merge, remove, toSource, toSpecifier

Hierarchy

Application | Document
Color
Tint

Properties

PropertyTypeAccessDescription
baseColorColor readonlyThe color that the tint is based on.
colorValue Array of number r/wThe ink values that create the color, specified as a percentage for each ink. Note: The number of values required and the range depends on the color space. For RGB, specify three values, with each value in the range 0 to 255; for CMYK, specify four values representing C, M, Y, and K, with each value in the range 0 to 100; for LAB, specify three values representing L (Range: 0 to 100), A (Range: -128 to 127), and B (Range: -128 to 127); for mixed ink, specify values for each ink in the ink list, with each value in the range 0 to 100.
idnumber readonlyThe unique ID of the Tint.
indexnumber readonlyThe index of the Tint within its containing object.
labelstring r/wA property that can be set to any string.
modelColorModel:
ColorModel.SPOT
ColorModel.PROCESS
ColorModel.REGISTRATION
ColorModel.MIXEDINKMODEL
r/wThe color model.
namestring readonlyThe name of the Tint.
parentApplication
Document
readonlyThe parent of the Tint (a Application or Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
spaceColorSpace:
ColorSpace.RGB
ColorSpace.CMYK
ColorSpace.LAB
ColorSpace.MIXEDINK
r/wThe color space.
tintValuenumber (range: 0 - 100) r/wThe percent of the base color. (Range: 0 to 100)

Methods

Instances

Tint duplicate ()
Duplicates the Tint.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Swatch merge (with: any)
Merges the specified swatches with the swatch.

ParameterTypeDescription
with Array of Swatches
String
Swatch
The swatches to merge. Can accept: Array of Swatches, Swatch or String.

void remove ([replacingWith: Swatch])
Deletes the swatch.

ParameterTypeDescription
replacingWithSwatchThe swatch to apply in place of the deleted swatch. (Optional)

string toSource ()
Generates a string which, if executed, will return the Tint.

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of Tint Tints.itemByRange (from: any, to: any)

Tint Tints.nextItem (obj: Tint)

Tint Tints.previousItem (obj: Tint)

Return

Tint Tint.duplicate ()

Tint Tints.add ([color: Color][, withProperties: Object])

Tint Tints.anyItem ()

Array of Tint Tints.everyItem ()

Tint Tints.firstItem ()

Tint Tints.item (index: any)

Tint Tints.itemByID (id: number)

Tint Tints.itemByName (name: string)

Array of Tint Tints.itemByRange (from: any, to: any)

Tint Tints.lastItem ()

Tint Tints.middleItem ()

Tint Tints.nextItem (obj: Tint)

Tint Tints.previousItem (obj: Tint)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index