@adobe/pdfservices-node-sdk/lib/pdfjobs/params/autotagpdf/AutotagPDFParams.d.ts

The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.

import { PDFServicesJobParams } from "../PDFServicesJobParams";
/**
 * Parameters for creating a tagged PDF using {@link AutotagPDFJob}.
 */
export declare class AutotagPDFParams implements PDFServicesJobParams {
    private readonly _generateReport?;
    private readonly _shiftHeadings?;
    /**
     * Constructs a new `AutotagPDFParams` instance.
     *
     * @param params - The parameters for constructing an instance of `AutotagPDFParams`.
     * @param [params.generateReport] - Whether to generate an additional tagging report which contains the
     * information about the tags that the tagged output PDF document contains. The default value is `false`.
     * @param [params.shiftHeadings] - Whether to shift headings in the output PDF document.
     * The default value is `false`.
     */
    constructor(params: {
        generateReport?: boolean;
        shiftHeadings?: boolean;
    });
    /**
     * Returns a boolean value specifying whether an additional tagging report needs to be generated.
     *
     * @returns `true` if tagging report will be generated, `false` otherwise
     */
    get generateReport(): boolean | undefined;
    /**
     * Returns a boolean value specifying whether headings need to be shifted in the tagged PDF.
     *
     * @returns `true` if headings will be shifted in the tagged PDF, `false` otherwise
     */
    get shiftHeadings(): boolean | undefined;
}