K4 InDesign Javascript API Documentation

PreferencesEPubExportPreference

EPub export preferences.

Extends

Instance Properties

Name Description Access
bottomMargin number Bottom margin of the epub. read-write
breakDocument bool If true, break InDesign document into smaller piece when generating epub. read-write
bulletExportOption BulletListExportOption The bullet export option. read-write
coverImageFile string The epub cover image file path. read-write
customImageSizeOption ImageSizeOption Allows user to select the image size option for conversion read-write
embedFont bool If true, embed font in epub. read-write
epubCover EpubCover The epub cover option. read-write
epubCreator string The epub creator. read-write
epubDate string The epub date. read-write
epubDescription string The epub description. read-write
epubPublisher string The epub publisher. read-write
epubRights string The epub rights. read-write
epubSubject string The epub subject. read-write
epubTitle string The epub title. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
exportOrder ExportOrder The export order. read-write
externalStyleSheets string The file path of external cascading style sheets. read-write
footnotePlacement EPubFootnotePlacement The placement of footnote for EPub export read-write
generateCascadeStyleSheet bool If true, InDesign will generate cascade style sheet. read-write
gifOptionsInterlaced bool If true, generates interlaced GIFs. Note: Not valid when image conversion is JPEG. read-write
gifOptionsPalette GIFOptionsPalette The color palette for GIF conversion. Note: Not valid when image conversion is JPEG. read-write
id string The epub unique identifier, like ISBN. read-write
ignoreObjectConversionSettings bool ignore object level image conversion settings. read-write
imageAlignment ImageAlignmentType Alignment applied to images read-write
imageConversion ImageConversion The file format to use for converted images. Note: Valid only when copy optimized images and/or copy formatted images is true. read-write
imageExportResolution ImageResolution The export resolution read-write
imagePageBreak ImagePageBreakType Image page break settings to be used with objects read-write
imageSpaceAfter number Space After applied to images read-write
imageSpaceBefore number Space Before applied to images read-write
includeClassesInHTML bool If true, InDesign will generate class attributes for elements in HTML, else will generate plain html without class attributes. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
javascripts string The file path of external javascripts. read-write
jpegOptionsFormat JPEGOptionsFormat The formatting method for converted JPEG images. Note: Not valid when image conversion is GIF. read-write
jpegOptionsQuality JPEGOptionsQuality The quality of converted JPEG images. Note: Not valid when image conversion is GIF. read-write
leftMargin number Left margin of the epub. read-write
level number The PNG compression level. read-only
numberedListExportOption NumberedListExportOption The numbered list export option. read-write
paragraphStyleName string The name of paragraph style to break InDesign document. read-write
parent The parent of the EPubExportPreference (a Book or Document). read-only
preserveLayoutAppearence bool If true, format image based on layout appearence. read-write
preserveLocalOverride bool If true, output local style override. read-write
properties Object A property that allows setting of several properties at the same time. read-write
rightMargin number Right margin of the epub. read-write
stripSoftReturn bool If true, strip soft return. read-write
tocStyleName string The name of TOC style to generate epub TOC. read-write
topMargin number Top margin of the epub. read-write
useExistingImageOnExport bool If true, InDesign will use existing image for graphic objects on export. read-write
useImagePageBreak bool If true, image page break settings will be used in objects read-write
version EpubVersion The version of EPUB. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → EPubExportPreference
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)
getElements(
)
  → EPubExportPreference
Resolves the object specifier, creating an array of object references.
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 EPubExportPreference.
toSpecifier(
)
  → string
Retrieves the object specifier.