FoxitPDFSDKforWeb v10.0.0
Foxit PDF SDK for Web
bookmark

A module containing bookmark APIs for managing PDF viewer bookmarks. More...

Classes

class  AddBookmarkEvent
 Represents an event that occurs when a new bookmark is added. More...
 
interface  AddBookmarkOptions
 Represents options for adding a new bookmark. More...
 
interface  BookmarkData
 Represents a bookmark entry in the document. More...
 
class  BookmarkDataService
 Provides functionality for management and manipulation of bookmark-related data. More...
 
interface  BookmarkProperties
 Represents properties of a bookmark. More...
 
class  DeleteBookmarkEvent
 Represents an event that occurs when a bookmark is deleted. More...
 
class  MoveBookmarkEvent
 Represents an event that occurs when a bookmark is moved. More...
 
interface  PasteCutBookmarkInfo
 Parameter of the callback function triggered when pasting a cut bookmark. More...
 
class  UpdateBookmarkPropertiesEvent
 Represents an event that occurs when bookmark properties are updated. More...
 

Variables

type BookmarkTextColor = number|[string,number,number|number]|string
 Represents color of a bookmark Supported color format: More...
 

Detailed Description

A module containing bookmark APIs for managing PDF viewer bookmarks.

Since
10.0.0

Variable Documentation

◆ BookmarkTextColor

type BookmarkTextColor = number|[string,number,number|number]|string

Represents color of a bookmark Supported color format:

  • number, such as 0xff0000, 16711680
  • PDF color array, such as ['RGB',1,1,1] which means white. Range: 0.0~1.0, The ratio to HTML color format is 1:255.
  • HTML color format, such as '#ff0000', 'rgb(255,0,0)', 'rgba(255,0,0,1)'.
    See also
    BookmarkProperties
    BookmarkDataService.setColor
    Since
    10.0.0

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