Class PdfAnnotationWriter

Manages page Annots arrays during AcroForm write operations.

Index

Constructors

constructor

Methods

addFieldsToAnnots getPageAnnotsArray updatePageAnnotations

Constructors

constructor

new PdfAnnotationWriter(): PdfAnnotationWriter
Returns PdfAnnotationWriter

Methods

`Static`addFieldsToAnnots

addFieldsToAnnots(
annotsArray: PdfArray<PdfObjectReference>,
fieldRefs: PdfObjectReference[],
): void
Parameters
- annotsArray: PdfArray<PdfObjectReference>
- fieldRefs: PdfObjectReference[]
Returns void
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-writer.ts:50

`Static`getPageAnnotsArray

getPageAnnotsArray(
    document: PdfDocument,
    pageDict: PdfDictionary,
): Promise<
    {
        annotsArray: PdfArray<PdfObjectReference>;
        generationNumber?: number;
        isIndirect: boolean;
        objectNumber?: number;
    },
>
Parameters
- document: PdfDocument
- pageDict: PdfDictionary
Returns Promise<
    {
        annotsArray: PdfArray<PdfObjectReference>;
        generationNumber?: number;
        isIndirect: boolean;
        objectNumber?: number;
    },
>
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-writer.ts:11

`Static`updatePageAnnotations

updatePageAnnotations(
    document: PdfDocument,
    fieldsByPage: Map<
        string,
        { fieldRefs: PdfObjectReference[]; pageRef: PdfObjectReference },
    >,
): Promise<void>
Parameters
- document: PdfDocument
- fieldsByPage: Map<string, { fieldRefs: PdfObjectReference[]; pageRef: PdfObjectReference }>
Returns Promise<void>
- Defined in packages/pdf-lite/src/annotations/pdf-annotation-writer.ts:62

Class PdfAnnotationWriter

Index

Constructors

Methods

Constructors

constructor

Returns PdfAnnotationWriter

Methods

`Static`addFieldsToAnnots

Parameters

Returns void

`Static`getPageAnnotsArray

Parameters

Returns Promise<
    {
        annotsArray: PdfArray<PdfObjectReference>;
        generationNumber?: number;
        isIndirect: boolean;
        objectNumber?: number;
    },
>

`Static`updatePageAnnotations

Parameters

Returns Promise<void>

Settings

On This Page

Class PdfAnnotationWriter

Index

Constructors

Methods

Constructors

constructor

Returns PdfAnnotationWriter

Methods

StaticaddFieldsToAnnots

Parameters

Returns void

StaticgetPageAnnotsArray

Parameters

Returns Promise< { annotsArray: PdfArray<PdfObjectReference>; generationNumber?: number; isIndirect: boolean; objectNumber?: number; },>

StaticupdatePageAnnotations

Parameters

Returns Promise<void>

Settings

On This Page

`Static`addFieldsToAnnots

`Static`getPageAnnotsArray

Returns Promise<
{
annotsArray: PdfArray<PdfObjectReference>;
generationNumber?: number;
isIndirect: boolean;
objectNumber?: number;
},
>

`Static`updatePageAnnotations