Skip to content

Added support to only flatten some fields #1758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added support to only flatten some fields #1758

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34db58f
Added support to only flatten some fields
betabites Sep 6, 2025
77fb557
Added support to only flatten some fields
betabites Sep 6, 2025
fdf276b
Merge remote-tracking branch 'origin/master'
betabites Sep 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/api/form/PDFForm.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ import { assertIs, Cache, assertOrUndefined } from 'src/utils';

export interface FlattenOptions {
updateFieldAppearances: boolean;
fields?: PDFField[];
}

/**
Expand Down Expand Up @@ -514,7 +515,7 @@ export default class PDFForm {
}

/**
* Flatten all fields in this [[PDFForm]].
* Flatten fields in this [[PDFForm]].
*
* Flattening a form field will take the current appearance for each of that
* field's widgets and make them part of their page's content stream. All form
Expand All @@ -528,18 +529,26 @@ export default class PDFForm {
* document, fill its fields, flatten it, and then copy its pages into the
* recipient document - the filled fields will be copied over.
*
* For example:
* For example (flatten all fields):
* ```js
* const form = pdfDoc.getForm();
* form.flatten();
* ```
*
* To flatten specific fields, you can use this syntax:
* ```js
* const form = pdfDoc.getForm();
* form.flatten({ fields: [
* form.getField('Example')
* ] });
* ```
*/
flatten(options: FlattenOptions = { updateFieldAppearances: true }) {
flatten(options: FlattenOptions = { updateFieldAppearances: true }): void {
if (options.updateFieldAppearances) {
this.updateFieldAppearances();
}

const fields = this.getFields();
const fields = options.fields ?? this.getFields();

for (let i = 0, lenFields = fields.length; i < lenFields; i++) {
const field = fields[i];
Expand Down