# FPdfDivider

> Language fallback: requested `zh-CN`; content is `en-US`.

- Human documentation: [https://docs.univer.ai/zh-CN/reference/facade/pdf-divider](https://docs.univer.ai/zh-CN/reference/facade/pdf-divider)

- Agent Markdown: [https://docs.univer.ai/zh-CN/reference/facade/pdf-divider.md](https://docs.univer.ai/zh-CN/reference/facade/pdf-divider.md)

- Requested language: `zh-CN`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [facade/pdf-divider.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/facade/pdf-divider.mdx)

---

Facade for one editable vector divider.

## Access

Access through:

* [`FPdfPage.getDividers()`](https://docs.univer.ai/zh-CN/reference/facade/pdf-page.md#getdividers)
* [`FPdfPage.insertDivider()`](https://docs.univer.ai/zh-CN/reference/facade/pdf-page.md#insertdivider)

## Inheritance

Extends [`FPdfPageElement`](https://docs.univer.ai/zh-CN/reference/facade/pdf-page-element.md). Its inherited members are available on this object.

## Example

```ts
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`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs-pro/pdfs.md) 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](https://docs.univer.ai/zh-CN/guides/pdfs/getting-started/facade.md).

## `@univerjs-pro/pdfs`

### `FPdfDivider.getStroke`

Return a detached divider-stroke snapshot.

Length fields are returned in PDF points.

```typescript
getStroke(): Readonly<IPdfDividerStroke>
```

**Returns**

The current stroke snapshot.

**Examples**

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

**Types:** [`IPdfDividerStroke`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/facade/types.d.ts) · [`Readonly`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts)

**Package:** [`@univerjs-pro/pdfs`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs-pro/pdfs.md) · [Type definitions](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/facade/f-pdf-divider.d.ts)

### `FPdfDivider.setStroke`

Replace the divider stroke without changing its geometry.

Length fields are accepted in PDF points.

```typescript
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**

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

**Types:** [`IPdfDividerStroke`](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/facade/types.d.ts)

**Package:** [`@univerjs-pro/pdfs`](https://docs.univer.ai/zh-CN/reference/packages/plugins/univerjs-pro/pdfs.md) · [Type definitions](https://unpkg.com/@univerjs-pro/pdfs@1.0.0-rc.0/lib/types/facade/f-pdf-divider.d.ts)