FPdfPage

Facade for one materialized PDF page.

Access

Access through:

Example

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getElements())

Setup

Register @univerjs-pro/pdfs or a preset that includes it. In plugin mode, import @univerjs-pro/pdfs/facade. Additional methods below require their listed plugin packages. See Facade setup.

`@univerjs-pro/pdfs`

`FPdfPage.getAnnotations`

Return all editable annotations in z-order.

TypeScript

getAnnotations(): FPdfAnnotation[]

Returns

The annotation Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getAnnotations())

Types: FPdfAnnotation

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getData`

Return a detached snapshot of the current materialized page.

TypeScript

getData(): Readonly<IPdfPage>

Returns

The current page snapshot.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getData())

Types: IPdfPage · Readonly

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getDividers`

Return all editable dividers in z-order.

TypeScript

getDividers(): FPdfDivider[]

Returns

The divider Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getDividers())

Types: FPdfDivider

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getElementById`

Return one editable page element by ID.

TypeScript

getElementById(id: string): FPdfPageElement | null

Parameters

id — Required. The element ID.

Returns

The element Facade, or null when it does not exist.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElementById('element-id')console.log(element)

Types: FPdfPageElement

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getElements`

Return all editable page elements in z-order.

TypeScript

getElements(): FPdfPageElement[]

Returns

The editable element Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getElements())

Types: FPdfPageElement

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getId`

Return the stable page ID.

TypeScript

getId(): string

Returns

The page ID.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getId())

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getImages`

Return all editable managed images in z-order.

TypeScript

getImages(): FPdfImage[]

Returns

The image Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getImages())

Types: FPdfImage

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getIndex`

Return the current zero-based page index.

TypeScript

getIndex(): number

Returns

The current page index.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getIndex())

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getLists`

Return all semantic lists in z-order.

TypeScript

getLists(): FPdfList[]

Returns

The list Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getLists())

Types: FPdfList

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getParagraphs`

Return all story-backed paragraph frames in z-order.

TypeScript

getParagraphs(): FPdfParagraph[]

Returns

The paragraph Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getParagraphs())

Types: FPdfParagraph

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getTables`

Return all structured tables in z-order.

TypeScript

getTables(): FPdfTable[]

Returns

The table Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getTables())

Types: FPdfTable

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getTextBoxes`

Return all simple editable text boxes in z-order.

TypeScript

getTextBoxes(): FPdfTextBox[]

Returns

The text-box Facades.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getTextBoxes())

Types: FPdfTextBox

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.getTextSpans`

Return snapshot Facades for every currently visible native text operation.

TypeScript

getTextSpans(): FPdfTextSpan[]

Returns

The current native-text span snapshots.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)console.log(page.getTextSpans())

Types: FPdfTextSpan

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertAnnotation`

Insert one durable PDF annotation.

TypeScript

insertAnnotation(options: IPdfAnnotationInsertOptions): FPdfAnnotation

Parameters

options — Required. Annotation type, geometry, and placement.

Returns

The inserted annotation Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const annotation = page.insertAnnotation({  annotationType: univerAPI.Enum.PdfAnnotationType.HIGHLIGHT,  left: 36,  top: 72,  width: 180,  height: 18,})

Types: FPdfAnnotation · IPdfAnnotationInsertOptions

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertDivider`

Insert one editable vector divider.

TypeScript

insertDivider(options?: IPdfDividerInsertOptions): FPdfDivider

Parameters

options — Optional. Default: {}. Placement and stroke options.

Returns

The inserted divider Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const divider = page.insertDivider({  left: 36,  top: 144,  width: 200,  strokeWidth: 1,})

Types: FPdfDivider · IPdfDividerInsertOptions

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertImage`

Insert an image from detached builder information.

TypeScript

insertImage(info: IPdfImageBuilderInfo, index?: number): FPdfImage

Parameters

info — Required. The image builder result.
index — Optional. The optional z-order index.

Returns

The inserted image Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const imageInfo = page  .newImage()  .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4')  .setSize(240, 135)  .build()page.insertImage(imageInfo)

Types: FPdfImage · IPdfImageBuilderInfo

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertImageAsync`

Insert an image directly from a string or Blob source.

TypeScript

insertImageAsync(source: string | IFBlobSource, options?: IPdfImageInsertOptions): Promise<FPdfImage>

Parameters

source — Required. A URL, UUID, base64 value, or Blob source.
options — Optional. Default: {}. Optional placement, crop, opacity, and source type.

Returns

The inserted image Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const image = await page.insertImageAsync(  'https://avatars.githubusercontent.com/u/61444807?s=48&v=4',  {    left: 36,    top: 36,    width: 240,    height: 135,  },)

Types: FPdfImage · Promise · IFBlobSource · IPdfImageInsertOptions

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertList`

Insert one story-backed semantic list.

TypeScript

insertList(options: IPdfListInsertOptions): FPdfList

Parameters

options — Required. List text, kind, preset, and placement.

Returns

The inserted list Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.insertList({  text: 'First item',  kind: univerAPI.Enum.PdfListKind.UNORDERED,  preset: univerAPI.Enum.PdfListPresetId.UNORDERED_DISC,})list  .insertItem(1, { text: '第二项' })  .insertItem(2, { text: '子项', level: 1 })  .insertItem(3, { text: '第四项' })

Types: FPdfList · IPdfListInsertOptions

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertParagraph`

Insert one story-backed paragraph frame.

TypeScript

insertParagraph(options: IPdfParagraphInsertOptions): FPdfParagraph

Parameters

options — Required. Paragraph text, placement, and initial style.

Returns

The inserted paragraph Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const paragraph = page.insertParagraph({  text: 'First paragraph',  fontSize: 24,})

Types: FPdfParagraph · IPdfParagraphInsertOptions

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertTable`

Insert one structured editable table.

TypeScript

insertTable(options: IPdfTableInsertOptions): FPdfTable

Parameters

options — Required. Grid dimensions, values, placement, and theme.

Returns

The inserted table Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const table = page.insertTable({  rowCount: 2,  columnCount: 3,  cellTexts: ['A', 'B', 'C'],})

Types: FPdfTable · IPdfTableInsertOptions

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.insertTextBox`

Insert a simple editable text box using PDF-point geometry.

TypeScript

insertTextBox(options: IPdfTextBoxInsertOptions): FPdfTextBox

Parameters

options — Required. Text, placement, and initial text style.

Returns

The inserted text-box Facade.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const textBox = page.insertTextBox({  text: 'Hello PDF',  left: 36,  top: 36,})

Types: FPdfTextBox · IPdfTextBoxInsertOptions

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPage.newImage`

Return a detached image builder, optionally initialized from an image or ID.

TypeScript

newImage(existing?: FPdfImage | string): FPdfImageBuilder

Parameters

existing — Optional. An image Facade or explicit image ID to initialize.

Returns

A detached image builder.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const imageInfo = page  .newImage()  .setSource('https://avatars.githubusercontent.com/u/61444807?s=48&v=4')  .setSize(240, 135)  .build()page.insertImage(imageInfo)

Types: FPdfImageBuilder · FPdfImage

Package: @univerjs-pro/pdfs · Type definitions

How is this guide?