FPdfDivider

Facade for one editable vector divider.

Access

Access through:

• FPdfPage.getDividers()
• FPdfPage.insertDivider()

Inheritance

Extends FPdfPageElement. Its inherited members are available on this object.

Example

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const divider = page.insertDivider({  left: 36,  top: 144,  width: 200,  strokeWidth: 1,})console.log(divider.getStroke())divider.setStroke({  width: 2,  color: '#3366ff',})

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

FPdfDivider.getStroke

Return a detached divider-stroke snapshot.

Length fields are returned in PDF points.

getStroke(): Readonly<IPdfDividerStroke>

Returns

The current stroke snapshot.

Examples

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const divider = page.getDividers()[0]console.log(divider?.getStroke())

Types: IPdfDividerStroke · Readonly

Package: @univerjs-pro/pdfs · Type definitions

FPdfDivider.setStroke

Replace the divider stroke without changing its geometry.

Length fields are accepted in PDF points.

setStroke(stroke: IPdfDividerStroke): this

Parameters

• stroke — Required. The replacement stroke.

Returns

This divider Facade for chaining.

Throws

If the divider is stale or the durable command is rejected.

Examples

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const divider = page.getDividers()[0]if (divider) {  divider.setStroke({    width: 2,    color: '#3366ff',  })}

Types: IPdfDividerStroke

Package: @univerjs-pro/pdfs · Type definitions