K4 InDesign Javascript API Documentation

ColorTrapPreset

A trap preset.

Instance Properties

Name Description Access
blackColorThreshold number The minimum amount (as a percentage) of black ink required before the black width setting is applied. (Range: 0 to 100) read-write
blackDensity number The neutral density value at or above which an ink is considered black. (Range: .001 to 10) read-write
blackWidth Measurement Unit (Number or String)=any The black width. (Range depends on unit. For points: 0.0 to 8.0; picas: 0p0 to 0p8; inches: 0 to 0.1111; mm: 0 to 2.822; cm: 0 to .2822; ciceros: 0c0 to 0c7.507) read-write
colorReduction number The degree (as a percentage) to which components from abutting colors are used to reduce the trap color. (Range: 0 to 100) Note: 0% makes a trap whose neutral density is equal to the neutral density of the darker color. read-write
defaultTrapWidth Measurement Unit (Number or String)=any The default width for trapping all colors except those involving solid black. (Range depends on unit. For points: 0.0 to 8.0; picas: 0p0 to 0p8; inches: 0 to 0.1111; mm: 0 to 2.822; cm: 0 to .2822; ciceros: 0c0 to 0c7.507) read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the TrapPreset. read-only
imagePlacement TrapImagePlacementTypes The trap placement between vector objects and bitmap images. read-write
imagesToImages bool If true, turns on trapping along the boundary of overlapping or abutting bitmap images. read-write
index number The index of the TrapPreset within its containing object. read-only
internalImages bool If true, turns on trapping among colors within individual bitmap images. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the TrapPreset. read-write
objectsToImages bool If true, ensures that vector objects overlap bitmap images. read-write
oneBitImages bool If true, ensures that one-bit images trap to abutting objects. read-write
parent The parent of the TrapPreset (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
slidingTrapThreshold number The difference (as a percentage) between the neutral densities of abutting colors at which the trap is moved from the darker side of a color edge toward the centerline. (Range: 0 to 100) read-write
stepThreshold number The amount (as a percentage) that components of abutting colors must vary before a trap is created. (Range: 1 to 100) read-write
trapEnd TrapEndTypes The shape to use at the intersection of three-way traps. read-write
trapJoin EndJoin The join type of the trap preset. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
duplicate(
)
  → TrapPreset
extractLabel(
key)
  → string
getElements(
)
  → TrapPreset
insertLabel(
key, value)
remove(
replacingWith)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
duplicate(
)
  → TrapPreset
Duplicates the TrapPreset.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → TrapPreset
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
replacingWith)
Deletes the trap preset.
replacingWith TrapPreset The trap preset to apply in place of the deleted preset.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the TrapPreset.
toSpecifier(
)
  → string
Retrieves the object specifier.