Adobe InDesign CS6 (8.0) Object Model JS: EPubExportPreference

InDesign CS6

Class

EPubExportPreference

 EPub export preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Book | Document
Preference
EPubExportPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
applyImageAlignmentToAnchoredObjectSettingsbool r/wapply image alignment to anchored object settings.
bottomMarginnumber r/wBottom margin of the epub.
breakDocumentbool r/wIf true, break InDesign document into smaller piece when generating epub.
bulletExportOptionBulletListExportOption:
BulletListExportOption.UNORDERED_LIST
BulletListExportOption.AS_TEXT
r/wThe bullet export option.
coverImageFilestring r/wThe epub cover image file path.
customImageSizeOptionImageSizeOption:
ImageSizeOption.SIZE_FIXED
ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH
r/wAllows user to select the image size option for conversion
embedFontbool r/wIf true, embed font in epub.
epubCoverEpubCover:
EpubCover.NONE
EpubCover.FIRST_PAGE
EpubCover.EXTERNAL_IMAGE
r/wThe epub cover option.
epubPublisherstring r/wThe epub publisher.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
exportOrderExportOrder:
ExportOrder.LAYOUT_ORDER
ExportOrder.ARTICLE_PANEL_ORDER
ExportOrder.XML_STRUCTURE_ORDER
r/wThe export order.
externalStyleSheetsArray of string r/wThe file path of external cascading style sheets.
footnoteFollowParagraphbool r/wIf true, output footnote immediately after its paragraph.
gifOptionsInterlacedbool r/wIf true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG.
gifOptionsPaletteGIFOptionsPalette:
GIFOptionsPalette.ADAPTIVE_PALETTE
GIFOptionsPalette.MACINTOSH_PALETTE
GIFOptionsPalette.WEB_PALETTE
GIFOptionsPalette.WINDOWS_PALETTE
r/wThe color palette for GIF conversion. Note: Not valid when image conversion is JPEG.
idstring r/wThe epub unique identifier, like ISBN.
ignoreObjectConversionSettingsbool r/wignore object level image conversion settings.
imageAlignmentImageAlignmentType:
ImageAlignmentType.ALIGN_LEFT
ImageAlignmentType.ALIGN_CENTER
ImageAlignmentType.ALIGN_RIGHT
r/wAlignment applied to images
imageConversionImageConversion:
ImageConversion.AUTOMATIC
ImageConversion.JPEG
ImageConversion.GIF
ImageConversion.PNG
r/wThe file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true.
imageExportResolutionImageResolution:
ImageResolution.PPI_72
ImageResolution.PPI_96
ImageResolution.PPI_150
ImageResolution.PPI_300
r/wThe export resolution
imagePageBreakImagePageBreakType:
ImagePageBreakType.PAGE_BREAK_BEFORE
ImagePageBreakType.PAGE_BREAK_AFTER
ImagePageBreakType.PAGE_BREAK_BEFORE_AND_AFTER
r/wImage page break settings to be used with objects
imageSpaceAfternumber (range: 0 - 8640) r/wSpace After applied to images
imageSpaceBeforenumber (range: 0 - 8640) r/wSpace Before applied to images
includeCSSDefinitionbool r/wIf true, include CSS definition.
includeDocumentMetadatabool r/wIf true, output document metadata into epub.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
javascriptsArray of string r/wThe file path of external javascripts.
jpegOptionsFormatJPEGOptionsFormat:
JPEGOptionsFormat.BASELINE_ENCODING
JPEGOptionsFormat.PROGRESSIVE_ENCODING
r/wThe formatting method for converted JPEG images. Note: Not valid when image conversion is GIF.
jpegOptionsQualityJPEGOptionsQuality:
JPEGOptionsQuality.LOW
JPEGOptionsQuality.MEDIUM
JPEGOptionsQuality.HIGH
JPEGOptionsQuality.MAXIMUM
r/wThe quality of converted JPEG images. Note: Not valid when image conversion is GIF.
leftMarginnumber r/wLeft margin of the epub.
levelnumber r/wThe PNG compression level.
numberedListExportOptionNumberedListExportOption:
NumberedListExportOption.ORDERED_LIST
NumberedListExportOption.STATIC_ORDERED_LIST
NumberedListExportOption.AS_TEXT
r/wThe numbered list export option.
paragraphStyleNamestring r/wThe name of paragraph style to break InDesign document.
parentBook
Document
readonlyThe parent of the EPubExportPreference (a Book or Document).
preserveLayoutAppearencebool r/wIf true, format image based on layout appearence.
preserveLocalOverridebool r/wIf true, output local style override.
propertiesObject r/wA property that allows setting of several properties at the same time.
rightMarginnumber r/wRight margin of the epub.
stripSoftReturnbool r/wIf true, strip soft return.
tocStyleNamestring r/wThe name of TOC style to generate epub TOC.
topMarginnumber r/wTop margin of the epub.
useImagePageBreakbool r/wIf true, image page break settings will be used in objects
versionEpubVersion:
EpubVersion.EPUB2
EpubVersion.EPUB3
EpubVersion.EPUB3_WITH_LAYOUT
r/wThe version of EPUB.
viewDocumentAfterExportbool r/wIf true, open docuemnt in viewer after export.

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)

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

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 EPubExportPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Book.epubExportPreferences

Document.epubExportPreferences

Return

Array of EPubExportPreference EPubExportPreference.getElements ()

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