.. Copyright (C) 2001-2023 Artifex Software, Inc.
.. All Rights Reserved.

----


.. default-domain:: js

.. include:: html_tags.rst

.. _mutool_object_document:


.. _mutool_run_js_api_document:


`Document`
--------------------

:title:`MuPDF` can open many document types (:title:`PDF`, :title:`XPS`, :title:`CBZ`, :title:`EPUB`, :title:`FB2` and a handful of image formats).


.. method:: new Document.openDocument(fileName, fileType)

    *Constructor method*.

    Open the named document.

    :arg fileName: File name to open.
    :arg fileType: File type.

    :return: `Document`.


    |example_tag|

    .. code-block:: javascript

        var document = new mupdf.Document.openDocument("my_pdf.pdf", "application/pdf");




|instance_methods|

.. method:: needsPassword()

    Returns *true* if a password is required to open a password protected PDF.

    :return: `Boolean`.

    |example_tag|

    .. code-block:: javascript

        var needsPassword = document.needsPassword();


.. method:: authenticatePassword(password)

    Returns a bitfield value against the password authentication result.

    :arg password: The password to attempt authentication with.
    :return: `Integer`.



    .. list-table::
        :header-rows: 1

        * - **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

    |example_tag|

    .. code-block:: javascript

        var auth = document.authenticatePassword("abracadabra");


.. method:: hasPermission(permission)

    Returns *true* if the document has permission for the supplied permission `String` parameter.

    :arg permission: `String` The permission to seek for, e.g. "edit".
    :return: `Boolean`.


    .. list-table::
        :header-rows: 1

        * - **String**
          - **Description**
        * - `print`
          - Can print
        * - `edit`
          - Can edit
        * - `copy`
          - Can copy
        * - `annotate`
          - Can annotate
        * - `form`
          - Can fill out forms
        * - `accessibility`
          - Can copy for accessibility
        * - `assemble`
          - Can manage document pages
        * - `print-hq`
          - Can print high-quality


    |example_tag|

    .. code-block:: javascript

        var canEdit = document.hasPermission("edit");


.. method:: getMetaData(key)

    Return various meta data information. The common keys are: `format`, `encryption`, `info:ModDate`, and `info:Title`.

    :arg key: `String`.
    :return: `String`.

    |example_tag|

    .. code-block:: javascript

        var format = document.getMetaData("format");
        var modificationDate = doc.getMetaData("info:ModDate");
        var author = doc.getMetaData("info:Author");


.. method:: setMetaData(key, value)

    Set document meta data information field to a new value.

    :arg key: `String`.
    :arg value: `String`.

    |example_tag|

    .. code-block:: javascript

        document.setMetaData("info:Author", "My Name");


.. method:: isReflowable()

    Returns true if the document is reflowable, such as :title:`EPUB`, :title:`FB2` or :title:`XHTML`.

    :return: `Boolean`.

    |example_tag|

    .. code-block:: javascript

        var isReflowable = document.isReflowable();

    .. note::

        This will always return `false` in the :title:`WASM` context as there is no :title:`HTML`/:title:`EPUB` support in :title:`WASM`.


.. method:: layout(pageWidth, pageHeight, fontSize)

    Layout a reflowable document (:title:`EPUB`, :title:`FB2`, or :title:`XHTML`) to fit the specified page and font size.

    :arg pageWidth: `Int`.
    :arg pageHeight: `Int`.
    :arg fontSize: `Int`.

    |example_tag|

    .. code-block:: javascript

        document.layout(300,300,16);


.. method:: countPages()

    Count the number of pages in the document. This may change if you call the layout function with different parameters.

    :return: `Int`.

    |example_tag|

    .. code-block:: javascript

        var numPages = document.countPages();


.. method:: loadPage(number)

    Returns a :ref:`Page<mutool_run_js_api_page>` (or :ref:`PDFPage<mutool_run_js_api_pdf_page>`) object for the given page number. Page number zero (0) is the first page in the document.

    :return: `Page` or `PDFPage`.

    |example_tag|

    .. code-block:: javascript

        var page = document.loadPage(0); // loads the 1st page of the document

.. method:: loadOutline()

    Returns 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.

    :return: `[...]`.


    |example_tag|

    .. code-block:: javascript

        var outline = document.loadOutline();


.. _mutool_run_js_api_document_outlineIterator:

.. method:: outlineIterator()

    Returns an :ref:`OutlineIterator<mutool_object_outline_iterator>` for the document outline.

    :return: `OutlineIterator`.

    |example_tag|

    .. code-block:: javascript

        var obj = document.outlineIterator();


.. _mutool_run_js_api_document_resolveLink:


.. method:: resolveLink(uri)

    Resolve a document internal link :title:`URI` to a page index.

    :arg uri: `String`.
    :return: `Integer`.

    |example_tag|

    .. code-block:: javascript

        var pageNumber = document.resolveLink(my_link);


.. _mutool_run_js_api_document_resolveLinkDestination:


.. method:: resolveLinkDestination(uri)

    Resolve a document internal link :title:`URI` to a link destination.

    :arg uri: `String`.
    :return: :ref:`Link destination<mutool_run_js_api_link_dest>`.

    |example_tag|

    .. code-block:: javascript

        var linkDestination = document.resolveLinkDestination(uri);



.. method:: isPDF()

    Returns *true* if the document is a :title:`PDF` document.

    :return: `Boolean`.

    |example_tag|

    .. code-block:: javascript

        var isPDF = document.isPDF();


.. method:: asPDF()

    Returns a pdf version of the document (if possible). PDF documents return the same object. Documents that have an underlying PDF representation return that. Other document types return null.

    :return: `PDFDocument`.

    |example_tag|

    .. code-block:: javascript

        var asPDF = document.asPDF();


.. method:: formatLinkURI(linkDestination)

    Format a document internal link destination object to a :title:`URI` string suitable for :ref:`createLink()<mutool_run_js_api_page_create_link>`.

    :arg linkDestination: :ref:`Link destination<mutool_run_js_api_link_dest>`.
    :return: `String`.


    |example_tag|

    .. code-block:: javascript

        var uri = document.formatLinkURI({chapter:0, page:42,
                type:"FitV", x:0, y:0, width:100, height:50, zoom:1});
        document.createLink([0,0,100,100], uri);
