Foxit PDF SDK for Web

https://webviewer-demo.foxit.com/docs/10-0-0/
Admin
Foxit PDF SDK for Web is a comprehensive JavaScript library that enables developers to integrate PDF...
Tokens:809,249
Snippets:4,725
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Configuring GotoNextPageController in Fragment Configuration

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_goto_next_page_controller

Provides an example of how to configure the GotoNextPageController within a PDF UI's fragment configuration. This method allows for programmatic setup of the page navigation feature, specifying the controller as a callback.

```javascript
new PDFUI({
  fragments: [{
    target: 'goto-next-page',
    config: {
      callback: UIExtension.controllers.GotoNextPageController
    }
  }]
});
```

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

### Start Callout Annotation Creation (JavaScript)

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_create_free_text_callout_service

Begins the callout annotation creation by recording the initial starting point. This method is called at the onset of the creation process and requires a DevicePoint object as input.

```javascript
void start (point: DevicePoint)
```

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

### PolyLine Annotation - Get Start Style

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_poly_line

Retrieves the starting style of a polyline annotation. This feature is supported on the server.

```APIDOC
## GET /websites/webviewer-demo_foxit_10-0-0/PolyLine/getStartStyle

### Description
Get callout line start style. [Support in Server]

### Method
GET

### Endpoint
/websites/webviewer-demo_foxit_10-0-0/PolyLine/getStartStyle

### Parameters
None

### Response
#### Success Response (200)
- **startStyle** (number) - An integer value representing the ending style. Please refer to Ending_Style.

#### Response Example
```json
{
  "startStyle": 1
}
```
```

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

### SnapshotServer Constructor and Usage

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_snapshot_server

This section covers the initialization of the SnapshotServer and provides an example of its usage with a custom upload path.

```APIDOC
## POST /snapshot/upload

### Description
Initializes the SnapshotServer to handle custom screenshot image storage. It allows configuration of the upload API path, request method, and response handling.

### Method
POST

### Endpoint
(This is a conceptual endpoint for the upload functionality, the actual API path is configured during instantiation)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (The upload happens via the `uploadImage` method)

### Request Example
```javascript
var snapshotServer = new SnapshotServer({
  uploadSnapshotAPIPath: 'snapshot/upload',
  method: 'POST'
});
```

### Response
#### Success Response (200)
(Response handling is customizable via the `render` callback)

#### Response Example
(Depends on the `render` callback implementation)

## ◆ constructor()

### Description
Creates a SnapshotServer instance with optional configuration for custom screenshot image storage.

### Method
constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

#### Options Object
- **render** (function) - Optional - A custom callback function `(responseText: string) => string` used to process the response content.
- **payloadFieldName** (string) - Optional - The field name for the image data in the upload request. Defaults to 'file'.
- **origin** (string) - Optional - The domain name for same-origin image URLs.
- **uploadSnapshotAPIPath** (string) - Required - The pathname for the snapshot upload API.
- **method** (string) - Optional - The request method, either 'POST' or 'PUT'. Defaults to 'POST'.

### Request Example
```javascript
var snapshotServer = new SnapshotServer({
  uploadSnapshotAPIPath: 'snapshot/upload',
  render: function(response) {
    // Custom response processing
    return JSON.parse(response).imageUrl;
  }
});
```

### Response
None (Constructor does not return a value directly)

## ◆ uploadImage()

### Description
Uploads image blob data to the configured snapshot server. It returns a Promise that resolves with a same-origin image URL, which can help bypass certain browser limitations.

### Method
POST or PUT (depending on constructor configuration)

### Endpoint
(Uses the `uploadSnapshotAPIPath` configured in the constructor)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **imageData** (Blob) - Required - The image data to upload.

### Request Example
```javascript
// Assuming 'blob' contains the image data
snapshotServer.uploadImage(blob)
  .then(imageUrl => {
    console.log('Uploaded image URL:', imageUrl);
  })
  .catch(error => {
    console.error('Error uploading image:', error);
  });
```

### Response
#### Success Response (Promise<string>)
- **imageUrl** (string) - A same-origin URL for the uploaded image.

#### Response Example
```json
"https://your-domain.com/path/to/uploaded-image.jpg"
```
```

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

### Initialization and State Management

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_u_i-members

Methods for waiting for initialization and managing various viewer states.

```APIDOC
## PDFUI::waitForInitialization

### Description
Waits for the PDFUI component to complete its initialization.

### Method
GET

### Endpoint
`/pdfui/waitForInitialization`

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

## PDFViewer::setAutoCalculateFieldsFlag

### Description
Sets a flag to automatically calculate form fields.

### Method
PUT

### Endpoint
`/pdfviewer/setAutoCalculateFieldsFlag`

### Parameters
#### Request Body
- **autoCalculate** (boolean) - Required - True to enable auto-calculation, false to disable.

### Request Example
```json
{
  "autoCalculate": true
}
```

## PDFViewer::setEnableJS

### Description
Enables or disables JavaScript execution within the PDF viewer.

### Method
PUT

### Endpoint
`/pdfviewer/setEnableJS`

### Parameters
#### Request Body
- **enable** (boolean) - Required - True to enable JavaScript, false to disable.

### Request Example
```json
{
  "enable": false
}
```
```

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

### Get Line Annotation Start Point

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_line

Retrieves the coordinates of the start point of a line annotation. The start point is returned as a JSON object containing 'x' and 'y' numerical values. Supported in Server.

```javascript
function getLineStartPoint(annotation) {
  return annotation.getStartPoint();
}
```

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

### Get Measure Ratio Example

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_poly_line

Example demonstrating how to retrieve the scale ratio for measurements from a PolyLine annotation using the getMeasureRatio method.

```javascript
function example(annot){
annot.getMeasureRatio()
}
```

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

### Configuration and Options

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_foreach_directive

Provides details on configuration options and settings for various WebViewer features.

```APIDOC
## Configuration and Options

### Description
This section describes various configuration objects and options that can be used to customize WebViewer behavior.

### Options
- **DropdownComponentOptions**: Options for configuring DropdownComponent.
- **FormFieldComponentOptions**: Options for configuring FormFieldComponent.
- **GroupComponentOptions**: Options for configuring GroupComponent.
- **FragmentComponentOptions**: Options for configuring FragmentComponent.
- **HandStateHandlerConfig**: Configuration for the Hand tool state handler.
- **LayerComponentOptions**: Options for configuring LayerComponent.
- **LayerHeaderComponentOptions**: Options for configuring LayerHeaderComponent.
- **LineThicknessValues**: Defines possible line thickness values.
- **MarkingColorValues**: Defines possible marking color values.
- **OverlayComparisonOptions**: Options for overlay comparison.
- **OverlayComparisonOptionsService**: Service for overlay comparison options.
- **OverlayComparisonService**: Service for overlay comparison functionality.
- **OverlayComparisonTransformationOptions**: Transformation options for overlay comparison.
- **OpacityValues**: Defines possible opacity values.
```

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

### Get PolyLine Start Style

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_poly_line

Retrieves the starting style of a callout line. This method is supported on the server. It returns an integer value representing the style.

```javascript
/**
 * Get callout line start style.
 * [Support in Server]
 * @returns {number} An integer value. Please refer to Ending_Style.
 */
annot.getStartStyle()
```

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

### PDFViewer Initialization

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_u_i

Methods for initializing and configuring the PDFViewer instance.

```APIDOC
## PDFViewer Constructor

### Description
Initializes a new PDFViewer instance with a wide range of configuration options.

### Method
Constructor

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **preloadJR** (boolean) - Optional - Preload JR.
- **preloadSR** (boolean) - Optional - Preload SR.
- **libPath** (string) - Optional - Path to the library.
- **jr** (object) - Optional - JR instance.
- **sr** (object) - Optional - SR instance.
- **i18n** (object) - Optional - Internationalization settings.
- **i18nOptions** (object) - Optional - i18n options.
- **eventEmitter** (EventEmitter) - Optional - Event emitter instance.
- **minScale** (number) - Optional - Minimum zoom scale.
- **maxScale** (number) - Optional - Maximum zoom scale.
- **defaultScale** (string) - Optional - Default zoom scale ('fitWidth', etc.).
- **scaleFrequency** (number) - Optional - Scale frequency.
- **tileSize** (number) - Optional - Tile size for rendering.
- **tileCache** (number) - Optional - Tile cache size.
- **getTileSize** (function) - Optional - Function to get tile size.
- **StateHandlers** (Array) - Optional - Array of state handlers.
- **customs** (object) - Optional - Custom configurations.
- **keymap** (object) - Optional - Keymap configurations.
- **Viewmodes** (Array) - Optional - Array of view modes.
- **enableJS** (boolean) - Optional - Enable JavaScript execution.
- **enableSafeMode** (boolean) - Optional - Enable safe mode.
- **stateHandlerConfig** (object) - Optional - State handler configuration.
- **watermarkConfig** (object) - Optional - Watermark configuration.
- **actionOptions** (object) - Optional - Action options.
- **defaultViewMode** (string) - Optional - Default view mode (e.g., 'continuousViewModeName').
- **snapshotServer** (SnapshotServer) - Optional - Snapshot server instance.
- **collaboration** (object) - Optional - Collaboration settings.
- **highPerformance** (boolean) - Optional - Enable high performance mode.
- **annotRenderingMode** (string) - Optional - Annotation rendering mode.
- **defaultKeyboardEventBinder** (object) - Optional - Default keyboard event binder.
- **defaultAnnotConfig** (object) - Optional - Default annotation configuration.
- **enableSignature** (boolean) - Optional - Enable signature functionality.
- **enableShortcutKey** (boolean) - Optional - Enable shortcut keys.
- **enable3DInteraction** (boolean) - Optional - Enable 3D interaction.
- **enableLoad3DModule** (boolean) - Optional - Enable loading of 3D module.
- **engineMode** (string) - Optional - PDF engine mode ('JR', etc.).
- **sharedWorker** (boolean) - Optional - Use shared worker.
- **noJSFrame** (boolean) - Optional - Disable JS frame.
- **showCommentList** (boolean) - Optional - Show comment list.
- **showAnnotTooltip** (boolean) - Optional - Show annotation tooltip.
- **showFormFieldTooltip** (boolean) - Optional - Show form field tooltip.
- **showMeasurementInfoPanel** (boolean) - Optional - Show measurement info panel.
- **viewerUI** (object) - Optional - Viewer UI instance.
- **applicationContext** (object) - Optional - Application context.
- **instanceId** (string) - Optional - Unique instance ID.
- **messageSyncServiceWorker** (object) - Optional - Message sync service worker.

### Request Example
```javascript
const viewer = new PDFViewer({
  libPath: '/lib',
  defaultScale: 'fitWidth'
});
```

### Response
#### Success Response (200)
N/A (Constructor)

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

```APIDOC
## init

### Description
Initializes the PDFViewer within a specified DOM element.

### Method
`init(selector)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **selector** (string | HTMLElement) - Required - The CSS selector or DOM element to initialize the viewer in.

### Request Example
```javascript
viewer.init('#viewer-container');
```

### Response
#### Success Response (200)
N/A

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

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

### Get Measure Unit Example

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_poly_line

Example demonstrating how to retrieve the unit label used for displaying measurements from a PolyLine annotation using the getMeasureUnit method.

```javascript
function example(annot){
annot.getMeasureUnit()
}
```

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

### Configuration and Utility Functions

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_viewer

APIs for configuring the viewer, managing fonts, and accessing utility services.

```APIDOC
## addFontMaps (fontMaps)

### Description
Sets a custom font in the viewer for editing PDF text/form field. Before using this function, you should call setJRFontMap() to map the available fonts.

### Method
POST

### Endpoint
/addFontMaps

### Parameters
#### Request Body
- **fontMaps** (object) - Required - An object mapping font names to font definitions.

## constructor ({ preloadJR=true, preloadSR=false, libPath, jr, sr, i18n, i18nOptions, eventEmitter=new EventEmitter(), minScale=0.01, maxScale=10, defaultScale='fitWidth', scaleFrequency=0, tileSize=1000000, tileCache=2, getTileSize=null, StateHandlers=[], customs={}, keymap={}, Viewmodes=[], enableJS, enableSafeMode, stateHandlerConfig, watermarkConfig, actionOptions={}, defaultViewMode=continuousViewModeName, snapshotServer=new SnapshotServer({ uploadSnapshotAPIPath:'snapshot/upload' }), collaboration={ enable:false, annotationFormat:'fdf', communicator:null, handlerClasses:[], continueToConnect:(retryTimes, shareId)=> {return retryTimes< 15;} }, highPerformance=false, annotRenderingMode, defaultKeyboardEventBinder=VIEWER_BINDER, defaultAnnotConfig, enableSignature, enableShortcutKey=true, enable3DInteraction=true, enableLoad3DModule=true, engineMode=JR, sharedWorker=false, noJSFrame=false, showCommentList=false, showAnnotTooltip=false, showFormFieldTooltip=false, showMeasurementInfoPanel=true, viewerUI, applicationContext, instanceId, messageSyncServiceWorker, }={})

### Description
Create a PDFViewer. More...

### Method
POST

### Endpoint
/constructor

### Parameters
#### Request Body
- **preloadJR** (boolean) - Optional - Whether to preload JR.
- **preloadSR** (boolean) - Optional - Whether to preload SR.
- **libPath** (string) - Optional - Path to the library.
- **jr** (object) - Optional - JR object.
- **sr** (object) - Optional - SR object.
- **i18n** (object) - Optional - Internationalization settings.
- **i18nOptions** (object) - Optional - Internationalization options.
- **eventEmitter** (EventEmitter) - Optional - Event emitter instance.
- **minScale** (number) - Optional - Minimum zoom scale.
- **maxScale** (number) - Optional - Maximum zoom scale.
- **defaultScale** (string) - Optional - Default zoom scale.
- **scaleFrequency** (number) - Optional - Scale frequency.
- **tileSize** (number) - Optional - Tile size.
- **tileCache** (number) - Optional - Tile cache size.
- **getTileSize** (function) - Optional - Function to get tile size.
- **StateHandlers** (array) - Optional - Array of state handlers.
- **customs** (object) - Optional - Custom options.
- **keymap** (object) - Optional - Keymap configuration.
- **Viewmodes** (array) - Optional - Array of view modes.
- **enableJS** (boolean) - Optional - Whether to enable JavaScript execution.
- **enableSafeMode** (boolean) - Optional - Whether to enable safe mode.
- **stateHandlerConfig** (object) - Optional - State handler configuration.
- **watermarkConfig** (object) - Optional - Watermark configuration.
- **actionOptions** (object) - Optional - Action options.
- **defaultViewMode** (string) - Optional - Default view mode.
- **snapshotServer** (SnapshotServer) - Optional - Snapshot server instance.
- **collaboration** (object) - Optional - Collaboration settings.
- **highPerformance** (boolean) - Optional - Whether to enable high performance mode.
- **annotRenderingMode** (string) - Optional - Annotation rendering mode.
- **defaultKeyboardEventBinder** (object) - Optional - Default keyboard event binder.
- **defaultAnnotConfig** (object) - Optional - Default annotation configuration.
- **enableSignature** (boolean) - Optional - Whether to enable signature functionality.
- **enableShortcutKey** (boolean) - Optional - Whether to enable shortcut keys.
- **enable3DInteraction** (boolean) - Optional - Whether to enable 3D interaction.
- **enableLoad3DModule** (boolean) - Optional - Whether to enable loading 3D modules.
- **engineMode** (string) - Optional - Engine mode.
- **sharedWorker** (boolean) - Optional - Whether to use a shared worker.
- **noJSFrame** (boolean) - Optional - Whether to disable JS frames.
- **showCommentList** (boolean) - Optional - Whether to show the comment list.
- **showAnnotTooltip** (boolean) - Optional - Whether to show annotation tooltips.
- **showFormFieldTooltip** (boolean) - Optional - Whether to show form field tooltips.
- **showMeasurementInfoPanel** (boolean) - Optional - Whether to show the measurement info panel.
- **viewerUI** (object) - Optional - Viewer UI object.
- **applicationContext** (object) - Optional - Application context.
- **instanceId** (string) - Optional - Instance ID.
- **messageSyncServiceWorker** (object) - Optional - Message sync service worker.

## getActionCallbackManager ()

### Description
Obtains the ActionCallbackManager.

### Method
GET

### Endpoint
/getActionCallbackManager

## getBookmarkDataService ()

### Description
Obtains the BookmarkDataService instance for managing bookmark data.

### Method
GET

### Endpoint
/getBookmarkDataService

## getCustomOptionsUpdater ()

### Description
Retrieves the CustomOptionsUpdater instance for updating custom options dynamically.

### Method
GET

### Endpoint
/getCustomOptionsUpdater

## getDefaultAnnotConfig ()

### Description
Get the callback function which is used to configure the default settings for the annotations.

### Method
GET

### Endpoint
/getDefaultAnnotConfig

## getEnableJS ()

### Description
Checks if PDF js can be executed. [Not supported in Server]

### Method
GET

### Endpoint
/getEnableJS

## getEventEmitter ()

### Description
Get event emitter.

### Method
GET

### Endpoint
/getEventEmitter

## getFormHighlightColor ()

### Description
Gets the form highlight color.

### Method
GET

### Endpoint
/getFormHighlightColor

## getInkSignList (type)

### Description
Get ink signature list.

### Method
GET

### Endpoint
/getInkSignList

### Parameters
#### Query Parameters
- **type** (string) - Required - The type of ink signature list to retrieve.

## getInstanceId ()

### Description
Get the unique instance ID.

### Method
GET

### Endpoint
/getInstanceId

## getOverlayComparisonOptionsService ()

### Description
Obtains the OverlayComparisonOptionsService, which will be used to configure and share overlay-comparison options between multiple PDFViewer instances and to monitor option changes.

### Method
GET

### Endpoint
/getOverlayComparisonOptionsService

## getOverlayComparisonService ()

### Description
Obtains the OverlayComparisonService instance, which includes the built-in overlay comparison function.

### Method
GET

### Endpoint
/getOverlayComparisonService

## getPDFPageRender (index)

### Description
GetPDFPageRender PDFDocRender::getPDFPageRender.

### Method
GET

### Endpoint
/getPDFPageRender

### Parameters
#### Query Parameters
- **index** (number) - Required - The index of the page.

## getReadAloudService ()

### Description
Obtains the ReadAloudService instance.

### Method
GET

### Endpoint
/getReadAloudService

## getRotation ()

### Description
Obtains the rotation degree of the current document. The result returned is one of these values: 0, 90, 180, 270.

### Method
GET

### Endpoint
/getRotation

## getScrollWrap ()

### Description
Obtains the scroll wrap instance.

### Method
GET

### Endpoint
/getScrollWrap

## getSnapMode (stateHandlerName)

### Description
Gets the snap mode for a given state handler.

### Method
GET

### Endpoint
/getSnapMode

### Parameters
#### Query Parameters
- **stateHandlerName** (string) - Required - The name of the state handler.

```

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

### Storage Management

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/hierarchy

Interfaces and drivers for managing storage contexts and different storage driver solutions.

```APIDOC
## CStorageContext

### Description
Stores the context used to generate storage space names.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## CPDFViewerStorageContext

### Description
This is an extension of the StorageContext interface. Storage requests triggered by business layer code above the PDFViewerCtrl layer usually carry a PDFViewer instance. Therefore, this interface describes such a StorageContext.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## CStorageDriver

### Description
Represents a storage driver.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## CIndexedDBStorageDriver

### Description
The default built-in storage driver solution based on IndexedDB since 9.2.0.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## CLocalStorageDriver

### Description
The storage driver solution based on localStorage.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## CStorageDriverChangeEvent< T >

### Description
Represents an event triggered when there is a change in the storage driver. T The type of the old and new values in the storage change event.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## CStorageDriverRemoveEvent

### Description
Represents an event triggered when a stored value is removed in the storage driver.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

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

### Get Line Annotation Start Style

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_line

Retrieves the starting style of a line annotation. The style is returned as an integer value, which corresponds to predefined Ending_Style constants. Supported in Server.

```javascript
function getLineStartStyle(annotation) {
  return annotation.getStartStyle();
}
```

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

### Get Start Character Index - JavaScript

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_text_markup

Gets the index of the first character within the text range marked by the annotation. This method is supported on the server-side and returns a number representing the character index. It takes no arguments.

```javascript
const startCharIndex = textMarkupAnnotation.getStartCharIndex();
console.log(startCharIndex);
```

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

### File and Download Controllers

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_proxy-members

Documentation for controllers handling file downloads and related services.

```APIDOC
## DownloadFileController

### Description
Controller responsible for managing file download operations within the WebViewer.

### Method
GET

### Endpoint
/downloadfile

### Parameters
#### Query Parameters
- **filename** (string) - Required - The name of the file to be downloaded.
- **content** (string) - Required - The content of the file to be downloaded.

### Request Example
```
GET /downloadfile?filename=example.pdf&content=JVBERi0xLjQKJcOkw7zDtsO0CjEgMCBvYmoKPDwvVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFI+PgplbmRvYmoKCiAyIDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9Db3VudCAxCi9LaWRzIFszIDAgUgo+PgplbmRvYmoKCiAzIDAgb2JqCjw8L1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgo+PgplbmRvYmoK
```

```APIDOC
## DownloadFileService

### Description
Service layer for handling the logic behind file downloads.

### Method
GET

### Endpoint
/downloadfileservice

### Parameters
#### Query Parameters
- **filename** (string) - Required - The name of the file.
- **content** (string) - Required - The content to be included in the file.
```

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

### Get Line Annotation Leader Line Points

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_line

Retrieves the start and end points of the leader line for a line annotation. Returns a JSON object containing 'start' and 'end' points, each with 'x' and 'y' coordinates. Supported in Server.

```javascript
function getLineLeaderLinePoints(annotation) {
  return annotation.getLeaderLinePoints();
}
```

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

### Configuration and Registration

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_u_i

APIs for configuring SDK behavior, registering custom handlers, and managing settings.

```APIDOC
## registerMultimediaPlayers

### Description
Registers custom multimedia players with the Web SDK.

### Method
registerMultimediaPlayers

### Parameters
#### Path Parameters
- **multimediaPlayers** (Array) - Required - An array of multimedia player objects.

### Request Example
```javascript
pdfViewer.registerMultimediaPlayers([{ name: 'customPlayer', type: 'video' }]);
```

## registerPrintHandler

### Description
Registers a custom handler for print operations.

### Method
registerPrintHandler

### Parameters
#### Path Parameters
- **handler** (function) - Required - The print handler function.

### Request Example
```javascript
pdfViewer.registerPrintHandler(function(options) {
  console.log('Custom print handler called with options:', options);
  // Perform custom printing logic
});
```

## registerProgressHandler

### Description
Registers a callback function to handle progress updates.

### Method
registerProgressHandler

### Parameters
#### Path Parameters
- **callback** (function) - Required - The progress handler callback function.

### Request Example
```javascript
pdfViewer.registerProgressHandler(function(progress) {
  console.log('Progress:', progress.percentage, '%');
});
```

## registerSignatureHandler

### Description
Registers a signature handler. This is not supported in the server environment.

### Method
registerSignatureHandler

### Parameters
#### Path Parameters
- **filter** (string) - Required - The filter for the signature handler.
- **subfilter** (string) - Required - The sub-filter for the signature handler.
- **handler** (function) - Required - The signature handler function.

### Request Example
```javascript
pdfViewer.registerSignatureHandler('someFilter', 'someSubFilter', function(data) {
  console.log('Signature handler called:', data);
});
```

## setActionCallback

### Description
Sets an ActionCallback class to the Web SDK to perform PDF actions. Users must implement a class and call this function.

### Method
setActionCallback

### Parameters
#### Path Parameters
- **ActionCallbackClass** (class) - Required - The class implementing the action callback interface.

### Request Example
```javascript
class MyActionCallback {
  // Implement methods like onCreateAnnotation, onModifyAnnotation, etc.
}
pdfViewer.setActionCallback(MyActionCallback);
```

## setAutoCalculateFieldsFlag

### Description
Provides an API to set the 'Automatically Calculate Field Values' option.

### Method
setAutoCalculateFieldsFlag

### Parameters
#### Path Parameters
- **autoCalculate** (boolean) - Required - Set to true to enable automatic calculation, false to disable.

### Request Example
```javascript
pdfViewer.setAutoCalculateFieldsFlag(true);
```

## setDefaultAnnotConfig

### Description
Sets the default configured callback function for annotations. Refer to PDFPage::addAnnot for the return object format.

### Method
setDefaultAnnotConfig

### Parameters
#### Path Parameters
- **fn** (function) - Required - The default annotation configuration function.

### Request Example
```javascript
pdfViewer.setDefaultAnnotConfig(function(annotData) {
  console.log('Default annotation config for:', annotData);
  return { color: 'red' }; // Example default config
});
```

## setDefaultPrintSetting

### Description
Sets the default print settings for the document.

### Method
setDefaultPrintSetting

### Parameters
#### Path Parameters
- **printSetting** (Object) - Required - An object containing default print settings.

### Request Example
```javascript
pdfViewer.setDefaultPrintSetting({ showHeaderFooter: true, quality: 150 });
```
```

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

### PDFViewer Constructor

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_viewer

Initializes a new instance of the PDFViewer with specified options.

```APIDOC
## PDFViewer constructor

### Description
Creates a new PDFViewer instance. The constructor accepts a single `options` object for configuration.

### Method
`constructor`

### Endpoint
N/A (This is a class constructor)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
**options** (object) - The configuration object for the PDFViewer.

- **options.jr** (object) - JR engine configuration. (Not supported in Server).
  - **options.jr.licenseKey** (string) - JR engine license key.
  - **options.jr.licenseSN** (string) - JR engine license serial number.
  - **options.jr.l** (string) - License information. If provided, `jr.licenseKey` and `jr.licenseSN` are ignored.
  - **options.jr.workerPath** (string) - Path to the JR engine worker. Defaults to `options.libPath`.
  - **options.jr.enginePath** (string) - Path to the JR engine. Defaults to `options.libPath + 'jr-engine'`.
  - **options.jr.fontPath** (string) - Path to the JR engine fonts. Defaults to `'../external/brotli'`. Can also be a URL to Foxit's font server.
  - **options.jr.fontInfoPath** (string) - URL of the fonts information file.
  - **options.jr.readBlock** (number) - Size of each read block. Defaults to 8192.
  - **options.jr.brotli** (object) - Brotli compression configuration.
    - **options.jr.brotli.core** (boolean) - Whether to use brotli compression. Defaults to `true`.
- **options.preloadJR** (boolean) - Preloads the JR engine. (Not supported in Server). Defaults to `true`.
- **options.libPath** (string) - Path to the PDFViewer lib package. Defaults to the current page path.
- **options.minScale** (number) - Minimum zoom scale. Defaults to 0.01.
- **options.maxScale** (number) - Maximum zoom scale. Defaults to 10.
- **options.defaultScale** (number|string) - Default zoom scale. Can be 'fitWidth', 'fitHeight', or a numeric value. Defaults to 'fitWidth'.
- **options.scaleFrequency** (number) - Affects page rendering scale. Defaults to 0 (raw multiples, highest performance penalty).
- **options.tileSize** (number) - Deprecated. Use newer options for tile management.
- **options.tileCache** (boolean|number) - Enables or configures tile caching. Defaults to 2.
- **options.getTileSize** (Function) - Deprecated. Use newer options for tile management.
- **options.annotRenderingMode** (object) - Deprecated. Controls annotation rendering mode.
- **options.i18n** (object) - An instance of i18next for internationalization.
- **options.i18nOptions** (object) - Options for initializing i18next if not provided.
  - **options.i18nOptions.initOption** (object) - i18next initialization options. Defaults to `{ ns: 'viewer_' }`.
  - **options.i18nOptions.path** (string) - Path to the localization files. Defaults to `options.libPath + 'locales'`.

### Request Example
```json
{
  "jr": {
    "licenseKey": "YOUR_LICENSE_KEY",
    "workerPath": "/path/to/jr-worker.js"
  },
  "libPath": "/path/to/pdfviewer/lib",
  "defaultScale": "fitHeight",
  "i18nOptions": {
    "path": "/locales/"
  }
}
```

### Response
#### Success Response (200)
N/A (This is a constructor, it returns an instance of PDFViewer)

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

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

### Get Annotation Dictionary Entry

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_square

Retrieves a property from the annotation's dictionary using a specified key. No specific language example provided, but assumes a key-value lookup.

```javascript
getDictionaryEntry (key)
```

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

### Get Default Appearance Font Size - PDFField API

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_field

Retrieves the font size used for the default appearance of a PDF field. This example demonstrates how to get the PDF viewer, then the PDF document, form, and finally the specific field to call this method. Returns a number representing the font size.

```javascript
let fieldname = 'ComboBox0'
let pdfviewer = await pdfui.getPDFViewer()
let field = pdfviewer.getPDFDocRender().getPDFDoc().getPDFForm().getField(fieldname)
field.getDAFontSize()
```

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

### Component Localization and Construction

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_reply_card_component

Methods related to component localization and initial construction.

```APIDOC
## Component Localization and Construction

### `PDFUI instance`

**Description**: Represents the PDFUI instance. This instance is passed into a component after construction, so an undefined value might be returned during the constructor lifecycle.

**Method**: N/A

**Endpoint**: N/A

### `localize(localizer=this.localizer)`

**Description**: Localizes messages using the value of the `data-i18n` attribute above the component's DOM element recursively.

**Method**: POST

**Endpoint**: N/A (Instance method)
```

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

### Get Page Word Count

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_page

Retrieves the total word count of the PDF page. This method returns a Promise that resolves to a number representing the word count. It is available starting from version 10.0.0.

```javascript
/**
 * Get the page's word count.
 * @returns {Promise<number>} - The page's word count.
 */
async function getWordCount(pdfPage) {
  return pdfPage.getWordCount();
}
```

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

### Component Initialization and Rendering

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_tree_node_component-members

Methods related to the component's lifecycle, including pre-linking and rerendering.

```APIDOC
## Component Initialization and Rendering

### Description
Methods involved in the initial setup and dynamic updates of components.

### Methods
- `prelink()`: Called before the component is linked into the DOM.
- `removeElement()`: Removes the component's associated DOM element.

### Example
```javascript
// Perform actions before linking
component.prelink();

// Remove the component's DOM element
component.removeElement();
```
```

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

### Get Count of Review State Annotations

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_markup

Retrieves the number of state annotations when the state model is 'review'. This functionality is supported on the server. It counts the chain of state annotations, starting from the markup annotation.

```javascript
WebViewer(...).Markup.getReviewStateCount();
```

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

### Controller Lifecycle Hooks

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_controller

Documentation for the controller's lifecycle methods: mounted, postlink, and prelink.

```APIDOC
## Lifecycle Hooks

### mounted()
#### Description
This method is called after the component is inserted into the DOM tree. Use it for event listeners or other tasks.

### postlink()
#### Description
This method is called during the component's postlink lifecycle.

### prelink()
#### Description
This method is called during the component's prelink lifecycle.
```

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

### LaunchAction API

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_launch_action

Provides details on the methods available for the LaunchAction class, including getting and setting file specifications.

```APIDOC
## GET /LaunchAction

### Description
Retrieves the file specifications associated with a launch action.

### Method
GET

### Endpoint
/LaunchAction

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **fileSpec** (FileSpec) - The file specifications object.

#### Response Example
```json
{
  "fileSpec": {
    "fileName": "example.pdf"
  }
}
```

## POST /LaunchAction

### Description
Sets the file specifications for a launch action.

### Method
POST

### Endpoint
/LaunchAction

### Parameters
#### Request Body
- **fileSpec** (FileSpec) - Required - The file specifications object to set.

### Request Example
```json
{
  "fileSpec": {
    "fileName": "./example.pdf"
  }
}
```

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

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

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

### Get PageGraphicsObject Instance

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_page_graphics_object

Example of obtaining a PageGraphicsObject instance using the Page Editor Addon. This allows for manipulation of graphic objects within a PDF.

```javascript
pdfui.getAddonInstance('PageEditor').then(pageEditorAddon => {
  if (pageEditorAddon) {
    const graphicObject = pageEditorAddon.getActiveGraphicsObject();
    // You can now manipulate the graphic object.
  } else {
    console.error("Page Editor Addon instance not found.");
  }
});
```

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

### UIAppearance Class Documentation

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_u_i_appearance

Detailed documentation for the UIAppearance class, including its purpose, lifecycle methods like `afterMounted` and `beforeMounted`, and inherited methods for managing UI components.

```APIDOC
## Class UIAppearance

### Description
An appearance like a packed theme. It provides a layout template and also allows to do things related to UE in `beforeMounted` or `afterMounted` method. When the layout template is rewritten, it is best to inherit this class and override the `disableAll` and `enableAll` methods to handle associated logic.

### Inheritance
Inherits from `Appearance` and `Disposable`.

### Member Functions

#### `afterMounted(root)`

- **Description**: A lifecycle method, will always be called after the root component is mounted into the DOM tree.
- **Parameters**:
  - `root` (Component) - The root component.

#### `beforeMounted(root)`

- **Description**: A lifecycle method, will always be called before the root component is mounted into the DOM tree.
- **Parameters**:
  - `root` (Component) - The root component.

### Inherited Protected Member Functions from Appearance

#### `disableAll()`

- **Description**: A method to disable those components that are activated only when the current PDF document is displayed. It's called when the `PDFViewCtrl.constants.ViewerEvents.willCloseDocument` event is triggered.

#### `enableAll()`

- **Description**: A method to enable those components that are disabled by calling the `disableAll()` method. It's called when the `PDFViewCtrl.constants.ViewerEvents.openFileSuccess` event is triggered.

#### `getDefaultFragments()`

- **Description**: Returns the UI fragments array, which defines several UI components and business logics.

#### `getLayoutTemplate()`

- **Description**: A method that provides a layout template.

### Inherited Static Public Member Functions from Appearance

#### `extend(proto, statics)`

- **Description**: Extends from the `Appearance` class and generates a customized appearance.
- **Parameters**:
  - `proto` - Prototype properties for the new appearance.
  - `statics` - Static properties for the new appearance.
```

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

### View Mode Manager API (Conceptual)

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_view_mode_manager

Provides conceptual examples of core View Mode Manager functions such as getting a view mode by name, retrieving all registered view modes, and getting the currently active view mode. These methods are fundamental for interacting with and managing the viewer's display settings.

```javascript
// Get view mode by name
const continuousMode = pdfViewer.getViewModeManager().get('continuous-view-mode');

// Get all view modes
const allModes = pdfViewer.getViewModeManager().getAll();

// Get current view mode
const currentMode = pdfViewer.getViewModeManager().getCurrentViewMode();
```

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

### File and Download Management

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_i_context_menu_item-members

Components and services related to file handling, downloading, and storage.

```APIDOC
## File and Download Management

### Description
Manages file operations including downloading files and handling file selections.

### Endpoints

- **DownloadFileController**
- **DownloadFileService**
- **FileAttachment**
- **FileSelectorComponent**
- **ImportAnnotationsFileCollaborationData**
- **ImportAnnotationsFileOperationData**
- **IndexedDBStorageDriver**
- **LocalStorageDriver**
- **OpenFileParameter**
- **OpenLocalFileController**
- **OpenRemoteFileController**
- **MoveAnnotsBetweenPageCollaborationData**
- **MoveAnnotsBetweenPageOperationData**
- **PPOInsertPageCollaborationData**
- **PPOInsertPageOperationData**
- **PPOMovePageCollaborationData**

### Parameters
N/A for this group of components.
```

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

### Stamp Annotation - Get Image Data

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_stamp

Retrieves image data for the Stamp annotation in various formats (canvas, image, or buffer). This is an asynchronous operation. The function returns a Promise that resolves with the requested image data type. Example usage shows how to obtain buffer data and create a Blob URL.

```javascript
/**
 * Get the image data by the specified type.
 * @param {'canvas'|'image'|'buffer'} [type='canvas'] - The data type: 'canvas', 'image', or 'buffer'.
 * @returns {Promise<HTMLCanvasElement|HTMLImageElement|ArrayBuffer>} The image data.
 */
Stamp.prototype.getImage = async function(type = 'canvas') {
  // Implementation details...
};

// Example Usage:
async function getImageData(annot) {
  const imageBuf = await annot.getImage('buffer');
  const blob = new Blob([imageBuf], {type: 'image/png'});
  const url = URL.createObjectURL(blob);
  console.log('Image URL:', url);
}
```

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

### CreateAnnotationService API

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_create_annotation_service

Documentation for the CreateAnnotationService interface, which defines the base functionality for creating annotations. It includes details about the prepare method for initialization.

```APIDOC
## CreateAnnotationService

### Description
This is a service interface that defines the function of creating Annotation, and classes that create specific Annotations should inherit it.

### Method
Not Applicable (Interface)

### Endpoint
Not Applicable (Interface)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None

## Member Function Documentation
### ◆ prepare()
void CreateAnnotationService::prepare | ( | pageRender:PDFPageRender | | | ) \

#### Description
This method accepts a pageRender parameter and performs initialization. It should only be executed once.

#### Parameters
* **pageRender** (PDFPageRender) - Required - The page render object for initialization.

#### Returns
void

#### Since
8.1.0

Implemented in CreateFreeTextCalloutService.
```

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

### Thumbnail Zoom and Selection Events with Thumbnail Addon

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_p_d_f_u_i

This section covers interacting with thumbnail features. It includes examples for zooming thumbnails to a specific scale, getting the current zoom scale, and registering event listeners for thumbnail selection changes. The event listeners provide information about selected and previously selected page indexes.

```javascript
pdfui.callAddonAPI('Thumbnail', 'zoomTo', [0.96])
pdfui.callAddonAPI('Thumbnail', 'getZoomScale')
  .then(zoomScale => {
    console.log('current zoom scale is', zoomScale);
  })
pdfui.callAddonAPI('Thumbnail', 'onSelectThumbnail', [(selectedPageIndexes, lastSelectedPageIndexes) => {
  console.log('current selected page indexes', selectedPageIndexes, 'Last selected page indexes', lastSelectedPageIndexes);
}])
```

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

### DownloadFile Controller API

Source: https://webviewer-demo.foxit.com/docs/10-0-0/API_Reference/html/class_simple_event_emitter-members

Handles the process of downloading files initiated from the WebViewer.

```APIDOC
## DownloadFileController API

### Description
This API endpoint manages file download requests originating from the WebViewer interface.

### Method
GET

### Endpoint
`/api/download/file`

### Parameters
#### Query Parameters
- **fileUrl** (string) - Required - The URL of the file to be downloaded.
- **fileName** (string) - Optional - The desired name for the downloaded file.

### Request Example
N/A (GET request with query parameters)

### Response
#### Success Response (200)
- The response is the file content itself, with appropriate headers for download.

#### Response Example
(Binary file content)
```
Tokens:
Raw