A swatch (color, gradient, tint, or mixed ink).
Go to Property Listing | Method Listing
duplicate, extractLabel, getElements, insertLabel, merge, remove, toSource, toSpecifier
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The unique ID of the Swatch. |
||
|
readonly |
The index of the Swatch within its containing object. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The name of the Swatch. |
||
|
readonly |
The parent of the Swatch (a Application or Document). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
Swatch duplicate ()
Duplicates the Swatch.
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
Swatch getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
Swatch merge (with:Array of Varies Swatches Swatch String)
Merges the specified swatches with the swatch.
|
Parameter |
Type |
Description |
|---|---|---|
|
with |
Array of Swatches |
The swatches to merge. Can accept: Array of Swatches, Swatch or String. |
undefined remove (replacingWith:Swatch)
Deletes the swatch.
|
Parameter |
Type |
Description |
|---|---|---|
|
replacingWith |
The swatch to apply in place of the deleted swatch. (Optional) |
String toSource ()
Generates a string which, if executed, will return the Swatch.
String toSpecifier ()
Retrieves the object specifier.
DropShadowSetting.effectColor
FindChangeDropShadowSetting.effectColor
BevelAndEmbossSetting.highlightColor
FindChangeBevelAndEmbossSetting.highlightColor
InnerGlowSetting.effectColor
FindChangeInnerGlowSetting.effectColor
InnerShadowSetting.effectColor
FindChangeInnerShadowSetting.effectColor
OuterGlowSetting.effectColor
FindChangeOuterGlowSetting.effectColor
SatinSetting.effectColor
FindChangeSatinSetting.effectColor
BevelAndEmbossSetting.shadowColor
FindChangeBevelAndEmbossSetting.shadowColor
Table.startRowStrokeColor
TableStyle.startRowStrokeColor
Table.bottomBorderStrokeColor
TableStyle.bottomBorderStrokeColor
Table.leftBorderStrokeColor
TableStyle.leftBorderStrokeColor
Table.rightBorderStrokeColor
TableStyle.rightBorderStrokeColor
Table.topBorderStrokeColor
TableStyle.topBorderStrokeColor
Cell.innerColumnStrokeColor
Column.innerColumnStrokeColor
Row.innerColumnStrokeColor
Cell.innerRowStrokeColor
Column.innerRowStrokeColor
Row.innerRowStrokeColor
Cell.rightEdgeStrokeColor
Column.rightEdgeStrokeColor
Row.rightEdgeStrokeColor
CellStyle.rightEdgeStrokeColor
Cell.diagonalLineStrokeColor
Column.diagonalLineStrokeColor
Row.diagonalLineStrokeColor
CellStyle.diagonalLineStrokeColor
Table.startColumnFillColor
TableStyle.startColumnFillColor
Table.endColumnFillColor
TableStyle.endColumnFillColor
Table.startRowFillColor
TableStyle.startRowFillColor
Table.endRowFillColor
TableStyle.endRowFillColor
Table.endRowStrokeGapColor
TableStyle.endRowStrokeGapColor
Table.bottomBorderStrokeGapColor
TableStyle.bottomBorderStrokeGapColor
Table.leftBorderStrokeGapColor
TableStyle.leftBorderStrokeGapColor
Table.rightBorderStrokeGapColor
TableStyle.rightBorderStrokeGapColor
Table.topBorderStrokeGapColor
TableStyle.topBorderStrokeGapColor
Table.startColumnStrokeColor
TableStyle.startColumnStrokeColor
Table.endColumnStrokeColor
TableStyle.endColumnStrokeColor
Table.endRowStrokeColor
TableStyle.endRowStrokeColor
Table.startRowStrokeGapColor
TableStyle.startRowStrokeGapColor
Table.startColumnStrokeGapColor
TableStyle.startColumnStrokeGapColor
Table.endColumnStrokeGapColor
TableStyle.endColumnStrokeGapColor
Cell.bottomEdgeStrokeColor
Column.bottomEdgeStrokeColor
Row.bottomEdgeStrokeColor
CellStyle.bottomEdgeStrokeColor
Button.fillColor
ChangeObjectPreference.fillColor
Character.fillColor
CharacterStyle.fillColor
FindObjectPreference.fillColor
FormField.fillColor
GraphicLine.fillColor
Group.fillColor
Image.fillColor
InsertionPoint.fillColor
Line.fillColor
ObjectStyle.fillColor
Oval.fillColor
PageItem.fillColor
PageItemDefault.fillColor
Paragraph.fillColor
ParagraphStyle.fillColor
Polygon.fillColor
Rectangle.fillColor
Story.fillColor
StrokeFillProxySetting.fillColor
Text.fillColor
TextColumn.fillColor
TextDefault.fillColor
TextFrame.fillColor
TextStyleRange.fillColor
Word.fillColor
XmlStory.fillColor
Cell.fillColor
Column.fillColor
Row.fillColor
CellStyle.fillColor
FormField.gapColor
Button.gapColor
PageItem.gapColor
Oval.gapColor
Rectangle.gapColor
GraphicLine.gapColor
Polygon.gapColor
Group.gapColor
ObjectStyle.gapColor
PageItemDefault.gapColor
TextFrame.gapColor
FindObjectPreference.gapColor
ChangeObjectPreference.gapColor
Cell.bottomEdgeStrokeGapColor
Column.bottomEdgeStrokeGapColor
Row.bottomEdgeStrokeGapColor
CellStyle.bottomEdgeStrokeGapColor
Cell.diagonalLineStrokeGapColor
Column.diagonalLineStrokeGapColor
Row.diagonalLineStrokeGapColor
CellStyle.diagonalLineStrokeGapColor
Cell.innerColumnStrokeGapColor
Column.innerColumnStrokeGapColor
Row.innerColumnStrokeGapColor
Cell.innerRowStrokeGapColor
Column.innerRowStrokeGapColor
Row.innerRowStrokeGapColor
Cell.leftEdgeStrokeGapColor
Column.leftEdgeStrokeGapColor
Row.leftEdgeStrokeGapColor
CellStyle.leftEdgeStrokeGapColor
Cell.rightEdgeStrokeGapColor
Column.rightEdgeStrokeGapColor
Row.rightEdgeStrokeGapColor
CellStyle.rightEdgeStrokeGapColor
TextDefault.strikeThroughGapColor
Text.strikeThroughGapColor
Character.strikeThroughGapColor
Word.strikeThroughGapColor
Line.strikeThroughGapColor
TextColumn.strikeThroughGapColor
Paragraph.strikeThroughGapColor
TextStyleRange.strikeThroughGapColor
InsertionPoint.strikeThroughGapColor
Story.strikeThroughGapColor
ParagraphStyle.strikeThroughGapColor
XmlStory.strikeThroughGapColor
FindTextPreference.strikeThroughGapColor
FindGrepPreference.strikeThroughGapColor
ChangeTextPreference.strikeThroughGapColor
ChangeGrepPreference.strikeThroughGapColor
CharacterStyle.strikeThroughGapColor
Cell.topEdgeStrokeGapColor
Column.topEdgeStrokeGapColor
Row.topEdgeStrokeGapColor
CellStyle.topEdgeStrokeGapColor
TextDefault.underlineGapColor
Text.underlineGapColor
Character.underlineGapColor
Word.underlineGapColor
Line.underlineGapColor
TextColumn.underlineGapColor
Paragraph.underlineGapColor
TextStyleRange.underlineGapColor
InsertionPoint.underlineGapColor
Story.underlineGapColor
ParagraphStyle.underlineGapColor
XmlStory.underlineGapColor
FindTextPreference.underlineGapColor
FindGrepPreference.underlineGapColor
ChangeTextPreference.underlineGapColor
ChangeGrepPreference.underlineGapColor
CharacterStyle.underlineGapColor
Cell.leftEdgeStrokeColor
Column.leftEdgeStrokeColor
Row.leftEdgeStrokeColor
CellStyle.leftEdgeStrokeColor
TextDefault.ruleAboveColor
Text.ruleAboveColor
Character.ruleAboveColor
Word.ruleAboveColor
Line.ruleAboveColor
TextColumn.ruleAboveColor
Paragraph.ruleAboveColor
TextStyleRange.ruleAboveColor
InsertionPoint.ruleAboveColor
Story.ruleAboveColor
ParagraphStyle.ruleAboveColor
XmlStory.ruleAboveColor
TextDefault.ruleBelowColor
Text.ruleBelowColor
Character.ruleBelowColor
Word.ruleBelowColor
Line.ruleBelowColor
TextColumn.ruleBelowColor
Paragraph.ruleBelowColor
TextStyleRange.ruleBelowColor
InsertionPoint.ruleBelowColor
Story.ruleBelowColor
ParagraphStyle.ruleBelowColor
XmlStory.ruleBelowColor
FootnoteOption.continuingRuleColor
TextDefault.strikeThroughColor
Text.strikeThroughColor
Character.strikeThroughColor
Word.strikeThroughColor
Line.strikeThroughColor
TextColumn.strikeThroughColor
Paragraph.strikeThroughColor
TextStyleRange.strikeThroughColor
InsertionPoint.strikeThroughColor
Story.strikeThroughColor
ParagraphStyle.strikeThroughColor
XmlStory.strikeThroughColor
FindTextPreference.strikeThroughColor
FindGrepPreference.strikeThroughColor
ChangeTextPreference.strikeThroughColor
ChangeGrepPreference.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
XmlStory.ruleAboveGapColor
TextDefault.ruleBelowGapColor
Text.ruleBelowGapColor
Character.ruleBelowGapColor
Word.ruleBelowGapColor
Line.ruleBelowGapColor
TextColumn.ruleBelowGapColor
Paragraph.ruleBelowGapColor
TextStyleRange.ruleBelowGapColor
InsertionPoint.ruleBelowGapColor
Story.ruleBelowGapColor
ParagraphStyle.ruleBelowGapColor
XmlStory.ruleBelowGapColor
FootnoteOption.continuingRuleGapColor
FootnoteOption.ruleGapColor
Button.strokeColor
ChangeObjectPreference.strokeColor
Character.strokeColor
CharacterStyle.strokeColor
FindObjectPreference.strokeColor
FormField.strokeColor
GraphicLine.strokeColor
Group.strokeColor
InsertionPoint.strokeColor
Line.strokeColor
ObjectStyle.strokeColor
Oval.strokeColor
PageItem.strokeColor
PageItemDefault.strokeColor
Paragraph.strokeColor
ParagraphStyle.strokeColor
Polygon.strokeColor
Rectangle.strokeColor
Story.strokeColor
StrokeFillProxySetting.strokeColor
Text.strokeColor
TextColumn.strokeColor
TextDefault.strokeColor
TextFrame.strokeColor
TextStyleRange.strokeColor
Word.strokeColor
XmlStory.strokeColor
FootnoteOption.ruleColor
Cell.topEdgeStrokeColor
Column.topEdgeStrokeColor
Row.topEdgeStrokeColor
CellStyle.topEdgeStrokeColor
TextDefault.underlineColor
Text.underlineColor
Character.underlineColor
Word.underlineColor
Line.underlineColor
TextColumn.underlineColor
Paragraph.underlineColor
TextStyleRange.underlineColor
InsertionPoint.underlineColor
Story.underlineColor
ParagraphStyle.underlineColor
XmlStory.underlineColor
FindTextPreference.underlineColor
FindGrepPreference.underlineColor
ChangeTextPreference.underlineColor
ChangeGrepPreference.underlineColor
CharacterStyle.underlineColor
Application.unusedSwatches
Document.unusedSwatches