FPdfPageElement

Cette page API est actuellement disponible en anglais. Les signatures et identifiants restent identiques dans toutes les langues.

Shared live Facade for an editable PDF page element.

Access

Access through:

Example

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]console.log(element?.getTransform())

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`

`FPdfPageElement.bringForward`

Move this element one step forward.

TypeScript

bringForward(): this

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.bringForward()}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.bringToFront`

Move this element above every other editable element on the page.

TypeScript

bringToFront(): this

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.bringToFront()}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.getData`

Return a detached snapshot of the current page-element data.

TypeScript

getData(): Readonly<T>

Returns

A detached object snapshot in core PDF units.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]console.log(element?.getData())

Types: Readonly

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.getId`

Return the stable page-element ID.

TypeScript

getId(): string

Returns

The element ID.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]console.log(element?.getId())

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.getTransform`

Return the current placement in PDF points.

TypeScript

getTransform(): IPdfFacadeTransform

Returns

The position, size, rotation, and flips.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]console.log(element?.getTransform())

Types: IPdfFacadeTransform

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.getType`

Return the underlying PDF object type.

TypeScript

getType(): PdfObjectType

Returns

The persisted PDF object type.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]console.log(element?.getType())

Types: PdfObjectType

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.remove`

Remove this editable element from the page.

TypeScript

remove(): void

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.remove()}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.sendBackward`

Move this element one step backward.

TypeScript

sendBackward(): this

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.sendBackward()}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.sendToBack`

Move this element to the back of the editable-element stack.

TypeScript

sendToBack(): this

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.sendToBack()}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.setLocked`

Set whether the element is locked.

TypeScript

setLocked(locked: boolean): this

Parameters

locked — Required. Whether the element is locked.

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.setLocked(true)}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.setPosition`

Set the top-left position in PDF points.

TypeScript

setPosition(left: number, top: number): this

Parameters

left — Required. The left position in points.
top — Required. The top position in points.

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.setPosition(36, 72)}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.setRotation`

Set the rotation in degrees around the element center.

TypeScript

setRotation(rotation: number): this

Parameters

rotation — Required. The rotation in degrees.

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.setRotation(15)}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.setSize`

Set the element size in PDF points while keeping its position.

TypeScript

setSize(width: number, height: number): this

Parameters

width — Required. The width in points.
height — Required. The height in points.

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.setSize(288, 144)}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.setTransform`

Update the complete placement using PDF points and degrees.

TypeScript

setTransform(transform: IPdfFacadeTransform): this

Parameters

transform — Required. The complete new placement.

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.setTransform({    left: 36,    top: 36,    width: 144,    height: 72,    rotation: 0,    flipX: false,    flipY: false,  })}

Types: IPdfFacadeTransform

Package: @univerjs-pro/pdfs · Type definitions

`FPdfPageElement.setVisible`

Set whether the element is visible.

TypeScript

setVisible(visible: boolean): this

Parameters

visible — Required. Whether the element is visible.

Returns

This element Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const element = page.getElements()[0]if (element) {  element.setVisible(false)}

Package: @univerjs-pro/pdfs · Type definitions

Que pensez-vous de ce guide ?