PdfLayerCollection API in JavaScript PDF API control

The class provides methods and properties to handle the collection of PdfLayer.

// Load an existing PDF document
let document: PdfDocument = new PdfDocument(data);
// Access the collection of layers in the document
let layers: PdfLayerCollection = document.layers;
// Save the document
document.save('output.pdf');
// Destroy the document
document.destroy();

Properties

count number

Gets the layer count.

Methods

add

Create a new PdfLayer with name add it to the end of the collection.

Returns PdfLayer

add

Create a new PdfLayer with name and Boolean flag to set the visibility of layer add it to the end of the collection.

Returns PdfLayer

at

Gets the PdfLayer at the specified index.

Returns PdfLayer

clear

Remove all the layers.

Returns void

contains

Boolean indicating whether the specified layer exists or not.

Returns boolean

contains

Boolean indicating whether the specified layer name exists or not.

Returns boolean

indexOf

Index of the specified layer.

Returns number

move

Move the PdfLayer into the collection at specified index.

Returns void

remove

Remove the PdfLayer with layer instance from the collection.

Returns void

remove

Remove the PdfLayer with layer instance from the collection.

Returns void

remove

Remove the PdfLayer at the layer name from the collection.

Returns void

remove

Remove the PdfLayer at the layer name from the collection.

Returns void

removeAt

Remove the PdfLayer at the specified index from the collection.

Returns void

removeAt

Remove the PdfLayer at the specified index from the collection.

Returns void