MuPDF WebViewer

https://webviewer-docs.mupdf.com/
Admin
MuPDF WebViewer is a customizable, high-performance PDF viewer component for the web, offering...
Tokens:50,039
Snippets:352
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install MuPDF WebViewer via npm

Source: https://webviewer-docs.mupdf.com/getting-started

Installs the MuPDF WebViewer package from NPM into your project.

```bash
npm install mupdf-webviewer
```

--------------------------------

### Copy Library Assets

Source: https://webviewer-docs.mupdf.com/getting-started

Copies the MuPDF WebViewer library assets to a specified directory, typically the public folder in React projects.

```bash
cp -r node_modules/mupdf-webviewer/lib/* {YOUR_LIBRARY_PATH}/
```

```bash
cp -r ./node_modules/mupdf-webviewer/lib ./public
```

--------------------------------

### Open Local PDF File

Source: https://webviewer-docs.mupdf.com/getting-started

Opens a local PDF file within the MuPDF WebViewer by providing its relative path and an optional filename.

```javascript
mupdf.document.open({url:"/path/to/my/file.pdf", filename:"My File"});

```

--------------------------------

### Initialize MuPDF WebViewer

Source: https://webviewer-docs.mupdf.com/getting-started

Initializes the MuPDF WebViewer in a specified DOM element, loading a PDF document. Requires the library path and a license key. Handles success and error callbacks.

```javascript
import { initMuPDFWebViewer } from 'mupdf-webviewer'

initMuPDFWebViewer('#viewer', 'sample.pdf', {
  libraryPath: 'YOUR_LIBRARY_PATH',
  licenseKey: 'YOUR_LICENSE_KEY',
})
  .then(mupdf => {
    /* API */
    mupdf.toast.show({ type: 'success', content: 'Opened' });
  })
  .catch(err => {
    /* Error handling */
  });

```

--------------------------------

### Open PDF File from Blob URL

Source: https://webviewer-docs.mupdf.com/getting-started

Opens a PDF file using a Blob URL. This involves fetching the file, creating a Blob, generating a Blob URL, and then opening it with the viewer.

```javascript
async function openWithBlobURL(url, filename = 'My File') {
    const response = await fetch(url);
    const blob = await response.blob();
    const blobUrl = URL.createObjectURL(blob);
    mupdf.document.open({url:blobUrl, filename:filename});
}

openWithBlobURL('/file.pdf')

```

--------------------------------

### Open Remote PDF File

Source: https://webviewer-docs.mupdf.com/getting-started

Opens a remote PDF file hosted online within the MuPDF WebViewer by providing its URL and an optional filename.

```javascript
mupdf.document.open({url:"https://example.com/my-file.pdf", filename:"My File"});

```

--------------------------------

### Viewer Page Navigation and State

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

APIs for getting and setting the current page index, document rotation, and view mode.

```APIDOC
## GET /viewer/currentPageIndex

### Description
Gets the current page index (zero-indexed).

### Method
GET

### Endpoint
/viewer/currentPageIndex

### Parameters

#### Query Parameters
None

### Response
#### Success Response (200)
- **currentPageIndex** (number) - The current zero-indexed page number.

#### Response Example
```json
{
  "currentPageIndex": 5
}
```

---

## GET /viewer/rotation

### Description
Gets the current document rotation angle in degrees.

### Method
GET

### Endpoint
/viewer/rotation

### Parameters

#### Query Parameters
None

### Response
#### Success Response (200)
- **degree** (number) - The current rotation angle in degrees.

#### Response Example
```json
{
  "degree": 90
}
```

---

## POST /viewer/setRotation

### Description
Sets the document rotation angle in degrees.

### Method
POST

### Endpoint
/viewer/setRotation

### Parameters

#### Request Body
- **config** (object) - Required - Object containing rotation value.
  - **degree** (mupdf.refs.degree) - Required - The desired rotation angle.

### Request Example
```json
{
  "config": {
    "degree": "DEG_90"
  }
}
```

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

---

## POST /viewer/rotateClockwise

### Description
Rotates the document 90 degrees clockwise.

### Method
POST

### Endpoint
/viewer/rotateClockwise

### Parameters

#### Query Parameters
None

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

---

## POST /viewer/rotateCounterClockwise

### Description
Rotates the document 90 degrees counter-clockwise.

### Method
POST

### Endpoint
/viewer/rotateCounterClockwise

### Parameters

#### Query Parameters
None

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

---

## POST /viewer/setViewMode

### Description
Sets the view mode for the document.

### Method
POST

### Endpoint
/viewer/setViewMode

### Parameters

#### Request Body
- **config** (object) - Required - Object containing the view mode.
  - **viewMode** (mupdf.refs.viewMode) - Required - The desired view mode (e.g., SINGLE, DOUBLE).

### Request Example
```json
{
  "config": {
    "viewMode": "DOUBLE"
  }
}
```

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

```

--------------------------------

### JSON Annotation Data Format Example

Source: https://webviewer-docs.mupdf.com/annotations

This snippet shows the structure of annotation data in JSON format as used by the MuPDF WebViewer. It details common fields and provides a specific example for a highlight annotation, including its unique identifier, type, page index, and geometric properties.

```json
{
    "annotations": [
        {
            "oid": 0,
            "type": "",
            "pageIndex": 0,
            ...
        }, ...
    ]
}
```

```json
{
    "annotations": [
        {
            "oid": 30,
            "type": "HIGHLIGHT",
            "pageIndex": 0,
            "name": "81ba5e29-1930-4453-b594-f5771cf83a57",
            "rect": {
                "top": 10,
                "bottom": 40,
                "left": 10,
                "right": 40
            },
            "opacity": 1,
            "rotation": 0,
            "createdAt": "D:20250710153823+01'00'",
            "modifiedAt": "D:20250710153823+01'00'",
            "author": "Jane Doe",
            "canBePrinted": true,
            "locked": false,
            "rects": [
                {
                    "top": 10,
                    "bottom": 40,
                    "left": 10,
                    "right": 40
                }
            ],
            "fillColor": "#ffd100"
        }
    ]
}
```

--------------------------------

### Define Document Panel

Source: https://webviewer-docs.mupdf.com/customization

Enables the customization of the document panel, allowing developers to define its items, including labels, icons, and click actions. This can be used to create custom navigation or tool panels.

```APIDOC
## POST /api/viewer/defineDocumentPanel

### Description
Defines the content and behavior of the document panel, allowing for custom labels, icons, and actions for navigation or tools.

### Method
POST

### Endpoint
/api/viewer/defineDocumentPanel

### Parameters
#### Request Body
- **items** (array) - Required - An array of panel item objects.
  - **label** (string) - Required - The text label for the panel item.
  - **icon** (string) - Required - The icon for the panel item (e.g., mupdf.refs.icon.BOOKMARK).
  - **onclick** (function) - Required - The function to execute when the panel item is clicked (e.g., to toggle a specific panel like bookmarks or annotations).

### Request Example
```json
{
  "items": [
    {
      "label": "Table of Contents",
      "icon": "mupdf.refs.icon.BOOKMARK",
      "onclick": "() => { mupdf.viewer.togglePanel({ type: 'mupdf.refs.panel.open.BOOKMARK' }); }"
    },
    {
      "label": "Markups",
      "icon": "mupdf.refs.icon.PENCIL",
      "onclick": "() => { mupdf.viewer.togglePanel({ type: 'mupdf.refs.panel.open.ANNOTATION' }); }"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### GET /api/annotation

Source: https://webviewer-docs.mupdf.com/annotations

Retrieves all annotations from the current document.

```APIDOC
## GET /api/annotation

### Description
Retrieves all annotations from the current document in JSON format.

### Method
GET

### Endpoint
`/api/annotation`

### Parameters
None

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **annotations** (array of mupdfwv.Annotation) - An array containing all annotation objects.

#### Response Example
```json
{
    "annotations": [
        {
            "oid": 30,
            "type": "HIGHLIGHT",
            "pageIndex": 0,
            // ... other annotation properties
        }
    ]
}
```
```

--------------------------------

### Define Custom Annotation Selection Menu for Highlight Tool

Source: https://webviewer-docs.mupdf.com/customization

This snippet demonstrates how to define a custom HTML menu that appears when a highlight annotation is selected. It includes the HTML structure, CSS for styling, and JavaScript for interactivity. The `tool` parameter specifies that this menu is for the highlight annotation.

```javascript
let html = `<div id='my-container'>
<p>Testing custom HTML & CSS for Highlight tool</p>
<button onclick='helloWorld()'>Press me!</button>
</div>`;

let css = `#my-container 
{
width:200px;
height:200px;
background-color: #FF00ff;
color:#000;
font-size:12px;
margin:10px;
}`;

let js = `function helloWorld()
{
let myObj = document.getElementById('my-container');
myObj.innerHTML='Hello World!'
}`;

mupdf.viewer.defineAnnotSelectMenu({
    html: html,
    style: css,
    script: js,
    tool: mupdf.refs.annotation.tool.HIGHLIGHT
})
```

--------------------------------

### Register Shortcut for Ctrl+S in MuPDF WebViewer

Source: https://webviewer-docs.mupdf.com/api-reference/events/index

This JavaScript snippet demonstrates how to listen for the `KEYDOWN` event and implement a shortcut. It checks if the `ctrlKey` is pressed and the `key` is 's', then triggers a document download using `mupdf.document.download()`. This is an example of handling multiple key presses for custom actions.

```javascript
mupdf.addEventListener(mupdf.refs.event.type.KEYDOWN, (event) => {
  if (event.data.event.ctrlKey && event.data.event.key === 's') {
    mupdf.document.download();
  }
});
```

--------------------------------

### Redaction Instance API

Source: https://webviewer-docs.mupdf.com/api-reference/introduction

Offers methods for managing document redactions, including getting, setting, adding, removing, and applying redactions.

```APIDOC
## Redaction Instance API

### Description
Offers methods for managing document redactions, including getting, setting, adding, removing, and applying redactions.

### Methods

- **get()**: Retrieves all redactions.
- **set(redactions)**: Sets the redactions for the document.
- **add(redactionData)**: Adds a new redaction.
- **remove(id)**: Removes a redaction by its ID.
- **apply()**: Applies all pending redactions to the document.

### Endpoint

`/api-reference/redaction/index`
```

--------------------------------

### Get Annotations

Source: https://webviewer-docs.mupdf.com/api-reference/annotation

Retrieves annotations from the specified page or all pages.

```APIDOC
## GET /annotation/get

### Description
Gets annotations. Returns array of annotations.

### Method
GET

### Endpoint
/annotation/get

### Parameters
#### Query Parameters
- **pageIndex** (number) - Optional - The index of the page for which to retrieve annotations. If undefined, all annotations for all pages are returned.

### Response
#### Success Response (200)
- **annotations** (Annotation[]) - An array of annotation objects.

#### Response Example
```json
{
  "annotations": [
    {
      "pageIndex": 0,
      "type": "highlight",
      "rect": [100, 100, 200, 200],
      "color": "#FFFF00",
      "contents": "This is a highlight."
    }
  ]
}
```
```

--------------------------------

### Open Context Menu on Text Selection

Source: https://webviewer-docs.mupdf.com/customization

This endpoint allows you to open the context menu automatically when text is selected by the user. It uses an event listener for text selection changes and the `viewer.openContextMenu()` function.

```APIDOC
## Open Context Menu on Text Selection

### Description
This endpoint allows you to open the context menu automatically when text is selected by the user. It uses an event listener for text selection changes and the `viewer.openContextMenu()` function.

### Method
Event Listener / JavaScript Function Call

### Endpoint
N/A (Client-side event)

### Parameters
None directly for the endpoint, but relies on internal viewer state.

### Request Example
```javascript
mupdf.addEventListener(mupdf.refs.event.type.TEXT_SELECTION_CHANGE, (e) => {
    function getSelectedText() {
        mupdf.text.getSelected().then(successCallbackGetText, failureCallbackGetText);
    }

    function successCallbackGetText(result) {
        if (result) {
            mupdf.viewer.openContextMenu();
        }
    }

    function failureCallbackGetText(error) {
        console.error(`Error: ${error}`);
    }

    getSelectedText();
});
```

### Response
#### Success Response (200)
Context menu is displayed.

#### Response Example
N/A (Visual change)
```

--------------------------------

### Add Context Menu Items

Source: https://webviewer-docs.mupdf.com/customization

Allows developers to add custom items to the right-click context menu in the MuPDF WebViewer. This can include actions like rotating the page.

```APIDOC
## POST /api/viewer/addContextMenu

### Description
Adds items to the context menu that appears when a user right-clicks on a document.

### Method
POST

### Endpoint
/api/viewer/addContextMenu

### Parameters
#### Request Body
- **menus** (array) - Required - An array of menu item objects to be added to the context menu.
  - **type** (string) - Required - The type of menu item, e.g., 'MENU'.
  - **position** (string) - Required - The position of the menu item, e.g., 'FIRST'.
  - **icon** (string) - Required - The icon for the menu item (e.g., mupdf.refs.icon.ROTATE_CLOCKWISE).
  - **label** (string) - Required - The text label for the menu item.
  - **onclick** (function) - Required - The function to execute when the menu item is clicked.

### Request Example
```json
{
  "menus": [
    {
      "type": "MENU",
      "position": "FIRST",
      "icon": "mupdf.refs.icon.ROTATE_CLOCKWISE",
      "label": "Rotate Clockwise",
      "onclick": "() => { mupdf.viewer.rotateClockwise(); }"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Show Toast Message - JavaScript

Source: https://webviewer-docs.mupdf.com/api-reference/toast

Provides an example of how to display a toast message using the `show` method. It configures the message type, content, and includes an optional header and timeout duration.

```javascript
mupdf.toast.show({
  type: 'success',
  content: 'Document opened'
});
```

--------------------------------

### Add Fullscreen Button to MuPDF WebViewer Toolbar

Source: https://webviewer-docs.mupdf.com/customization/index

Shows how to add a custom button to the MuPDF WebViewer's toolbar using the `addButton` function. This example adds a button to enter fullscreen mode, demonstrating custom functionality integration.

```javascript
mupdf.viewer.addButton({
  buttons: [
    {
      position: 'TOOLBAR.LEFT_SECTION.FIRST',
      icon: mupdf.refs.icon.ENTER_FULLSCREEN,
      label: 'Enter fullscreen',
      onclick: () => {
        document.body.requestFullscreen();
      },
    },
  ],
});
```

--------------------------------

### Get PDF Page Information

Source: https://webviewer-docs.mupdf.com/api-reference/document

Retrieve information about PDF pages. You can specify a page range to get details for specific pages, or retrieve all page information if no range is provided. Page references are zero-indexed.

```javascript
mupdf.document.getPages({pageRange:"0-3"});

// returns e.g.

{
pages: {
    pageIndex: number;
    read: boolean;
    isVisible: boolean;
    bbox: {
    width: number;
    height: number;
    x: number;
    y: number;
    }
}
}[]
```

--------------------------------

### Viewer Instance API

Source: https://webviewer-docs.mupdf.com/api-reference/introduction

Provides methods for interacting with the viewer UI, such as setting colors, themes, zoom levels, page navigation, and more.

```APIDOC
## viewer Instance API

### Description
Provides methods for interacting with the viewer UI, such as setting colors, themes, zoom levels, page navigation, and more.

### Methods

- **setColor(color)**: Sets the viewer's color.
- **setBackgroundColor(color)**: Sets the viewer's background color.
- **setPageBorderColor(color)**: Sets the color of the page border.
- **setTheme(theme)**: Sets the viewer's theme.
- **setLogo(logo)**: Sets the viewer's logo.
- **toggleDialog(dialogName)**: Toggles the visibility of a specific dialog.
- **getScale()**: Gets the current zoom scale.
- **setScale(scale)**: Sets the zoom scale.
- **zoomIn()**: Zooms in the viewer.
- **zoomOut()**: Zooms out the viewer.
- **getCurrentPageIndex()**: Gets the index of the current page.
- **getRotation()**: Gets the current page rotation.
- **setRotation(rotation)**: Sets the page rotation.
- **rotateClockwise()**: Rotates the page clockwise.
- **rotateCounterClockwise()**: Rotates the page counter-clockwise.
- **setViewMode(mode)**: Sets the viewer's view mode.
- **fitTo(mode)**: Fits the document to a specific mode (e.g., 'page', 'width').
- **scrollToNextPage()**: Scrolls to the next page.
- **scrollToPreviousPage()**: Scrolls to the previous page.
- **scrollTo(pageIndex)**: Scrolls to a specific page index.
- **openSideView()**: Opens the side view.
- **closeSideView()**: Closes the side view.
- **togglePanel(panelName)**: Toggles the visibility of a specific panel.
- **highlight(text)**: Highlights specified text.
- **unhighlight(id)**: Removes highlight by ID.
- **searchText(text)**: Searches for text within the document.
- **setLanguage(language)**: Sets the viewer's language.
- **getSize()**: Gets the viewer's size.
- **setViewVisibility(view, visible)**: Sets the visibility of a specific view.
- **addButton(options)**: Adds a custom button to the viewer.
- **addContextMenu(options)**: Adds a custom context menu item.
- **defineDocumentPanel(options)**: Defines a custom document panel.
- **defineAnnotSelectMenu(options)**: Defines a custom annotation selection menu.

### Endpoint

`/api-reference/viewer/index`
```

--------------------------------

### Initialization API

Source: https://webviewer-docs.mupdf.com/api-reference/introduction

Initializes the MuPDF WebViewer by targeting a specific HTML element, loading a document, and providing configuration options.

```APIDOC
## POST /initMuPDFWebViewer

### Description
Initializes the MuPDF WebViewer API. This function should be called before accessing any other API methods. It returns a promise that resolves with a `mupdfwv.MuPDFWebViewer` object upon successful initialization or rejects with an error if initialization fails.

### Method
POST (implicitly, as it's a function call that likely performs an action)

### Endpoint
N/A (Function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **selector** (string) - Required - A string which targets the dedicated `<div>` with the expected id.
- **docURL** (string) - Required - The URL of the document you wish to display.
- **options** (object) - Required - An object containing initialization options:
  - **licenseKey** (string) - Required - The license key for use.
  - **libraryPath** (string) - Optional - Library path for library assets.
  - **filename** (string) - Optional - Filename for PDF.
  - **standalone** (boolean) - Optional - Standalone or not.
  - **withoutLoader** (boolean) - Optional - Whether to show the document loader or not.

### Request Example
```javascript
import { initMuPDFWebViewer } from 'mupdf-webviewer'

initMuPDFWebViewer('#viewer', 'sample.pdf', {
  libraryPath: 'lib',
  licenseKey: 'YOUR_LICENSE_KEY',
})
  .then(mupdf => {
    /* Returns a mupdfwv.MuPDFWebViewer object for our API access */
    mupdf.toast.show({ type: 'success', content: 'Opened' });
  })
  .catch(err => {
    /* Error handling */
    console.log(err);
  });
```

### Response
#### Success Response (200)
- **mupdfwv.MuPDFWebViewer** (object) - An object instance containing sub-object instances for API access.

#### Response Example
(Resolved Promise with mupdfwv.MuPDFWebViewer object)
```

--------------------------------

### Get Total PDF Page Count with JavaScript

Source: https://webviewer-docs.mupdf.com/api-reference/document/index

Gets the total number of pages in the currently opened PDF document using the 'getPageCount' method. This method returns a Promise that resolves with an object containing the 'pageCount'.

```javascript
mupdf.document.getPageCount();

// returns e.g

{ pageCount: number }
```

--------------------------------

### Initialize MuPDF WebViewer API

Source: https://webviewer-docs.mupdf.com/api-reference/introduction

Initializes the MuPDF WebViewer API by providing a selector for the target div, the document URL, and an options object including the license key. It returns a Promise that resolves with a `mupdfwv.MuPDFWebViewer` object or rejects with an error. Ensure the `licenseKey` is valid and the `docURL` points to an accessible document.

```javascript
import { initMuPDFWebViewer } from 'mupdf-webviewer'

initMuPDFWebViewer('#viewer', 'sample.pdf', {
  libraryPath: 'lib',
  licenseKey: 'YOUR_LICENSE_KEY',
})
  .then(mupdf => {
    /* Returns a mupdfwv.MuPDFWebViewer object for our API access */
    mupdf.toast.show({ type: 'success', content: 'Opened' });
  })
  .catch(err => {
    /* Error handling */
    console.log(err);
  });
```

--------------------------------

### getRotation

Source: https://webviewer-docs.mupdf.com/api-reference/viewer

Gets the current document rotation angle in degrees.

```APIDOC
## getRotation

### Description
Gets the current document rotation angle in degrees.

### Method
GET

### Endpoint
/viewer/rotation

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **degree** (number) - The rotation angle in degrees.

#### Response Example
```json
{
  "degree": 90
}
```
```

--------------------------------

### API - viewer.openContextMenu

Source: https://webviewer-docs.mupdf.com/api-reference/changelog

New API to programmatically open context menus.

```APIDOC
## POST /api/viewer/openContextMenu

### Description
Programmatically opens a context menu at a specified location on the document. This feature was added in version 0.7.0.

### Method
POST

### Endpoint
/api/viewer/openContextMenu

### Parameters
#### Request Body
- **x** (number) - Required - The x-coordinate where the context menu should open.
- **y** (number) - Required - The y-coordinate where the context menu should open.
- **menuItems** (array of object) - Required - An array of menu item configurations.
  - **text** (string) - Required - The text to display for the menu item.
  - **callback** (function) - Optional - The function to execute when the menu item is clicked.

### Request Example
```json
{
  "x": 300,
  "y": 400,
  "menuItems": [
    {"text": "Option 1", "callback": () => console.log('Option 1 clicked')},
    {"text": "Option 2"}
  ]
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the context menu was opened successfully.

#### Response Example
```json
{
  "success": true
}
```
```

--------------------------------

### openContextMenu

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Programmatically opens the context menu.

```APIDOC
## openContextMenu

### Description
Opens the context menu.

### Method
POST (Assumed, as it triggers a UI action)

### Endpoint
`/viewer/contextMenu/open` (Assumed)

### Parameters
No parameters required.

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### getCurrentPageIndex

Source: https://webviewer-docs.mupdf.com/api-reference/viewer

Gets the current page index (zero-indexed) of the document.

```APIDOC
## getCurrentPageIndex

### Description
Gets the current page index (zero-indexed).

### Method
GET

### Endpoint
/viewer/currentPageIndex

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **currentPageIndex** (number) - The current page index.

#### Response Example
```json
{
  "currentPageIndex": 0
}
```
```

--------------------------------

### Viewer Side Panel Management

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

APIs for opening and closing side view panels such as bookmarks or search.

```APIDOC
## POST /viewer/openSideView

### Description
Opens a specified side view panel.

### Method
POST

### Endpoint
/viewer/openSideView

### Parameters

#### Request Body
- **config** (object) - Required - An object containing the side view panel to open.
  - **type** (mupdf.refs.panel.open) - Required - The type of panel to open (e.g., BOOKMARK, THUMBNAIL).

### Request Example
```json
{
  "config": {
    "type": "BOOKMARK"
  }
}
```

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

---

## POST /viewer/closeSideView

### Description
Closes a specified side view panel.

### Method
POST

### Endpoint
/viewer/closeSideView

### Parameters

#### Request Body
- **config** (object) - Required - An object containing the side view panel to close.
  - **type** (mupdf.refs.panel.close) - Required - The type of panel to close (e.g., RIGHT, LEFT).

### Request Example
```json
{
  "config": {
    "type": "RIGHT"
  }
}
```

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

```

--------------------------------

### GET /api/getSize

Source: https://webviewer-docs.mupdf.com/api-reference/viewer

Retrieves the current dimensions (width and height) of the viewer.

```APIDOC
## GET /api/getSize

### Description
Gets the current size of the viewer.

### Method
GET

### Endpoint
/api/getSize

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **Promise<{ width: number; height: number; }>** - Resolves with an object containing the viewer's width and height.
  - **width** (number) - The width of the viewer in pixels.
  - **height** (number) - The height of the viewer in pixels.

#### Response Example
```json
{
  "width": 800,
  "height": 600
}
```
```

--------------------------------

### Events API

Source: https://webviewer-docs.mupdf.com/api-reference/introduction

Documentation on how to listen to various events emitted by the MuPDF WebViewer.

```APIDOC
## Events API

### Description
Documentation on how to listen to various events emitted by the MuPDF WebViewer.

### Endpoint

`/api-reference/events/index`
```

--------------------------------

### Get Viewer Size

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Retrieves the current dimensions (width and height) of the viewer.

```APIDOC
## GET /viewer/getSize

### Description
Gets the current dimensions of the viewer widget.

### Method
GET

### Endpoint
/viewer/getSize

### Parameters
*None*

### Request Example
```javascript
async function getViewerSize() {
    return mupdf.viewer.getSize();
}

getViewerSize().then(result => {
    console.log(`Viewer size: ${result.width}x${result.height}`);
}).catch(error => {
    console.error(`Error getting viewer size: ${error}`);
});
```

### Response
#### Success Response (200)
- **width** (number) - The current width of the viewer.
- **height** (number) - The current height of the viewer.

### Response Example
```json
{
  "width": 800,
  "height": 600
}
```
```

--------------------------------

### Viewer Page Fitting and Scrolling

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

APIs for fitting document pages to different view constraints and scrolling through pages.

```APIDOC
## POST /viewer/fitTo

### Description
Sets the page fitting behavior for the viewer.

### Method
POST

### Endpoint
/viewer/fitTo

### Parameters

#### Request Body
- **config** (object) - Required - Object containing the page fitting type.
  - **to** (mupdf.refs.fit.to) - Required - The fitting type (e.g., WIDTH, HEIGHT, PAGE).

### Request Example
```json
{
  "config": {
    "to": "WIDTH"
  }
}
```

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

---

## POST /viewer/scrollToNextPage

### Description
Scrolls the viewer to the next page.

### Method
POST

### Endpoint
/viewer/scrollToNextPage

### Parameters

#### Query Parameters
None

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

---

## POST /viewer/scrollToPreviousPage

### Description
Scrolls the viewer to the previous page.

### Method
POST

### Endpoint
/viewer/scrollToPreviousPage

### Parameters

#### Query Parameters
None

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

---

## POST /viewer/scrollTo

### Description
Scrolls the viewer to a specific position on a page or to an annotation.

### Method
POST

### Endpoint
/viewer/scrollTo

### Parameters

#### Request Body
- **config** (object) - Required - The configuration object for scrolling.
  - **type** (mupdf.refs.scroll.type) - Required - The type of scroll target (PAGE or ANNOTATION).
  - **value** (number) - Required - The target value (page index for PAGE type, annotation ID for ANNOTATION type).
  - **centerPoint** (object) - Optional - The center point of the page for PAGE type scrolls. Contains `x` and `y` coordinates.
  - **select** (boolean) - Optional - Whether to select the annotation when scrolling to it (for ANNOTATION type).
  - **name** (string) - Optional - The name of the annotation to scroll to (for ANNOTATION type).
  - **pageIndex** (number) - Optional - The page index to scroll to an annotation on (for ANNOTATION type).

### Request Example
```json
{
  "config": {
    "type": "PAGE",
    "value": 3
  }
}
```

### Response
#### Success Response (200)
No specific response body defined, indicates successful operation.

```

--------------------------------

### Viewer API - getScale

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Gets the current zoom scale of the document viewer.

```APIDOC
## GET /viewer/getScale

### Description
Gets the current zoom scale.

### Method
GET

### Endpoint
/viewer/getScale

### Response
#### Success Response (200)
- **scale** (number) - The current zoom scale.

#### Response Example
```json
{
  "scale": 1.5
}
```
```

--------------------------------

### Annotation Event Handling

Source: https://webviewer-docs.mupdf.com/annotations

Demonstrates how to listen for annotation creation events and modify annotation properties.

```APIDOC
## Setting the Annotation Author

### Description
This section explains how to set metadata for newly created annotations, such as the author's name, by listening to the `ANNOTATION_CREATE` event.

### Method
Event Listener

### Endpoint
(Not applicable, uses event system)

### Event
`ANNOTATION_CREATE`

### Event Data Structure
- **event.data.annotation** (mupdfwv.Annotation) - The annotation object being created.

### Example
```javascript
mupdf.addEventListener(mupdf.refs.event.type.ANNOTATION_CREATE, event => {
    // Set the author for the new annotation
    event.data.annotation.author = 'Jane Doe';
    
    // Update the annotation with the modified properties
    mupdf.annotation.set({
        annotations: [
            event.data.annotation,
        ],
    });
});
```
```

--------------------------------

### Create Watermarks using Configuration in JavaScript

Source: https://webviewer-docs.mupdf.com/api-reference/watermark/index

Demonstrates the usage of the `create` method of the watermark object. This method takes a configuration object that includes an array of `TextWatermark` or `ImageWatermark` objects to be applied to the document. Ensure the `watermarks` array is correctly populated with valid watermark definitions.

```javascript
mupdf.watermark.create({
  watermarks: [
    // Array of mupdfwv.TextWatermark or mupdfwv.ImageWatermark objects
  ]
});

```

--------------------------------

### Getting Current Viewer Scale in JavaScript

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Retrieves the current zoom scale of the viewer. This is an asynchronous operation returning a promise.

```javascript
async function getScale() {
    return mupdf.viewer.getScale();
}

function success(result) {
    console.log(`Scale is: ${result.scale}`);
}

function failure(error) {
    console.error(`Error: ${error}`);
}

getScale().then(success, failure);
```

--------------------------------

### Get Selected Text API

Source: https://webviewer-docs.mupdf.com/api-reference/text/index

Retrieves the currently selected text from the document. Returns null if no text is currently selected.

```APIDOC
## GET /text/getSelected

### Description
Gets the currently selected text from the document. If no text is selected, this method returns null.

### Method
GET

### Endpoint
/text/getSelected

### Parameters
This endpoint does not accept any parameters.

### Request Example
```javascript
async function getSelectedText() {
    return mupdf.text.getSelected();
}

getSelectedText();
```

### Response
#### Success Response (200)
- **text** (string) - The currently selected text. This field is null if no text is selected.
- **pageIndex** (number) - The page index where the text is selected.
- **rects** (array) - An array of rectangles defining the location of the selected text on the page.
  - **top** (number) - The top coordinate of the rectangle.
  - **left** (number) - The left coordinate of the rectangle.
  - **bottom** (number) - The bottom coordinate of the rectangle.
  - **right** (number) - The right coordinate of the rectangle.

#### Response Example
```json
{
    "text": "selected text snippet",
    "pageIndex": 2,
    "rects": [
        {"top": 200, "left": 60, "bottom": 215, "right": 150}
    ]
}
```

#### Success Response (200) - No Selection

```json
null
```
```

--------------------------------

### Get Selected Text API

Source: https://webviewer-docs.mupdf.com/api-reference/text

Retrieves the currently selected text from the document, including its page index and bounding box coordinates.

```APIDOC
## GET /text/getSelected

### Description
Retrieves the currently selected text from the document. If no text is selected, it returns `null`.

### Method
GET

### Endpoint
/text/getSelected

### Response
#### Success Response (200)
- **text** (string) - The selected text.
- **pageIndex** (number) - The index of the page where the text is selected.
- **rects** (array) - An array of rectangles defining the selected text's position on the page.
  - **top** (number) - The top coordinate of the rectangle.
  - **left** (number) - The left coordinate of the rectangle.
  - **bottom** (number) - The bottom coordinate of the rectangle.
  - **right** (number) - The right coordinate of the rectangle.

#### Response Example
```json
{
  "text": "Selected text example",
  "pageIndex": 1,
  "rects": [
    {
      "top": 50,
      "left": 100,
      "bottom": 70,
      "right": 200
    }
  ]
}
```

#### Null Response (200)
Returns `null` if no text is selected.

```json
null
```
```

--------------------------------

### Open Context Menu on Text Selection

Source: https://webviewer-docs.mupdf.com/customization/index

This section explains how to listen for text selection changes and open the context menu using the `viewer.openContextMenu()` function.

```APIDOC
## Open Context Menu on Text Selection

### Description
Listen for text selection changes and programmatically open the context menu.

### Method
Event Listener (`TEXT_SELECTION_CHANGE`)

### Endpoint
N/A (Client-side event)

### Parameters
None directly for opening, but relies on text selection.

### Request Example
```javascript
mupdf.addEventListener(mupdf.refs.event.type.TEXT_SELECTION_CHANGE, (e) => {
    function getSelectedText() {
        mupdf.text.getSelected().then(successCallbackGetText, failureCallbackGetText)
    }

    function successCallbackGetText(result) {
        if (result) {
            mupdf.viewer.openContextMenu();
        }
    }

    function failureCallbackGetText(error) {
        console.error(`Error: ${error}`);
    }

    getSelectedText();
});
```

### Response
#### Success Response
Opens the context menu.

#### Response Example
N/A
```

--------------------------------

### Add Context Menu Items

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Adds custom items to the document's right-click context menu. Configuration includes an array of menu items, each with a type, position, and optional icon, label, or click handler. This function returns a Promise.

```javascript
viewer.addContextMenu({
  menus: [
    {
      type: "MENU",
      position: "FIRST",
      label: "Custom Item",
      onclick: function() {
        console.log("Custom item clicked");
      }
    }
  ]
});
```

--------------------------------

### Get Current Zoom Scale

Source: https://webviewer-docs.mupdf.com/api-reference/viewer

Retrieves the current zoom scale of the document view. Returns a Promise that resolves with an object containing the 'scale' number.

```javascript
async function getScale() {
    return mupdf.viewer.getScale();
}

function success(result) {
    console.log(`Scale is: ${result.scale}`);
}

function failure(error) {
    console.error(`Error: ${error}`);
}

getScale().then(success, failure);

```

--------------------------------

### Context Menu API

Source: https://webviewer-docs.mupdf.com/api-reference/viewer

APIs for managing and customizing the context menu that appears on right-click.

```APIDOC
## POST /addContextMenu

### Description
Adds custom items to the viewer's context menu.

### Method
POST

### Endpoint
/addContextMenu

### Parameters
#### Request Body
- **config** (object) - Required - The configuration object for the context menu.
  - **menus** (array) - Required - An array of menu item configurations.
    - **type** (string) - Required - The type of menu item, must be "MENU".
    - **position** (string) - Required - The position of the menu item, "FIRST" or "LAST".
    - **icon** (object) - Optional - The icon for the menu item. See [mupdf.refs.icon](/api-reference/refs/index#icon).
    - **label** (string) - Optional - The text label for the menu item.
    - **onclick** (Function) - Optional - The click handler function for the menu item.

### Request Example
```json
{
  "config": {
    "menus": [
      {
        "type": "MENU",
        "position": "LAST",
        "label": "Custom Action",
        "onclick": function() { console.log('Custom action clicked!'); }
      }
    ]
  }
}
```

### Response
#### Success Response (200)
- **Promise** - A promise that resolves when the operation is complete.

## POST /openContextMenu

### Description
Opens the context menu programmatically.

### Method
POST

### Endpoint
/openContextMenu

### Parameters
None

### Response
#### Success Response (200)
- **Promise** - A promise that resolves when the operation is complete.
```

--------------------------------

### Get Document Rotation

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Fetches the current rotation angle of the document in degrees. This function returns a Promise. Dependencies include the mupdf viewer library.

```javascript
async function getRotation() {
    return mupdf.viewer.getRotation();
}

function success(result) {
    console.log(`Rotation is: ${result.degree}`);
}

function failure(error) {
    console.error(`Error: ${error}`);
}

getRotation().then(success, failure);
```

--------------------------------

### Get Annotations - JavaScript

Source: https://webviewer-docs.mupdf.com/api-reference/annotation/index

Retrieves annotations from a PDF document using the MuPDF WebViewer's Annotation API. It can fetch all annotations or those from a specific page.

```javascript
mupdf.annotation.get({pageIndex:0});
```

--------------------------------

### Customizing Document Panels with `viewer.defineDocumentPanel()`

Source: https://webviewer-docs.mupdf.com/api-reference/changelog

The `viewer.defineDocumentPanel()` API provides the functionality to create and customize document panels within the viewer. This allows for the integration of features like bookmark panels and markups panels, enhancing document navigation and management.

```javascript
viewer.defineDocumentPanel({
  name: "customPanel",
  // Panel configuration...
});
```

--------------------------------

### Get All Redactions in JavaScript

Source: https://webviewer-docs.mupdf.com/api-reference/redaction/index

Retrieves all unapplied redactions for the document. If called without arguments, it returns all redactions across all pages. Applied redactions are permanent and will not be returned.

```javascript
mupdf.redaction.get();
```

--------------------------------

### Text Instance API

Source: https://webviewer-docs.mupdf.com/api-reference/introduction

Provides an interface for accessing and searching document text.

```APIDOC
## Text Instance API

### Description
Provides an interface for accessing and searching document text.

### Methods

- **search(text)**: Searches for specific text within the document.

### Endpoint

`/api-reference/text/index`
```

--------------------------------

### Define Document Panel

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Defines a custom panel in the viewer's left-side toolbar. The configuration requires an array of items, each with a label, a click handler, and an optional icon. This function returns a Promise.

```javascript
defineDocumentPanel({
  items: [
    {
      label: "My Panel",
      onclick: function() {
        console.log("My panel clicked");
      },
      icon: "path/to/icon.png"
    }
  ]
});
```

--------------------------------

### Define Right Click Action

Source: https://webviewer-docs.mupdf.com/customization

This endpoint allows you to override the default behavior of the right-click action on the document. You can define a custom function to be executed when a right-click occurs.

```APIDOC
## Define Right Click Action

### Description
This endpoint allows you to override the default behavior of the right-click action on the document. You can define a custom function to be executed when a right-click occurs.

### Method
`viewer.defineRightClickAction()`

### Endpoint
N/A (API Method Call)

### Parameters
#### Request Body
- **`onclick`** (function) - Required - The function to execute when the right-click action is triggered.

### Request Example
```javascript
mupdf.viewer.defineRightClickAction({onclick:myFunc});

function myFunc() {
    alert("Your JS here!");
}
```

### Response
#### Success Response (200)
Custom right-click action is set.

#### Response Example
N/A (Configuration change)
```

--------------------------------

### Get Selected Text API

Source: https://webviewer-docs.mupdf.com/api-reference/changelog

Introduces the `text.getSelected()` API, which allows retrieval of the currently selected text within the document viewer. This is fundamental for features like copy-pasting or text analysis.

```javascript
const selectedText = text.getSelected();
console.log(selectedText);
```

--------------------------------

### Open Side View Panel

Source: https://webviewer-docs.mupdf.com/api-reference/viewer/index

Activates and displays a side view panel within the viewer, such as bookmarks or outlines. It requires a configuration object specifying the panel type to open (e.g., mupdf.refs.panel.open.BOOKMARK). This is an asynchronous operation returning a Promise.

```javascript
mupdf.viewer.openSideView({type:mupdf.refs.panel.open.BOOKMARK})
```

--------------------------------

### Watermark Instance API

Source: https://webviewer-docs.mupdf.com/api-reference/introduction

An interface to manage document watermarks, allowing for the creation of new watermarks.

```APIDOC
## Watermark Instance API

### Description
An interface to manage document watermarks, allowing for the creation of new watermarks.

### Methods

- **create(watermarkData)**: Creates a new watermark on the document.

### Endpoint

`/api-reference/watermark/index`
```

--------------------------------

### Show Toast Message with Success Type

Source: https://webviewer-docs.mupdf.com/api-reference/toast/index

An example of using the 'show' method of the toast object to display a success message. The configuration includes the type and content of the toast.

```javascript
mupdf.toast.show({ type: 'success', content: 'Document opened' });
```

--------------------------------

### Initialize Viewer Instance

Source: https://webviewer-docs.mupdf.com/api-reference/viewer

Accesses the viewer instance from the main mupdf.MuPDFWebViewer object. This assumes the viewer instance has been initialized and named 'mupdf'.

```javascript
const viewer = mupdf.viewer;

```
Tokens:
Raw