MuPDF can open many document types such as PDF, XPS, CBZ, EPUB, FictionBook 2 and a handful of image formats.
You cannot create instances of this class with the new operator!
Permission flags for Document.prototype.hasPermission:
"print" – Print the document.
"edit" – Modify the contents of the document by
operations other than those controlled by the other flags: (annotate,
form, assemble).
"edit" – Copy or otherwise extract text from the
document.
"annotate" – Add or modify annotations.
"form" – Fill in existing form fields.
"accessibility" – Copy or otherwise extract text from
the document in support of accessibility.
"assemble" – Insert, rotate, or delete pages and create
bookmarks.
"print-hq" – Print the document to a representation from
which a faithful digital copy of the PDF content could be generated.
Open the named or given document.
string) – File name to
open.Buffer | ArrayBuffer | Uint8Array | string) – Buffer
containing a document file.string) – An optional MIME-type or file
extension. Defaults to “application/pdf”.string) – File name of
accelerator file.Buffer | ArrayBuffer | Uint8Array | string) – Buffer
containing an accelerator file.Archive) – An archive from
which to load resources for rendering.var document1 = mupdf.Document.openDocument("my_pdf.pdf", "application/pdf")
var document2 = mupdf.Document.openDocument("my_pdf.pdf", dir)
var document3 = mupdf.Document.openDocument("my_pdf.pdf", acceleratorfile, dir)
var document4 = mupdf.Document.openDocument(fs.readFileSync("my_pdf.pdf"), "application/pdf")
var document5 = mupdf.Document.openDocument(fs.readFileSync("my_pdf.pdf"), acceleratorbuffer, "application/pdf")
var document6 = mupdf.Document.openDocument(fs.readFileSync("my_pdf.pdf"), acceleratorbuffer, dir, "application/pdf")Check if MuPDF can open a document with the provided magic, or with the contents in the given file/buffer.
var recognized1 = mupdf.Document.recognize("application/pdf")
var recognized2 = mupdf.Document.recognizeContent("my_pdf.pdf")
var recognized3 = mupdf.Document.recognizeContent(buffer, "application/pdf")
var recognized4 = mupdf.Document.recognizeContent(buffer, dir, "application/pdf")Returns true if a password is required to open a
password protected PDF.
var needsPassword = document.needsPassword()Returns a bitfield value against the password authentication result.
string) – The password to
attempt authentication with.| Bitfield value | Description |
|---|---|
| 0 | Failed |
| 1 | No password needed |
| 2 | Is User password and is okay |
| 4 | Is Owner password and is okay |
| 6 | Is both User & Owner password and is okay |
var auth = document.authenticatePassword("abracadabra")Check if a user is allowed permission to perform certain operations on the document.
"print" | "edit" | "copy" | "annotate" | "form" | "accessibility" | "assemble" | "print-hq")See Document.PERMISSION_PRINT,
etc.
var canEdit1 = document.hasPermission("edit")
var canEdit2 = document.hasPermission(Document.PERMISSION_EDIT)Return various meta data information. The common keys are: format,
encryption, info:ModDate, and info:Title. Returns undefined if the
meta data does not exist.
string) – What metadata type to
return.var format = document.getMetaData("format")
var modificationDate = doc.getMetaData("info:ModDate")
var author = doc.getMetaData("info:Author")Set document meta data information field to a new value.
string) – Metadata key to
set.string) – New value to set for
the given key.document.setMetaData("info:Author", "My Name")Returns true if the document is reflowable, such as EPUB, FB2 or XHTML.
var isReflowable = document.isReflowable()Control publisher styles and user stylesheet on a reflowable document.
boolean) – Set to false
to disable the publisher’s styling.string | null) – User styles
to apply.document.style(false, "p { margin: 0; text-indent: 1em; }")Layout a reflowable document (EPUB, FictionBook2, HTML or XHTML) to fit the specified page and font sizes.
number) – Desired page
width.number) – Desired page
height.number) – Desire font
size.document.layout(300, 300, 16)Count the number of pages in the document. This may change if you call the layout function with different parameters.
var numPages = document.countPages()Returns a Page object for the given page number.
For documents where Document.prototype.isPDF()
returns true, the returned Page is of the
subclass PDFPage.
number) – Number of page to
load, 0 means the first page in the document.var page = document.loadPage(0) // loads the 1st page of the documentReturns an array with the outline (also known as table of contents or bookmarks). In the array is an object for each heading with the property ‘title’, and a property ‘page’ containing the page number. If the object has a ‘down’ property, it contains an array with all the sub-headings for that entry.
var outline = document.loadOutline()Returns an OutlineIterator for the document outline.
var obj = document.outlineIterator()Resolve a document internal link URI to a page index.
Link | string) – A link or a
link URI string to resolve.var pageNumber = document.resolveLink(my_link)Resolve a document internal link URI to a link destination.
Link | string) – A link or a
link URI string to resolve.var linkDestination = document.resolveLinkDestination(linkuri)Returns true if the document is a PDFDocument.
var isPDF = document.isPDF()Returns a PDF version of the document (if possible). PDF documents return themselves. Documents that have an underlying PDF representation return that. Other document types return null.
var doc = mupdf.Document.openDocument(filename)
var pdf = doc.asPDF()
if (pdf) {
// the document has a native PDF representation
} else {
// it does not have a native PDF representation
}Format a document internal link destination object to a URI string
suitable for Page.prototype.createLink().
LinkDestination)
– The link destination object to format.var uri = document.formatLinkURI({
chapter: 0,
page: 42,
type: "FitV",
x: 0,
y: 0,
width: 100,
height: 50,
zoom: 1
})
page.createLink([0, 0, 100, 100], uri)