Class: GoToAction

PSPDFKit.Actions.GoToAction

PDF action to go to a destination (page) in the current document.

It is an Immutable.Record and thus can be updated using set(key, value), for example: action.set("pageIndex", 2);.

A GoToAction can define a different pageIndex in the same document. When clicking on it, we will update the scroll position to make the page visible. We will not update the zoom level in that case.

Constructor

new PSPDFKit.Actions.GoToAction(args)

Go to a destination (page) in the current document.

Parameters:
Name Type Description
args Object

An object with the pageIndex key used to initialize the action.

Example

Create a new GoToAction

const action = new PSPDFKit.Actions.GoToAction({ pageIndex: 10 });

Extends

Members




Members

pageIndex: number

The page index of the page that should be made visible when triggering this action.

pageIndex is zero-based and has a maximum value of totalPageCount - 1.

Type:
  • number