Adobe InDesign CS6 (8.0) Object Model JS: FlattenerPreset

InDesign CS6

Class

FlattenerPreset

 A preset that contains transparency flattener properties.

QuickLinks

addEventListener, duplicate, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application
FlattenerPreset
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
clipComplexRegionsbool r/wIf true, ensures that the boundaries between vector and rasterized artwork fall along object paths.
convertAllStrokesToOutlinesbool r/wIf true, converts all strokes to outlines and ensures that stroke widths remain constant during flattening. Note: Can cause thin strokes to appear slightly thicker than their original width. Affects all strokes, not only strokes involved in the transparency.
convertAllTextToOutlinesbool r/wIf true, converts all text to outlines and discards all type glyph information on spreads with transparency; ensures that the width of text strokes remains constant during flattening. Note: Can cause small fonts to appear slightly thicker when viewed in Acrobat or printed on low-quality desktop printers, but does not affect type quality when printed on high-resolution printers or imagesetters.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
gradientAndMeshResolutionnumber r/wThe resolution for gradients rasterized as a result of flattening and for drop shadow and feathers when printed or exported. (Range: 0 to 1200) Note: Resolutions higher than 300 ppi increase file size and printing time but generally do not improve the image quality.
idnumber readonlyThe unique ID of the FlattenerPreset.
indexnumber readonlyThe index of the FlattenerPreset within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
lineArtAndTextResolutionnumber r/wThe resolution for vector objects rasterized as a result of flattening. (Range: 1 to 9600) For information, see raster vector balance.
namestring r/wThe name of the FlattenerPreset.
parentApplication readonlyThe parent of the FlattenerPreset (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
rasterVectorBalanceFlattenerLevelReal (0 - 100) r/wThe amount of vector artwork to rasterize during flattening, specified as an enumerator or as a percentage in the range 0 to 100. Can return: FlattenerLevel enumerator or Real (0 - 100).

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

FlattenerPreset duplicate ()
Duplicates the FlattenerPreset.

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

ParameterTypeDescription
keystringThe key.

Array of FlattenerPreset 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.

void remove ()
Deletes the FlattenerPreset.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

EPSExportPreference.appliedFlattenerPreset

PDFExportPreference.appliedFlattenerPreset

PDFExportPreset.appliedFlattenerPreset

Used in:

FlattenerPreset FlattenerPresets.nextItem (obj: FlattenerPreset)

FlattenerPreset FlattenerPresets.previousItem (obj: FlattenerPreset)

Return

FlattenerPreset FlattenerPreset.duplicate ()

Array of FlattenerPreset FlattenerPreset.getElements ()

FlattenerPreset FlattenerPresets.[] (index: number)

FlattenerPreset FlattenerPresets.add ([withProperties: Object])

FlattenerPreset FlattenerPresets.anyItem ()

Array of FlattenerPreset FlattenerPresets.everyItem ()

FlattenerPreset FlattenerPresets.firstItem ()

FlattenerPreset FlattenerPresets.item (index: varies)

FlattenerPreset FlattenerPresets.itemByID (id: number)

FlattenerPreset FlattenerPresets.itemByName (name: string)

Array of FlattenerPreset FlattenerPresets.itemByRange (from: varies, to: varies)

FlattenerPreset FlattenerPresets.lastItem ()

FlattenerPreset FlattenerPresets.middleItem ()

FlattenerPreset FlattenerPresets.nextItem (obj: FlattenerPreset)

FlattenerPreset FlattenerPresets.previousItem (obj: FlattenerPreset)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index