FoxitPDFSDKforWeb v10.0.0
Foxit PDF SDK for Web
BookmarkDestination Interface Reference

Represents information about the destination of a bookmark. More...

Public Attributes

number bottom
 The bottom position on the page (in PDF coordinate system) (Optional). More...
 
number left
 Horizontal position on the page (in PDF coordinate system) (Optional, defaults to the current page position shown in the view). More...
 
number pageIndex
 Page index of the destination. (Optional, defaults to the current page index shown in the view) More...
 
number right
 The right position on the page (in PDF coordinate system). (Optional) More...
 
number top
 Vertical position on the page (in PDF coordinate system). (Optional, defaults to the current page position shown in the view) More...
 
number zoomFactor
 The zoom factor. More...
 
BookmarkZoomMode zoomMode
 The zoom mode of destination (Optional, defaults to BookmarkZoomMode.ZoomFitHorz) More...
 

Detailed Description

Represents information about the destination of a bookmark.

See also
BookmarkDataService.setDestination
Since
10.0.0

Member Data Documentation

◆ bottom

number BookmarkDestination::bottom

The bottom position on the page (in PDF coordinate system) (Optional).

Note
This option only takes effect when zoomMode is set to BookmarkZoomMode.ZoomFitRect
Since
10.0.0

◆ left

number BookmarkDestination::left

Horizontal position on the page (in PDF coordinate system) (Optional, defaults to the current page position shown in the view).

Note
This option only takes effect when zoomMode is set to BookmarkZoomMode.ZoomXYZ, BookmarkZoomMode.ZoomFitVert, BookmarkZoomMode.ZoomFitBVert and BookmarkZoomMode.ZoomFitRect
Since
10.0.0

◆ pageIndex

number BookmarkDestination::pageIndex

Page index of the destination. (Optional, defaults to the current page index shown in the view)

Since
10.0.0

◆ right

number BookmarkDestination::right

The right position on the page (in PDF coordinate system). (Optional)

Note
This option only takes effect when zoomMode is set to BookmarkZoomMode.ZoomFitRect
Since
10.0.0

◆ top

number BookmarkDestination::top

Vertical position on the page (in PDF coordinate system). (Optional, defaults to the current page position shown in the view)

Note
This option only takes effect when zoomMode is set to BookmarkZoomMode.ZoomXYZ, BookmarkZoomMode.ZoomFitHorz, BookmarkZoomMode.ZoomFitBHorz and BookmarkZoomMode.ZoomFitRect
Since
10.0.0

◆ zoomFactor

number BookmarkDestination::zoomFactor

The zoom factor.

Note
This option is only useful when zoomMode is BookmarkZoomMode.ZoomXYZ. If the zoom factor is 0, that means just use current zoom factor of application as the destination zoom factor.
Since
10.0.0

◆ zoomMode

BookmarkZoomMode BookmarkDestination::zoomMode

The zoom mode of destination (Optional, defaults to BookmarkZoomMode.ZoomFitHorz)

Since
10.0.0

Foxit Software Corporation Logo
@2024 Foxit Software Incorporated. All rights reserved.