FPdfList

Facade for one story-backed semantic PDF list.

Access

Access through:

Inheritance

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

Example

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: '第四项' })console.log(list.getItems())

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`

`FPdfList.changeItemLevel`

Set the absolute zero-based nesting level of one item. Increasing the level requires a preceding item at the parent level, so the first item can only use level 0.

TypeScript

changeItemLevel(itemId: string, level: number): this

Parameters

itemId — Required. The stable item ID.
level — Required. The nesting level from 0 through 8.

Returns

This list Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.getLists()[0]if (list) {  list.insertItem(1, { text: 'Child item' })  list.changeItemLevel(list.getItems()[1].id, 1)}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfList.getItems`

Return detached semantic list items in story order.

TypeScript

getItems(): readonly IPdfListItemSnapshot[]

Returns

The current list-item snapshots.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.getLists()[0]console.log(list?.getItems())

Types: IPdfListItemSnapshot

Package: @univerjs-pro/pdfs · Type definitions

`FPdfList.insertItem`

Insert one semantic list item at a zero-based index.

TypeScript

insertItem(index: number, item: IPdfListItemInput): this

Parameters

index — Required. The insertion index.
item — Required. The new item data.

Returns

This list Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.getLists()[0]if (list) {  list.insertItem(1, { text: 'Second item', level: 0 })}

Types: IPdfListItemInput

Package: @univerjs-pro/pdfs · Type definitions

`FPdfList.removeItem`

Remove one stable semantic list item.

TypeScript

removeItem(itemId: string): this

Parameters

itemId — Required. The stable item ID.

Returns

This list Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.getLists()[0]const item = list?.getItems()[0]if (list && item) {  list.removeItem(item.id)}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfList.setItemText`

Replace the body text of one stable list item.

TypeScript

setItemText(itemId: string, text: string): this

Parameters

itemId — Required. The stable item ID.
text — Required. The replacement body text.

Returns

This list Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.getLists()[0]const item = list?.getItems()[0]if (list && item) {  list.setItemText(item.id, 'Updated item')}

Package: @univerjs-pro/pdfs · Type definitions

`FPdfList.setPreset`

Replace this list's marker preset.

TypeScript

setPreset(preset: PdfListPresetId): this

Parameters

preset — Required. The new list preset.

Returns

This list Facade for chaining.

Examples

TypeScript

const pdf = univerAPI.getActivePdf()const page = pdf.getPageByIndex(0)const list = page.getLists()[0]if (list) {  list.setPreset(univerAPI.Enum.PdfListPresetId.UNORDERED_SQUARE)}

Types: PdfListPresetId

Package: @univerjs-pro/pdfs · Type definitions

`FPdfList.setStartNumber`

Set the starting ordinal for level zero of an ordered list. All built-in ORDERED_* presets support this operation; unordered lists do not.

TypeScript

setStartNumber(startNumber: number): this

Parameters

startNumber — Required. The positive first ordinal.

Returns

This list Facade for chaining.

Examples

TypeScript

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

Package: @univerjs-pro/pdfs · Type definitions

How is this guide?