Provides some methods for interacting with PDF documents.
Component key: pdfDescription#
The pdf component provides some methods for interacting with PDF documents. Note that currently this component cannot handle PDF documents that are encrypted.
Actions#
Extract Page#
Returns the specified page in the given PDF document as a new separate PDF document. | key: extractPage
| Input | Key | Notes | Example |
|---|---|---|---|
Page Number string / Required | pageNumber | This specifies a page in a PDF document by number. | 5 |
PDF data data / Required | pdfData | This must refer to a Base64 encoded data URI or a buffer containing the raw bytes of a PDF. |
Find Pattern#
Searches the PDF document and returns a list of page numbers containing text that satisfies the search criteria. | key: findPattern
| Input | Key | Notes | Example |
|---|---|---|---|
Case Sensitive boolean / Required | caseSensitive | This specifies whether searching should be case-sensitive. You can choose true or false. | true |
Contains? boolean / Required | contains | This specifies whether to return page numbers that either contain or don't contain the search pattern. Options are true or false | true |
Search Pattern string / Required | pattern | This is the pattern to search for in the PDF document. | Some Text |
PDF data data / Required | pdfData | This must refer to a Base64 encoded data URI or a buffer containing the raw bytes of a PDF. | |
Use Regex boolean / Required | useRegex | This specifies whether the search pattern is a regular expression. | true |
Page Numbers#
Returns a sequence of page numbers for the specified PDF document, from 1 to the last page number. | key: pageNumbers
| Input | Key | Notes |
|---|---|---|
PDF data data / Required | pdfData | This must refer to a Base64 encoded data URI or a buffer containing the raw bytes of a PDF. |