Class
EPub export preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
EPubExportPreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| applyImageAlignmentToAnchoredObjectSettings | bool | r/w | apply image alignment to anchored object settings. |
| bottomMargin | number | r/w | Bottom margin of the epub. |
| breakDocument | bool | r/w | If true, break InDesign document into smaller piece when generating epub. |
| bulletExportOption | BulletListExportOption: BulletListExportOption.UNORDERED_LIST BulletListExportOption.AS_TEXT |
r/w | The bullet export option. |
| coverImageFile | string | r/w | The epub cover image file path. |
| customImageSizeOption | ImageSizeOption: ImageSizeOption.SIZE_FIXED ImageSizeOption.SIZE_RELATIVE_TO_PAGE_WIDTH |
r/w | Allows user to select the image size option for conversion |
| embedFont | bool | r/w | If true, embed font in epub. |
| epubCover | EpubCover: EpubCover.NONE EpubCover.FIRST_PAGE EpubCover.EXTERNAL_IMAGE |
r/w | The epub cover option. |
| epubPublisher | string | r/w | The epub publisher. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| exportOrder | ExportOrder: ExportOrder.LAYOUT_ORDER ExportOrder.ARTICLE_PANEL_ORDER ExportOrder.XML_STRUCTURE_ORDER |
r/w | The export order. |
| externalStyleSheets | Array of string | r/w | The file path of external cascading style sheets. |
| footnoteFollowParagraph | bool | r/w | If true, output footnote immediately after its paragraph. |
| gifOptionsInterlaced | bool | r/w | If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. |
| gifOptionsPalette | GIFOptionsPalette: GIFOptionsPalette.ADAPTIVE_PALETTE GIFOptionsPalette.MACINTOSH_PALETTE GIFOptionsPalette.WEB_PALETTE GIFOptionsPalette.WINDOWS_PALETTE |
r/w | The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. |
| id | string | r/w | The epub unique identifier, like ISBN. |
| ignoreObjectConversionSettings | bool | r/w | ignore object level image conversion settings. |
| imageAlignment | ImageAlignmentType: ImageAlignmentType.ALIGN_LEFT ImageAlignmentType.ALIGN_CENTER ImageAlignmentType.ALIGN_RIGHT |
r/w | Alignment applied to images |
| imageConversion | ImageConversion: ImageConversion.AUTOMATIC ImageConversion.JPEG ImageConversion.GIF ImageConversion.PNG |
r/w | The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true. |
| imageExportResolution | ImageResolution: ImageResolution.PPI_72 ImageResolution.PPI_96 ImageResolution.PPI_150 ImageResolution.PPI_300 |
r/w | The export resolution |
| imagePageBreak | ImagePageBreakType: ImagePageBreakType.PAGE_BREAK_BEFORE ImagePageBreakType.PAGE_BREAK_AFTER ImagePageBreakType.PAGE_BREAK_BEFORE_AND_AFTER |
r/w | Image page break settings to be used with objects |
| imageSpaceAfter | number (range: 0 - 8640) | r/w | Space After applied to images |
| imageSpaceBefore | number (range: 0 - 8640) | r/w | Space Before applied to images |
| includeCSSDefinition | bool | r/w | If true, include CSS definition. |
| includeDocumentMetadata | bool | r/w | If true, output document metadata into epub. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| javascripts | Array of string | r/w | The file path of external javascripts. |
| jpegOptionsFormat | JPEGOptionsFormat: JPEGOptionsFormat.BASELINE_ENCODING JPEGOptionsFormat.PROGRESSIVE_ENCODING |
r/w | The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. |
| jpegOptionsQuality | JPEGOptionsQuality: JPEGOptionsQuality.LOW JPEGOptionsQuality.MEDIUM JPEGOptionsQuality.HIGH JPEGOptionsQuality.MAXIMUM |
r/w | The quality of converted JPEG images. Note: Not valid when image conversion is GIF. |
| leftMargin | number | r/w | Left margin of the epub. |
| level | number | r/w | The PNG compression level. |
| numberedListExportOption | NumberedListExportOption: NumberedListExportOption.ORDERED_LIST NumberedListExportOption.STATIC_ORDERED_LIST NumberedListExportOption.AS_TEXT |
r/w | The numbered list export option. |
| paragraphStyleName | string | r/w | The name of paragraph style to break InDesign document. |
| parent | Book Document |
readonly | The parent of the EPubExportPreference (a Book or Document). |
| preserveLayoutAppearence | bool | r/w | If true, format image based on layout appearence. |
| preserveLocalOverride | bool | r/w | If true, output local style override. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rightMargin | number | r/w | Right margin of the epub. |
| stripSoftReturn | bool | r/w | If true, strip soft return. |
| tocStyleName | string | r/w | The name of TOC style to generate epub TOC. |
| topMargin | number | r/w | Top margin of the epub. |
| useImagePageBreak | bool | r/w | If true, image page break settings will be used in objects |
| version | EpubVersion: EpubVersion.EPUB2 EpubVersion.EPUB3 EpubVersion.EPUB3_WITH_LAYOUT |
r/w | The version of EPUB. |
| viewDocumentAfterExport | bool | r/w | If true, open docuemnt in viewer after export. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the EPubExportPreference.
Element of
Book.epubExportPreferences
Document.epubExportPreferences
Return
Array of EPubExportPreference EPubExportPreference.getElements ()
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |