Api | PDFoundry

The PDFoundry API

You can access the API with ui.PDFoundry.

Hierarchy

Index

Other Accessors

Utility Accessors

Utilities

Open Methods

Other Methods

PDFData Methods

Utility Methods

showHelp

Debug Object literals

DEBUG

Other Accessors

Static activeTheme

get activeTheme(): ViewerTheme

- Defined in src/pdfoundry/Api.ts:140
Get the currently enabled theme id.

Returns ViewerTheme

Static availableThemes

get availableThemes(): {}

- Defined in src/pdfoundry/Api.ts:148
Get a map of themes available for use.

Returns {}

Utility Accessors

Static Utilities

get Utilities(): { canOpenPDF: canOpenPDF; deletePDFData: deletePDFData; getAbsoluteURL: getAbsoluteURL; getPDFData: getPDFData; getRoutePrefix: getRoutePrefix; getUserIdsExceptMe: getUserIdsExceptMe; isEntityPDF: isEntityPDF; setPDFData: setPDFData; validateAbsoluteURL: validateAbsoluteURL }

- Defined in src/pdfoundry/Api.ts:184
A reference to the unclassified utility functions.

category

Utility

Returns { canOpenPDF: canOpenPDF; deletePDFData: deletePDFData; getAbsoluteURL: getAbsoluteURL; getPDFData: getPDFData; getRoutePrefix: getRoutePrefix; getUserIdsExceptMe: getUserIdsExceptMe; isEntityPDF: isEntityPDF; setPDFData: setPDFData; validateAbsoluteURL: validateAbsoluteURL }
- canOpenPDF: canOpenPDF
- deletePDFData: deletePDFData
- getAbsoluteURL: getAbsoluteURL
- getPDFData: getPDFData
- getRoutePrefix: getRoutePrefix
- getUserIdsExceptMe: getUserIdsExceptMe
- isEntityPDF: isEntityPDF
- setPDFData: setPDFData
- validateAbsoluteURL: validateAbsoluteURL

Open Methods

Static openPDF

openPDF(pdf: PDFData, options?: PDFOpenOptions): Promise<BaseViewer>

- Defined in src/pdfoundry/Api.ts:316
Open the provided PDFData to the specified page.

Parameters
- pdf: PDFData
  
  The PDF to open. See Api.findPDFData.
- Optional options: PDFOpenOptions
  
  The specified options for PDFs.
Returns Promise<BaseViewer>

Static openPDFByCode

openPDFByCode(code: string, options?: PDFOpenOptions): Promise<BaseViewer>

- Defined in src/pdfoundry/Api.ts:276
Open the PDF with the provided code to the specified page. Helper for findPDFDataByCode then openPDF.

Parameters
- code: string
- Optional options: PDFOpenOptions
Returns Promise<BaseViewer>

Static openPDFByName

openPDFByName(name: string, options?: PDFOpenOptions): Promise<BaseViewer>

- Defined in src/pdfoundry/Api.ts:295
Open the PDF with the provided code to the specified page. Helper for findPDFDataByCode then openPDF.

Parameters
- name: string
- Optional options: PDFOpenOptions
Returns Promise<BaseViewer>

Static openURL

openURL(url: string, page?: number, cache?: boolean): Promise<BaseViewer>

- Defined in src/pdfoundry/Api.ts:373
Open a URL as a static PDF. For form fillable PDFs you muse use Api.openPDF

Parameters
- url: string
  
  The URL to open (must be absolute).
- Default value page: number = 1
  
  Which page to open to. Must be >= 1.
- Default value cache: boolean = true
  
  If URL based caching should be used.
Returns Promise<BaseViewer>

Other Methods

Static getTheme

getTheme(id: string): ViewerTheme | null

- Defined in src/pdfoundry/Api.ts:133
Get a full theme definition by id.

Parameters
- id: string
  
  The unique id of the theme to lookup.
Returns ViewerTheme | null

Static registerTheme

registerTheme(id: string, name: string, filePath: string): void

- Defined in src/pdfoundry/Api.ts:162
Register a theme for use with PDFoundry. You must register a theme before ready. Do so in setup.

Parameters
- id: string
  
  The unique id of the theme. Providing an already existing id will over-write the existing theme.
- name: string
  
  The user-facing display name of the theme.
- filePath: string
  
  The relative path of the theme css file
Returns void

PDFData Methods

Static findPDFData

findPDFData(comparer: PDFValidator, allowInvisible?: boolean): PDFData | undefined

- Defined in src/pdfoundry/Api.ts:258
Finds a PDF entity created by the user and constructs a PDFData object of the resulting PDF's data.

Parameters
- comparer: PDFValidator
  
  A comparison function that will be used.
- Default value allowInvisible: boolean = true
  
  See allowVisible on findPDFEntity
Returns PDFData | undefined

Static findPDFDataByCode

findPDFDataByCode(code: string, allowInvisible?: boolean): PDFData | undefined

- Defined in src/pdfoundry/Api.ts:227
Helper method. Alias for Api.findPDFData with a comparer that searches by PDF Code.

Parameters
- code: string
  
  Which code to search for a PDF with.
- Default value allowInvisible: boolean = true
  
  See allowVisible on findPDFEntity
Returns PDFData | undefined

Static findPDFDataByName

findPDFDataByName(name: string, caseInsensitive?: boolean, allowInvisible?: boolean): PDFData | undefined

- Defined in src/pdfoundry/Api.ts:240
Helper method. Alias for Api.findPDFData with a comparer that searches by PDF Name.

Parameters
- name: string
  
  Which name to search for a PDF with.
- Default value caseInsensitive: boolean = true
  
  If a case insensitive search should be done.
- Default value allowInvisible: boolean = true
  
  See allowVisible on findPDFEntity
Returns PDFData | undefined

Static findPDFEntity

findPDFEntity(comparer: PDFValidator, allowInvisible?: boolean): JournalEntry | undefined

- Defined in src/pdfoundry/Api.ts:206
Find a PDF containing journal entry from the journals directory using a specified comparer.

Parameters
- comparer: PDFValidator
  
  The function to compare PDF data with.
- Default value allowInvisible: boolean = true
  
  If true, PDFs hidden from the active user will be returned.
Returns JournalEntry | undefined

Utility Methods

Static showHelp

showHelp(): Promise<BaseViewer>

- Defined in src/pdfoundry/Api.ts:394
Shows the user manual to the active user.

Returns Promise<BaseViewer>

Debug Object literals

Static DEBUG

DEBUG: object

Enable additional debug information for the specified category.

EVENTS

EVENTS: boolean = false

When set to true, enables the logging event names and arguments to console.

Hierarchy

Index

Other Accessors

Utility Accessors

Open Methods

Other Methods

PDFData Methods

Utility Methods

Debug Object literals

Other Accessors

Static activeTheme

Returns ViewerTheme

Static availableThemes

Returns {}

Utility Accessors

Static Utilities

Returns { canOpenPDF: canOpenPDF; deletePDFData: deletePDFData; getAbsoluteURL: getAbsoluteURL; getPDFData: getPDFData; getRoutePrefix: getRoutePrefix; getUserIdsExceptMe: getUserIdsExceptMe; isEntityPDF: isEntityPDF; setPDFData: setPDFData; validateAbsoluteURL: validateAbsoluteURL }

canOpenPDF: canOpenPDF

deletePDFData: deletePDFData

getAbsoluteURL: getAbsoluteURL

getPDFData: getPDFData

getRoutePrefix: getRoutePrefix

getUserIdsExceptMe: getUserIdsExceptMe

isEntityPDF: isEntityPDF

setPDFData: setPDFData

validateAbsoluteURL: validateAbsoluteURL

Open Methods

Static openPDF

Parameters

pdf: PDFData

Optional options: PDFOpenOptions

Returns Promise<BaseViewer>

Static openPDFByCode

Parameters

code: string

Optional options: PDFOpenOptions

Returns Promise<BaseViewer>

Static openPDFByName

Parameters

name: string

Optional options: PDFOpenOptions

Returns Promise<BaseViewer>

Static openURL

Parameters

url: string

Default value page: number = 1

Default value cache: boolean = true

Returns Promise<BaseViewer>

Other Methods

Static getTheme

Parameters

id: string

Returns ViewerTheme | null

Static registerTheme

Parameters

id: string

name: string

filePath: string

Returns void

PDFData Methods

Static findPDFData

Parameters

comparer: PDFValidator

Default value allowInvisible: boolean = true

Returns PDFData | undefined

Static findPDFDataByCode

Parameters

code: string

Default value allowInvisible: boolean = true

Returns PDFData | undefined

Static findPDFDataByName

Parameters

name: string

Default value caseInsensitive: boolean = true

Default value allowInvisible: boolean = true

Returns PDFData | undefined

Static findPDFEntity

Parameters

comparer: PDFValidator

Default value allowInvisible: boolean = true