PTHTMLOutputOptions

@interface PTHTMLOutputOptions : NSObject

A class containing options common to ToHtml and ToEpub functions

  • Creates an HTMLOutputCommonOptions object with default settings

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()
  • Use JPG files rather than PNG. This will apply to all generated images. Default is true.

    Declaration

    Objective-C

    - (void)SetPreferJPG:(BOOL)prefer_jpg;

    Swift

    func setPreferJPG(_ prefer_jpg: Bool)

    Parameters

    prefer_jpg

    if true JPG images will be used whenever possible.

  • Specifies the compression quality to use when generating JPEG images.

    Declaration

    Objective-C

    - (void)SetJPGQuality:(unsigned int)quality;

    Swift

    func setJPGQuality(_ quality: UInt32)

    Parameters

    quality

    the JPEG compression quality, from 0(highest compression) to 100(best quality).

  • The output resolution, from 1 to 1000, in Dots Per Inch (DPI) at which to render elements which cannot be directly converted. Default is 140.

    Declaration

    Objective-C

    - (void)SetDPI:(unsigned int)dpi;

    Swift

    func setDPI(_ dpi: UInt32)

    Parameters

    dpi

    the resolution in Dots Per Inch

  • Specifies the maximum image slice size in pixels. Default is 2000000.

    Note

    This setting now will no longer reduce the total number of image pixels. Instead a lower value will just produce more slices and vice versa.

    Note

    Since image compression works better with more pixels a larger max pixels should generally create smaller files.

    Declaration

    Objective-C

    - (void)SetMaximumImagePixels:(unsigned int)max_pixels;

    Swift

    func setMaximumImagePixels(_ max_pixels: UInt32)

    Parameters

    max_pixels

    the maximum number of pixels an image can have

  • Switch between fixed (pre-paginated) and reflowable HTML generation. Default is false.

    Declaration

    Objective-C

    - (void)SetReflow:(BOOL)reflow;

    Swift

    func setReflow(_ reflow: Bool)

    Parameters

    reflow

    if true, generated HTML will be reflowable, otherwise, fixed positioning will be used

  • Set an overall scaling of the generated HTML pages. Default is 1.0.

    Declaration

    Objective-C

    - (void)SetScale:(double)scale;

    Swift

    func setScale(_ scale: Double)

    Parameters

    scale

    a number greater than 0 which is used as a scale factor. For example, calling SetScale(0.5) will reduce the HTML body of the page to half its original size, whereas SetScale(2) will double the HTML body dimensions of the page and will rescale all page content appropriately.

  • Enable the conversion of external URL navigation. Default is false.

    Declaration

    Objective-C

    - (void)SetExternalLinks:(BOOL)enable;

    Swift

    func setExternalLinks(_ enable: Bool)

    Parameters

    enable

    if true, links that specify external URL’s are converted into HTML.

  • Enable the conversion of internal document navigation. Default is false.

    Declaration

    Objective-C

    - (void)SetInternalLinks:(BOOL)enable;

    Swift

    func setInternalLinks(_ enable: Bool)

    Parameters

    enable

    if true, links that specify page jumps are converted into HTML.

  • Controls whether converter optimizes DOM or preserves text placement accuracy. Default is false.

    Declaration

    Objective-C

    - (void)SetSimplifyText:(BOOL)enable;

    Swift

    func setSimplifyText(_ enable: Bool)

    Parameters

    enable

    If true, converter will try to reduce DOM complexity at the expense of text placement accuracy.

  • Generate a XML file that contains additional information about the conversion process. By default no report is generated.

    Declaration

    Objective-C

    - (void)SetReportFile:(NSString *)path;

    Swift

    func setReportFile(_ path: String!)

    Parameters

    path

    The file path to which the XML report is written to.