JavaScript Support · Prince Documentation

Prince supports most of ECMAScript 5th edition, but not strict mode. Later editions of ECMAScript are not supported.

The following table shows supported JavaScript objects, methods and properties. For more details, see also JavaScript in Prince.

* objects, methods and properties marked with an asterisk are Prince extensions.

Toggle (open/close) all properties

window

object

The global object

NaN

number

The special value Not a Number.

Infinity

number

The special value Infinity.

undefined

Represents the special value undefined.

evalsource

function

Evaluates text as JavaScript source code.

source
string
Code to evaluate

Result of evaluation

parseIntvalue, radix

function

Turns input into an integer number.

value
string
radix
number
Indicates number base, for example 10 to parse input as a decimal value, 16 for hex values.

number

parseInt('50')50

parseFloat

function

Turns input into a floating point number.

number

parseFloat('1.5')1.5

isNaN

function

Checks if the argument's value is the special Not a Number value.

boolean

isNaN(parseInt('hello'))true

isFinite

function

Determines whether the passed value is a finite number.

boolean

escapestring

function

Computes a new string by replacing certain characters with a hexadecimal escape sequence.

string
string
String to escape

string

unescapestring

function

Computes a new string by replacing hexadecimal escape sequences with the characters they represent.

string
string
String to unescape

string

decodeURIURI

function

Decodes a Uniform Resource Identifier (URI).

URI
string
A complete URI

string

decodeURIComponentURI

function

Decodes a Uniform Resource Identifier (URI) component.

URI
string
A component of a URI

string

encodeURIURI

function

Encodes a Uniform Resource Identifier (URI).

URI
string
A complete URI

string

encodeURIComponentURI

function

Encodes a Uniform Resource Identifier (URI) component.

URI
string
A component of a URI

string

toString

function

string

toLocaleString

function

Converts an object to a string with a language sensitive representation of said string.

string

valueOf

function

Returns the primitive value an object.

primitive value

hasOwnPropertyproperty

function

Returns a boolean indicating whether the object has the specified property.

property
string
The property to test

boolean

isPrototypeOf

function

Checks if an object exists in another object's prototype chain.

boolean

propertyIsEnumerable

function

Returns a Boolean indicating whether the specified property is enumerable.

boolean

Object

function

assign

function

create

function

definePropertybase object, property name, descriptor

function

Adds a property to the object and defines certain traits like enumerability.

base object
object
property name
string
descriptor
object
An object describing the property

Object.defineProperty(Array.prototype, 'myProp',
  {enumerable: false})

defineProperties

function

freeze

function

is

function

isExtensible

function

isFrozen

function

isSealed

function

keys

function

getOwnPropertyDescriptor

function

getOwnPropertyNames

function

getOwnPropertySymbols

function

getPrototypeOf

function

preventExtensions

function

seal

function

setPrototypeOf

function

prototype

object

toString

function

toLocaleString

function

valueOf

function

hasOwnProperty

function

isPrototypeOf

function

propertyIsEnumerable

function

Function

function

prototype

function

toString

function

apply

function

bindnew this object

function

Defines a value for the this object, returns a new function.

new this object
object

function

var myObj = {};
function myFunc(){return this===myObj;};
var boundFunc = myFunc.bind(myObj);
boundFunc();true

call

function

Array

function

isArray

function

from

function

of

function

prototype

object

length

number

toString

function

toLocaleString

function

join

function

concat

function

pop

function

push

function

reverse

function

shift

function

unshift

function

find

function

findIndex

function

sort

function

slice

function

splice

function

indexOf

function

lastIndexOf

function

forEach

function

map

function

filter

function

includes

function

every

function

some

function

reduce

function

fill

function

reduceRight

function

Map

function

prototype

object

size

clear

function

deletekey

function

key
string

getkey

function

key
string

haskey

function

key
string

setkey, value

function

key
string
value
string

keys

function

values

function

entries

function

forEachcallbackFn, thisArg

function

callbackFn
function
thisArg
argument

String

function

fromCharCode

function

fromCodePoint

function

CodePointAt

raw

function

prototype

object

length

number

toString

function

valueOf

function

charAt

function

charCodeAt

function

concat

function

includes

function

indexOf

function

lastIndexOf

function

localeCompare

function

split

function

toLowerCase

function

toLocaleLowerCase

function

toUpperCase

function

toLocaleUpperCase

function

match

function

repeat

function

replace

function

search

function

slice

function

startsWith

function

endsWith

function

substring

function

substr

function

trim

function

Boolean

function

prototype

object

toString

function

valueOf

function

Number

function

NaN

number

POSITIVE_INFINITY

number

NEGATIVE_INFINITY

number

MIN_VALUE

number

MAX_VALUE

number

MIN_SAFE_INTEGER

number

MAX_SAFE_INTEGER

number

prototype

object

toExponential

function

toString

function

valueOf

function

toFixed

function

toPrecision

function

Date

function

parse

function

UTC

function

now

function

prototype

object

toString

function

toDateString

function

toTimeString

function

toUTCString

function

toISOString

function

valueOf

function

getTime

function

getFullYear

function

getMonth

function

getDate

function

getDay

function

getHours

function

getMinutes

function

getSeconds

function

getMilliseconds

function

getUTCFullYear

function

getUTCMonth

function

getUTCDate

function

getUTCDay

function

getUTCHours

function

getUTCMinutes

function

getUTCSeconds

function

getUTCMilliseconds

function

setTime

function

setMilliseconds

function

setSeconds

function

setMinutes

function

setHours

function

setDate

function

setMonth

function

setFullYear

function

setUTCMilliseconds

function

setUTCSeconds

function

setUTCMinutes

function

setUTCHours

function

setUTCDate

function

setUTCMonth

function

setUTCFullYear

function

RegExp

function

prototype

object

exec

function

test

function

toString

function

Math

object

E

number

LN10

number

LN2

number

LOG2E

number

LOG10E

number

PI

number

SQRT1_2

number

SQRT2

number

abs

function

acos

function

asin

function

atan

function

atan2

function

ceil

function

cos

function

exp

function

floor

function

log

function

max

function

min

function

pow

function

random

function

seedRandom

round

function

sin

function

sqrt

function

tan

function

JSON

object

parse

function

stringify

function

Error

function

prototype

object

name

string

message

string

stack

RangeError

function

prototype

object

name

string

message

string

ReferenceError

function

prototype

object

name

string

message

string

SyntaxError

function

prototype

object

name

string

message

string

TypeError

function

prototype

object

name

string

message

string

URIError

function

prototype

object

name

string

message

string

window

object

_is_root

self

object

_is_root

top

object

_is_root

parent

object

_is_root

setTimeout

function

clearTimeout

function

alert

function

addEventListener

function

removeEventListener

function

dispatchEvent

function

getComputedStyle

function

navigator

object

appName

string

appVersion

string

platform

string

userAgent

string

onLine

boolean

console

object

log

function

info

function

warn

function

frames

object

ArrayBuffer

function

prototype

object

byteLength

slice

function

Uint8Array

function

BYTES_PER_ELEMENT

number

from

function

prototype

object

BYTES_PER_ELEMENT

number

length

number

set

function

subarray

function

Uint8ClampedArray

function

BYTES_PER_ELEMENT

number

from

function

prototype

object

BYTES_PER_ELEMENT

number

length

number

set

function

subarray

function

Uint16Array

function

BYTES_PER_ELEMENT

number

from

function

prototype

object

BYTES_PER_ELEMENT

number

length

number

set

function

subarray

function

Uint32Array

function

BYTES_PER_ELEMENT

number

from

function

prototype

object

BYTES_PER_ELEMENT

number

length

number

set

function

subarray

function

Int8Array

function

BYTES_PER_ELEMENT

number

from

function

prototype

object

BYTES_PER_ELEMENT

number

length

number

set

function

subarray

function

Int16Array

function

BYTES_PER_ELEMENT

number

from

function

prototype

object

BYTES_PER_ELEMENT

number

length

number

set

function

subarray

function

Int32Array

function

BYTES_PER_ELEMENT

number

from

function

prototype

object

BYTES_PER_ELEMENT

number

length

number

set

function

subarray

function

XMLHttpRequest

function

UNSENT

number

OPENED

number

HEADERS_RECEIVED

number

LOADING

number

DONE

number

prototype

object

UNSENT

number

OPENED

number

HEADERS_RECEIVED

number

LOADING

number

DONE

number

open

function

send

function

readyState

function

response

function

responseText

function

responseType

function

status

function

EventTarget

function

prototype

object

addEventListener

function

removeEventListener

function

dispatchEvent

function

Event

function

prototype

object

ProgressEvent

function

prototype

object

Node

function

ELEMENT_NODE

number

ATTRIBUTE_NODE

number

TEXT_NODE

number

DOCUMENT_NODE

number

DOCUMENT_FRAGMENT_NODE

number

DOCUMENT_POSITION_DISCONNECTED

number

DOCUMENT_POSITION_PRECEDING

number

DOCUMENT_POSITION_FOLLOWING

number

DOCUMENT_POSITION_CONTAINS

number

DOCUMENT_POSITION_CONTAINED_BY

number

prototype

object

ELEMENT_NODE

number

ATTRIBUTE_NODE

number

TEXT_NODE

number

DOCUMENT_NODE

number

DOCUMENT_FRAGMENT_NODE

number

DOCUMENT_POSITION_DISCONNECTED

number

DOCUMENT_POSITION_PRECEDING

number

DOCUMENT_POSITION_FOLLOWING

number

DOCUMENT_POSITION_CONTAINS

number

DOCUMENT_POSITION_CONTAINED_BY

number

ownerDocument

number

textContent

number

firstChild

number

lastChild

number

previousSibling

number

nextSibling

number

parentElement

number

parentNode

number

removeChild

function

appendChild

function

insertBefore

function

replaceChild

function

hasChildNodes

function

hasAttributes

contains

function

compareDocumentPosition

function

cloneNode

function

Document

function

prototype

object

implementation

documentElement

firstElementChild

lastElementChild

childElementCount

readyState

getElementsByTagName

function

getElementsByTagNameNS

function

getElementsByClassName

function

querySelector

function

querySelectorAll

function

getElementById

function

createElement

function

createElementNS

function

createAttribute

function

createAttributeNS

function

createTextNode

function

createComment

function

createDocumentFragment

function

nodeName

function

nodeType

function

attributes

namespaceURI

localName

compatMode

DocumentFragment

function

prototype

object

nodeName

nodeType

attributes

namespaceURI

localName

firstElementChild

lastElementChild

childElementCount

Element

function

prototype

object

nodeType

tagName

nodeName

localName

namespaceURI

id

className

classList

innerHTML

firstElementChild

lastElementChild

childElementCount

previousElementSibling

nextElementSibling

getElementsByTagName

function

getElementsByTagNameNS

function

getElementsByClassName

function

before

function

after

function

append

function

remove

function

replaceWith

function

matches

function

querySelector

function

querySelectorAll

function

getAttribute

function

getAttributeNS

function

getAttributeNode

function

getAttributeNodeNS

function

removeAttribute

function

removeAttributeNS

function

removeAttributeNode

function

setAttributeNode

function

setAttributeNodeNS

function

setAttribute

function

setAttributeNS

function

hasAttribute

function

hasAttributeNS

function

getPrinceBoxes

A list of JavaScript objects called <a href='/doc/javascript#the-box-tracking-api'>boxes</a>.

Attribute

prototype

nodeType

name

nodeName

localName

namespaceURI

value

nodeValue

ownerElement

attributes

childNodes

Text

function

prototype

object

nodeName

nodeType

attributes

childNodes

previousElementSibling

nextElementSibling

splitText

function

data

function

nodeValue

function

length

function

HTMLDocument

function

prototype

object

head

body

title

innerHTML

write

function

HTMLCollection

function

prototype

object

item

function

namedItem

function

length

function

NodeList

function

prototype

object

item

function

length

function

NamedNodeMap

function

prototype

object

length

item

function

getNamedItem

function

getNamedItemNS

function

setNamedItem

function

setNamedItemNS

function

removeNamedItem

function

removeNamedItemNS

function

CSSStyleDeclaration

function

prototype

object

alignContent

alignItems

alignSelf

background

backgroundAttachment

background-attachment

backgroundClip

background-clip

backgroundColor

background-color

backgroundImage

background-image

backgroundImageResolution

background-image-resolution

backgroundOrigin

backgroundPosition

backgroundRepeat

backgroundSize

baselineShift

bookmarkLabel

bookmarkLevel

bookmarkState

bookmarkTarget

border

borderBottom

borderBottomColor

borderBottomLeftRadius

border-bottom-left-radius

borderBottomRightRadius

border-bottom-right-radius

borderBottomStyle

borderBottomWidth

borderClip

borderCollapse

borderColor

borderLeft

borderLeftColor

borderLeftStyle

borderLeftWidth

borderRadius

borderRight

borderRightColor

borderRightStyle

borderRightWidth

borderSpacing

borderStyle

borderTop

borderTopColor

borderTopLeftRadius

border-top-left-radius

borderTopRightRadius

border-top-right-radius

borderTopStyle

borderTopWidth

borderWidth

bottom

boxDecorationBreak

boxSizing

breakAfter

breakBefore

breakInside

captionPage

captionSide

clear

clip

clipPath

clipRule

color

colorInterpolation

colorInterpolationFilters

color-interpolation-filters

columnBreakAfter

columnBreakBefore

columnCount

columnFill

columnGap

columnRule

columnRuleColor

columnRuleStyle

columnRuleWidth

columns

columnSpan

columnWidth

content

counterIncrement

counterReset

direction

display

dominantBaseline

emptyCells

fill

fillOpacity

fillRule

filter

flex

flexBasis

flexDirection

flexFlow

flexGrow

flexShrink

flexWrap

floodColor

floodOpacity

cssFloat

floatDeferColumn

floatDeferPage

floatModifier

floatPlacement

floatReference

floatTail

floatPolicy

flow

font

fontFamily

fontSize

fontStretch

fontStyle

fontVariant

fontWeight

footnoteDisplay

footnoteStylePosition

footnote-style-position

gap

height

hyphenateAfter

hyphenateBefore

hyphenateLines

hyphenatePatterns

hyphens

imageOrientation

imageResolution

insetInside

insetOutside

justifyContent

left

letterSpacing

lightingColor

lineHeight

lineStackingStrategy

line-stacking-strategy

link

listStyle

listStyleImage

listStylePosition

listStyleType

margin

marginAlt

marginBottom

marginInside

marginLeft

marginOutside

marginRight

marginTop

marker

markerEnd

markerMid

markerStart

mask

maxHeight

maxWidth

minHeight

minWidth

opacity

order

orphans

overflow

overflowWrap

padding

paddingBottom

paddingLeft

paddingRight

paddingTop

page

pageBreakAfter

pageBreakBefore

pageBreakInside

pageGroup

position

princeBackgroundImageResolution

prince-background-image-resolution

princeBookmarkLabel

prince-bookmark-label

princeBookmarkLevel

prince-bookmark-level

princeBookmarkState

prince-bookmark-state

princeBookmarkTarget

prince-bookmark-target

princeCaptionPage

prince-caption-page

princeClear

prince-clear

princeFilterResolution

prince-filter-resolution

princeFloatDeferColumn

prince-float-defer-column

princeFloatDeferPage

prince-float-defer-page

princeFloatModifier

prince-float-modifier

princeFloatPlacement

prince-float-placement

princeFloatReference

prince-float-reference

princeFloatTail

prince-float-tail

princeFloatPolicy

prince-float-policy

princeFlow

prince-flow

princeFootnotePolicy

prince-footnote-policy

princeHyphenateAfter

prince-hyphenate-after

princeHyphenateBefore

prince-hyphenate-before

princeHyphenateCharacter

prince-hyphenate-character

princeHyphenateLines

prince-hyphenate-lines

princeHyphenatePatterns

prince-hyphenate-patterns

princeImageMagic

prince-image-magic

princeImageResolution

prince-image-resolution

princeLang

prince-lang

princeLinebreakMagic

prince-linebreak-magic

princeLink

prince-link

princeMarginAlt

prince-margin-alt

princePageGroup

prince-page-group

princePdfAnnotationAuthor

prince-pdf-annotation-author

princePdfAnnotationColor

prince-pdf-annotation-color

princePdfAnnotationContents

prince-pdf-annotation-contents

princePdfAnnotationCreatedate

prince-pdf-annotation-createdate

princePdfAnnotationModifydate

prince-pdf-annotation-modifydate

princePdfAnnotationPosition

prince-pdf-annotation-position

princePdfAnnotationTitle

prince-pdf-annotation-title

princePdfAnnotationType

prince-pdf-annotation-type

princePdfColorConversion

prince-pdf-color-conversion

princePdfColorOptions

prince-pdf-color-options

princePdfDestination

prince-pdf-destination

princePdfLinkType

prince-pdf-link-type

princePdfTagType

prince-pdf-tag-type

princeTableColumnSpan

prince-table-column-span

princeTableRowSpan

prince-table-row-span

princeTextJustify

princeTextReplace

princeTooltip

right

rowGap

stopColor

stopOpacity

stringSet

stroke

strokeDasharray

strokeDashoffset

strokeLinecap

strokeLinejoin

strokeMiterlimit

strokeOpacity

strokeWidth

tableBaseline

tableColumnSpan

tableLayout

tableRowSpan

tabSize

textAlign

textAlignAll

textAlignLast

textAnchor

textDecoration

textIndent

textJustify

textLineThrough

textLineThroughColor

text-line-through-color

textLineThroughStyle

text-line-through-style

textOverflow

textOverline

textOverlineColor

textOverlineStyle

textTransform

textUnderline

textUnderlineColor

textUnderlinePosition

text-underline-position

textUnderlineStyle

top

transform

transformOrigin

unicodeBidi

verticalAlign

visibility

whiteSpace

widows

width

wordBreak

wordSpacing

writingMode

zIndex

setProperty

function

removeProperty

function

setPropertyValue

getPropertyValue

function

DOMException

function

prototype

object

INDEX_SIZE_ERR

number

HIERARCHY_REQUEST_ERR

number

NO_MODIFICATION_ALLOWED_ERR

number

NOT_FOUND_ERR

number

NOT_SUPPORTED_ERR

number

INUSE_ATTRIBUTE_ERR

number

INVALID_STATE_ERR

number

SYNTAX_ERR

number

TYPE_MISMATCH_ERR

number

SVGException

prototype

SVG_INVALID_VALUE_ERR

SVG_MATRIX_NOT_INVERTABLE

DOMImplementation

function

prototype

object

createDocument

function

createHTMLDocument

function

hasFeature

function

DOMParser

function

prototype

object

parseFromString

function

DOMTokenList

function

prototype

object

length

value

item

function

contains

function

add

function

remove

function

replace

function

supports

function

toggle

function

entries

function

forEach

function

keys

function

values

function

SVGMatrix

function

prototype

object

multiply

function

inverse

function

translate

function

scale

function

scaleNonUniform

function

rotate

function

rotateFromVector

function

flipX

function

flipY

function

skewX

function

skewY

function

a

function

b

function

c

function

d

function

e

function

f

function

CanvasRenderingContext2D

function

prototype

object

save

function

restore

function

scale

function

rotate

function

translate

function

transform

function

setTransform

function

resetTransform

function

moveTo

function

lineTo

function

rect

function

clearRect

function

fillRect

function

strokeRect

function

arc

function

arcTo

function

ellipse

function

bezierCurveTo

function

quadraticCurveTo

function

beginPath

function

closePath

function

fill

function

stroke

function

setLineDash

function

getLineDash

function

systemFocusRing

customFocusRing

scrollPathIntoView

clip

function

resetClip

isPointInPath

function

fillText

function

strokeText

function

measureText

function

createLinearGradient

function

createRadialGradient

function

createPattern

function

drawImage

function

createImageData

function

getImageData

function

putImageData

function

globalAlpha

function

globalCompositeOperation

function

strokeStyle

function

fillStyle

function

lineWidth

function

lineCap

function

lineJoin

function

lineDashOffset

function

miterLimit

function

font

function

textAlign

function

textBaseline

function

shadowColor

function

shadowOffsetX

function

shadowOffsetY

function

shadowBlue

ImageData

function

prototype

object

Image

function

HTMLElement

function

prototype

object

dir

lang

title

HTMLAnchorElement

function

prototype

object

href

protocol

username

password

host

hostname

port

pathname

search

hash

name

target

HTMLAreaElement

function

prototype

object

href

protocol

username

password

host

hostname

port

pathname

search

hash

name

target

alt

coords

shape

download

rel

HTMLBaseElement

function

prototype

object

href

target

HTMLBodyElement

function

prototype

object

HTMLBRElement

function

prototype

object

HTMLCanvasElement

function

prototype

object

getContext

function

width

function

height

function

HTMLDivElement

function

prototype

object

HTMLDListElement

function

prototype

object

HTMLHeadElement

function

prototype

object

HTMLHeadingElement

function

prototype

object

HTMLHRElement

function

prototype

object

HTMLHtmlElement

function

prototype

object

HTMLImageElement

function

prototype

object

alt

src

width

height

HTMLInputElement

function

prototype

[object Object]

checked

disabled

name

type

value

HTMLLIElement

function

prototype

object

value

HTMLLinkElement

function

prototype

[object Object]

href

hreflang

media

rel

type

HTMLMetaElement

function

prototype

object

name

content

HTMLModElement

function

prototype

object

cite

HTMLOListElement

function

prototype

[object Object]

start

type

HTMLOptionElement

function

prototype

object

disabled

selected

value

HTMLParagraphElement

function

prototype

object

HTMLPreElement

function

prototype

object

HTMLQuoteElement

function

prototype

object

cite

HTMLScriptElement

function

prototype

[object Object]

src

type

HTMLSpanElement

function

prototype

object

HTMLStyleElement

function

prototype

[object Object]

media

type

HTMLTableElement

function

prototype

object

HTMLTableCaptionElement

function

prototype

object

HTMLTableColElement

function

prototype

object

span

HTMLTableDataCellElement

prototype

HTMLTableHeaderCellElement

prototype

HTMLTableRowElement

function

prototype

object

HTMLTableSectionElement

function

prototype

object

HTMLTextAreaElement

function

prototype

object

HTMLTitleElement

function

prototype

object

HTMLUListElement

function

prototype

object

BoxInfo

function

The properties of a box, can be accessed after document conversion has finished - see <a href='/doc/javascript#the-box-tracking-api'>The Box Tracking API</a>.

prototype

[object Object]

type

function

pageNum

x

function

x-coordinate, in pt

y

function

y-coordinate, in pt

w

function

width, in pt

h

function

height, in pt

marginBottom

function

the used value for the bottom margin

marginLeft

function

the used value for the left margin

marginRight

function

the used value for the right margin

marginTop

function

the used value for the top margin

floatPosition

function

"TOP" | "BOTTOM"

children

function

array of child boxes

parent

function

parent box

element

function

DOM element for box (may be null)

pseudo

function

pseudo-element name or null

text

string

style

function

CSS style object for box

BoxInfoChildren

prototype

item

length

Prince

object

See <a href='/doc/javascript#the-prince-object'>The Prince Object</a>.

addEventListenertype, callback, optional extra options

function

can be called to listen to the <code>complete</code> event on the Prince object. See <a href='/doc/javascript#event-handling'>Event Handling</a>.

type
string
callback
string
optional extra options
string

oncomplete

The <code>complete</code> event is fired when all layout is finished (and after the last repeated layout, if this was requested), just before the PDF is output, so that it can cancel the PDF output by triggering a fail-safe if necessary, or log information about the PDF like the page count.

addScriptFuncname, function

function

exposes an arbitrary JavaScript function to CSS. See <a href='/doc/gen-content#script-functions'>Script Functions</a>.

name
string
function
string

trackBoxes

function

See <a href='/doc/javascript#the-box-tracking-api'>The Box Tracking API</a>.

boolean

convertToFileJSON, OutputFileName, ...optional extra job resources

function

JSON
string
as specified in the <a href='/doc/server-integration#job-description-json'>Job description JSON</a>;
OutputFileName
string
...optional extra job resources
ArrayBuffers or strings

boolean, indicating success

convertToBufferJSON, ...optional extra job resources

function

JSON
string
...optional extra job resources
ArrayBuffers or strings

ArrayBuffer if successful, null if not

failStatus

boolean

pageCount

function

Total number of document pages, can be accessed after document conversion has finished.

registerPostLayoutFuncfunction

function

See <a href='/doc/javascript#multi-pass-formatting'>Multi-Pass formatting</a>.

function
string

Log

object

also available as <a href='#window.Log'><code>Log</code></a>.

debugmessage

function

only available when the <code>--debug</code> command-line option is specified.

message
string

infomessage

function

only available when the <code>--verbose</code> command-line option is specified.

message
string

warningmessage

function

message
string

errormessage

function

message
string

dataname, value

function

name
string
value
string

PDF

object

See <a href='/doc/javascript#the-pdf-object'>The PDF Object</a>.

colorOptions

function

string
"auto" | "use-true-black" | "use-rich-black"

attachFileURL, description, filename, relationship

function

URL
string
description
string
Optional second argument to describe the attachment.
filename
string
Optional third argument to specify the filename to be displayed for the attachment in the PDF.
relationship
string
Optional fourth argument to specify the AFRelationship value of the attachment.

PDF.attachFile('data.xls', 'Latest sales figures.', 'SalesFigures', 'Data')

embedFonts

function

boolean

subsetFonts

function

boolean

artificialFonts

function

boolean

forceIdentityEncoding

function

boolean

compress

function

boolean

encrypt

function

boolean

userPassword

function

string

ownerPassword

function

string

allowPrint

function

boolean

allowModify

function

boolean

allowCopy

function

boolean

allowAnnotate

function

boolean

keyBitskey bits

function

key bits
string
"40" | "128"

script

function

string

openAction

function

string
Note that Prince passes the provided values verbatim to the PDF viewer, so the user can supply values that Prince doesn't know about, but the viewer does.

PDF.openAction('print')

pageLayout

function

string
"single-page" | "one-column" | "two-column[-left/right]"

pageMode

function

string
"auto" | "show-bookmarks" | "fullscreen" | "show-attachments"

printScaling

function

string
"auto" | "none"

duplex

function

string
"auto" | "simplex" | "duplex-flip-short-edge" | "duplex-flip-long-edge"

profile

function

string
One of the supported PDF profiles.

PDF.profile("PDF/X-3:2003")

outputIntentURL

function

URL
string

objectStreams

function

Can be used to disable PDF object streams. Object streams are enabled by default.

boolean

fallbackCMYKProfileURL

function

URL
string

colorConversion

function

string
"none" | "full"

paperTray

function

string
"auto " | "pick-tray-by-pdf-size"

filterResolutiondpi

function

dpi
string

PDF.filterResolution('128dpi')

xmpURL

function

URL
string

PDF.xmp('xmp-data.xmp')

xmpMetadata

function

boolean

title

function

string

subject

function

string

author

function

string

keywords

function

string

creator

function

string

lang

function

string

pages

array

A list of page boxes, can be accessed after document conversion has finished.

Log

object

also available as <a href='#window.Prince.Log'><code>Prince.Log</code></a>.

debugmessage

function

only available when the <code>--debug</code> command-line option is specified.

message
string

infomessage

function

only available when the <code>--verbose</code> command-line option is specified.

message
string

warningmessage

function

message
string

errormessage

function

message
string

dataname, value

function

name
string
value
string