Swatch

Methods:

duplicate, extractLabel, insertLabel, merge, remove

Objects:

Hierarchy:

Class: Swatch

Subclasses: MixedInk | MixedInkGroup | Gradient | Color

Property Listing

Property	Type	Access	Description
id	Number	readonly	The unique ID of the Swatch.
index	Number	readonly	The index of the Swatch within its containing object.
label	String	read/write	A property that can be set to any string.
name	String	read/write	The name of the Swatch.
parent	Application Document	readonly	The parent of the Swatch (a Application or Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.

Method Listing

Swatch duplicate ()

Duplicates the Swatch.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined merge (with:Array of Varies Swatches Swatch String)

Merge one or more other swatches into this one.

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

Parameter

Type

Description

with

Array of Swatches

Swatch

String

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

undefined remove (replacingWith:Swatch)

Delete swatch.

Parameter	Type	Description
replacingWith	Swatch	The swatch to apply in place of this one

Object of

FindPreference.bulletsAndNumberingColor

ChangePreference.bulletsAndNumberingColor

Table.startRowStrokeColor

Table.bottomBorderStrokeColor

Table.leftBorderStrokeColor

Table.rightBorderStrokeColor

Table.topBorderStrokeColor

Cell.innerColumnStrokeColor

Column.innerColumnStrokeColor

Row.innerColumnStrokeColor

Cell.innerRowStrokeColor

Column.innerRowStrokeColor

Row.innerRowStrokeColor

Cell.rightEdgeStrokeColor

Column.rightEdgeStrokeColor

Row.rightEdgeStrokeColor

Cell.diagonalLineStrokeColor

Column.diagonalLineStrokeColor

Row.diagonalLineStrokeColor

Table.startColumnFillColor

Table.endColumnFillColor

Table.startRowFillColor

Table.endRowFillColor

Table.endRowStrokeGapColor

Table.bottomBorderStrokeGapColor

Table.leftBorderStrokeGapColor

Table.rightBorderStrokeGapColor

Table.topBorderStrokeGapColor

Table.startColumnStrokeColor

Table.endColumnStrokeColor

Table.endRowStrokeColor

Table.startRowStrokeGapColor

Table.startColumnStrokeGapColor

Table.endColumnStrokeGapColor

FormField.shadowColor

Button.shadowColor

PageItem.shadowColor

Oval.shadowColor

Rectangle.shadowColor

GraphicLine.shadowColor

Polygon.shadowColor

Group.shadowColor

Image.shadowColor

EPS.shadowColor

PDF.shadowColor

WMF.shadowColor

PICT.shadowColor

TextFrame.shadowColor

Cell.bottomEdgeStrokeColor

Column.bottomEdgeStrokeColor

Row.bottomEdgeStrokeColor

Button.fillColor

Character.fillColor

CharacterStyle.fillColor

FormField.fillColor

GraphicLine.fillColor

Group.fillColor

Image.fillColor

InsertionPoint.fillColor

Line.fillColor

Oval.fillColor

PageItem.fillColor

Paragraph.fillColor

ParagraphStyle.fillColor

Polygon.fillColor

Rectangle.fillColor

Story.fillColor

Text.fillColor

TextColumn.fillColor

TextDefault.fillColor

TextFrame.fillColor

TextStyleRange.fillColor

Word.fillColor

Cell.fillColor

Column.fillColor

Row.fillColor

FormField.gapColor

Button.gapColor

PageItem.gapColor

Oval.gapColor

Rectangle.gapColor

GraphicLine.gapColor

Polygon.gapColor

Group.gapColor

TextFrame.gapColor

Cell.bottomEdgeStrokeGapColor

Column.bottomEdgeStrokeGapColor

Row.bottomEdgeStrokeGapColor

Cell.diagonalLineStrokeGapColor

Column.diagonalLineStrokeGapColor

Row.diagonalLineStrokeGapColor

Cell.innerColumnStrokeGapColor

Column.innerColumnStrokeGapColor

Row.innerColumnStrokeGapColor

Cell.innerRowStrokeGapColor

Column.innerRowStrokeGapColor

Row.innerRowStrokeGapColor

Cell.leftEdgeStrokeGapColor

Column.leftEdgeStrokeGapColor

Row.leftEdgeStrokeGapColor

Cell.rightEdgeStrokeGapColor

Column.rightEdgeStrokeGapColor

Row.rightEdgeStrokeGapColor

TextDefault.strikeThroughGapColor

Text.strikeThroughGapColor

Character.strikeThroughGapColor

Word.strikeThroughGapColor

Line.strikeThroughGapColor

TextColumn.strikeThroughGapColor

Paragraph.strikeThroughGapColor

TextStyleRange.strikeThroughGapColor

InsertionPoint.strikeThroughGapColor

Story.strikeThroughGapColor

ParagraphStyle.strikeThroughGapColor

FindPreference.strikeThroughGapColor

ChangePreference.strikeThroughGapColor

CharacterStyle.strikeThroughGapColor

Cell.topEdgeStrokeGapColor

Column.topEdgeStrokeGapColor

Row.topEdgeStrokeGapColor

TextDefault.underlineGapColor

Text.underlineGapColor

Character.underlineGapColor

Word.underlineGapColor

Line.underlineGapColor

TextColumn.underlineGapColor

Paragraph.underlineGapColor

TextStyleRange.underlineGapColor

InsertionPoint.underlineGapColor

Story.underlineGapColor

ParagraphStyle.underlineGapColor

FindPreference.underlineGapColor

ChangePreference.underlineGapColor

CharacterStyle.underlineGapColor

Cell.leftEdgeStrokeColor

Column.leftEdgeStrokeColor

Row.leftEdgeStrokeColor

TextDefault.ruleAboveColor

Text.ruleAboveColor

Character.ruleAboveColor

Word.ruleAboveColor

Line.ruleAboveColor

TextColumn.ruleAboveColor

Paragraph.ruleAboveColor

TextStyleRange.ruleAboveColor

InsertionPoint.ruleAboveColor

Story.ruleAboveColor

ParagraphStyle.ruleAboveColor

TextDefault.ruleBelowColor

Text.ruleBelowColor

Character.ruleBelowColor

Word.ruleBelowColor

Line.ruleBelowColor

TextColumn.ruleBelowColor

Paragraph.ruleBelowColor

TextStyleRange.ruleBelowColor

InsertionPoint.ruleBelowColor

Story.ruleBelowColor

ParagraphStyle.ruleBelowColor

TextDefault.strikeThroughColor

Text.strikeThroughColor

Character.strikeThroughColor

Word.strikeThroughColor

Line.strikeThroughColor

TextColumn.strikeThroughColor

Paragraph.strikeThroughColor

TextStyleRange.strikeThroughColor

InsertionPoint.strikeThroughColor

Story.strikeThroughColor

ParagraphStyle.strikeThroughColor

FindPreference.strikeThroughColor

ChangePreference.strikeThroughColor

CharacterStyle.strikeThroughColor

TextDefault.ruleAboveGapColor

Text.ruleAboveGapColor

Character.ruleAboveGapColor

Word.ruleAboveGapColor

Line.ruleAboveGapColor

TextColumn.ruleAboveGapColor

Paragraph.ruleAboveGapColor

TextStyleRange.ruleAboveGapColor

InsertionPoint.ruleAboveGapColor

Story.ruleAboveGapColor

ParagraphStyle.ruleAboveGapColor

TextDefault.ruleBelowGapColor

Text.ruleBelowGapColor

Character.ruleBelowGapColor

Word.ruleBelowGapColor

Line.ruleBelowGapColor

TextColumn.ruleBelowGapColor

Paragraph.ruleBelowGapColor

TextStyleRange.ruleBelowGapColor

InsertionPoint.ruleBelowGapColor

Story.ruleBelowGapColor

ParagraphStyle.ruleBelowGapColor

Button.strokeColor

Character.strokeColor

CharacterStyle.strokeColor

FormField.strokeColor

GraphicLine.strokeColor

Group.strokeColor

InsertionPoint.strokeColor

Line.strokeColor

Oval.strokeColor

PageItem.strokeColor

Paragraph.strokeColor

ParagraphStyle.strokeColor

Polygon.strokeColor

Rectangle.strokeColor

Story.strokeColor

Text.strokeColor

TextColumn.strokeColor

TextDefault.strokeColor

TextFrame.strokeColor

TextStyleRange.strokeColor

Word.strokeColor

Cell.topEdgeStrokeColor

Column.topEdgeStrokeColor

Row.topEdgeStrokeColor

TextDefault.underlineColor

Text.underlineColor

Character.underlineColor

Word.underlineColor

Line.underlineColor

TextColumn.underlineColor

Paragraph.underlineColor

TextStyleRange.underlineColor

InsertionPoint.underlineColor

Story.underlineColor

ParagraphStyle.underlineColor

FindPreference.underlineColor

ChangePreference.underlineColor

CharacterStyle.underlineColor

Application.unusedSwatches

Document.unusedSwatches

Return

Swatch.duplicate()