Class PdfPageCollection

Represents a collection of pages that make up a PDF document.

Hierarchy

PdfCollection<PdfPage>
- PdfPageCollection

Index

Accessors

count doc id last om

Methods

add addNew clear clone contains free getAt insert insertNew move rebind remove removeAt setAt swap

Accessors

count

get count(): number
Gets the number of items in the collection.

Returns number
Overrides PdfCollection.count

doc

get doc(): PdfDocument
Gets the owner PdfDocument.

Returns PdfDocument

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from PdfCollection.id

last

get last(): TItem | null
Gets last item in the collection.

Returns TItem | null
Inherited from PdfCollection.last

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from PdfCollection.om

Methods

add

add(item: PdfPage): void
Adds an item to the end of the collection.
Parameters
- item: PdfPage
  The item to add.
Returns void
Inherited from PdfCollection.add

addNew

addNew(): PdfPage
Adds a new PdfPage to the end of the collection.

Returns PdfPage
A PdfPage object added to the collection.
addNew(width: number, height: number): PdfPage
Creates a new PdfPage with the specified size and adds it to the end of the collection.
Parameters
- width: number
  The width of the new page, in points.
- height: number
  The height of the new page, in points.
Returns PdfPage
A PdfPage object added to the collection.
Example
```
const doc = new PdfDocument();
const page = doc.pages.addNew(500, 350);
page.context.drawEllipse(100, 100, 300, 150, {
    fillColor: "MediumAquamarine",
    lineColor: "Teal",
    lineWidth: 10
});
const res: Uint8Array = doc.savePdf();
```

clear

clear(): void
Clears the collection.

Returns void
Overrides PdfCollection.clear

clone

clone(
    sourceIndex: number,
    destinationIndex: number,
    cloneAnnotations?: boolean,
    cloneFields?: boolean,
): void
Clones a page at a specified index (sourceIndex) and inserts it at a specified position (destinationIndex).
Parameters
- sourceIndex: number
  The index of the page to clone.
- destinationIndex: number
  The destination index.
- cloneAnnotations: boolean = true
  Indicates whether to clone page annotations.
- cloneFields: boolean = true
  Indicates whether to clone fields existing on the source page.
Returns void

contains

contains(page: PdfPage): boolean
Determines whether the item is in the collection.
Parameters
- page: PdfPage
Returns boolean
true if the item is in the collection, false otherwise.

Overrides PdfCollection.contains

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from PdfCollection.free

getAt

getAt(index: number): PdfPage
Gets the item with the specified index.
Parameters
- index: number
  The index of the item.
Returns PdfPage
Overrides PdfCollection.getAt

insert

insert(index: number, page: PdfPage): void
Inserts an item at a specific position in the collection.
Parameters
- index: number
  The position where the item will be inserted.
- page: PdfPage
Returns void
Overrides PdfCollection.insert

insertNew

insertNew(index: number): PdfPage
Inserts a new PdfPage at a specific position in the collection.
Parameters
- index: number
  The position where the new page will be inserted.
Returns PdfPage
A PdfPage object inserted in the collection.
insertNew(index: number, width: number, height: number): PdfPage
Creates a new PdfPage with the specified size and inserts it at a specific position in the collection.
Parameters
- index: number
  The position where the new page will be inserted.
- width: number
  The width of the new page, in points.
- height: number
  The height of the new page, in points.
Returns PdfPage
A PdfPage object inserted in the collection.

move

move(sourceIndex: number, destinationIndex: number): void
Moves a page specified by its 0-based index to another position in the page collection.
Parameters
- sourceIndex: number
  The current index of the page to move.
- destinationIndex: number
  The new index of the page.
Returns void

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from PdfCollection.rebind

remove

remove(page: PdfPage): boolean
Removes the specified item from the collection.
Parameters
- page: PdfPage
Returns boolean
true if the item was actually removed, false otherwise.

Overrides PdfCollection.remove

removeAt

removeAt(index: number): void
Removes the item at specified index.
Parameters
- index: number
  The index of the item to remove.
Returns void
Overrides PdfCollection.removeAt

setAt

setAt(index: number, page: PdfPage): void
Sets the item at the specified index.
Parameters
- index: number
  The index of the item, starting from 0.
- page: PdfPage
Returns void
Overrides PdfCollection.setAt

swap

swap(pageIndex1: number, pageIndex2: number): void
Swaps two pages specified by their 0-based indices.
Parameters
- pageIndex1: number
  The index of the first page to swap.
- pageIndex2: number
  The index of the second page to swap.
Returns void

Class PdfPageCollection

Hierarchy

Index

Accessors

Methods

Accessors

count

Returns number

doc

Returns PdfDocument

id

Returns number

last

Returns TItem | null

om

Returns ObjectManager

Methods

add

Parameters

Returns void

addNew

Returns PdfPage

Parameters

Returns PdfPage

Example

clear

Returns void

clone

Parameters

Returns void

contains

Parameters

Returns boolean

free

Returns void

getAt

Parameters

Returns PdfPage

insert

Parameters

Returns void

insertNew

Parameters

Returns PdfPage

Parameters

Returns PdfPage

move

Parameters

Returns void

rebind

Parameters

Returns void

remove

Parameters

Returns boolean

removeAt

Parameters

Returns void

setAt

Parameters

Returns void

swap

Parameters

Returns void

Settings

On This Page