@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
33 lines (32 loc) • 1.28 kB
TypeScript
/**
* watermark appearance parameter for {@link PDFServicesJobParams}.
*/
export declare class WatermarkAppearance {
private readonly _appearOnForeground?;
private readonly _opacity?;
/**
* Constructs a new `WatermarkAppearance` instance.
*
* @param params The parameters for constructing an instance of `WatermarkAppearance`.
* @param [params.appearOnForeground] Placement of watermark on the page.
* Watermark will be on foreground when it is true or background when it is false. Default is true.
* @param [params.opacity] Percentage value specifying watermark opacity.
* Specified as an Integer value from 0 to 100. default is 100.
*/
constructor(params: {
appearOnForeground?: boolean;
opacity?: number;
});
/**
* Returns a boolean value specifying whether watermark will be on foreground or background.
*
* @returns `true` if watermark will be on foreground, `false` if watermark will be on background
*/
get appearOnForeground(): boolean | undefined;
/**
* Returns an Integer value from 0 to 100 specifying watermark opacity
*
* @returns an Integer value from 0 to 100 specifying watermark opacity.
*/
get opacity(): number | undefined;
}