capacitor-pdf-helper

PDF Helper

Install

npm install capacitor-pdf-helper
npx cap sync

API

• open(...)
• close()
• readPDFAnnotations(...)
• getImageListFromResources()
• getImageFromAnnotation(...)
• getImageFromResources(...)
• Interfaces

open(...)

open(options: IOpenOptions) => Promise<IPHDocumentInfo>

Param	Type
options	IOpenOptions

Returns: Promise<IPHDocumentInfo>

---

close()

close() => Promise<any>

Returns: Promise<any>

---

readPDFAnnotations(...)

readPDFAnnotations(options: IOpenOptions) => Promise<IPHAnnotation[]>

Param	Type
options	IOpenOptions

Returns: Promise<IPHAnnotation[]>

---

getImageListFromResources()

getImageListFromResources() => Promise<IPHResourceImage[]>

Returns: Promise<IPHResourceImage[]>

---

getImageFromAnnotation(...)

getImageFromAnnotation(options: optionsImagesFromAnnotation) => Promise<IPHImageMetadata>

Param	Type
options	optionsImagesFromAnnotation

Returns: Promise<IPHImageMetadata>

---

getImageFromResources(...)

getImageFromResources(pidx: number, keyname: string) => Promise<IPHImageMetadata>

Param	Type
pidx	number
keyname	string

Returns: Promise<IPHImageMetadata>

---

Interfaces

IPHDocumentInfo

Prop	Type
pdfId	string
pageCount	number

IOpenOptions

Prop	Type
url	string

IPHAnnotation

Prop	Type
docFgId	string
fgId	string
name	string
type	string
contents	string
pageIndex	number
annotationIndex	number
creationDate	string
modifyDate	string
hasImage	boolean
updated	number

IPHResourceImage

Prop	Type
pageIndex	number
keyName	string
metadata	any

IPHImageMetadata

Prop	Type
imageUri	string
mimeType	string

optionsImagesFromAnnotation

Prop	Type
pidx	number
aidx	number