Section:

Add Watermark to PDF using JavaScript

Adding text or an image as a watermark on top of a document requires only a few lines of code using the setWatermark method of DocumentViewer. This method allows you to pass an options object to draw text on top of the document or pass a custom function which will be executed with a reference to the page canvas.

Draw text as watermark

To draw a watermark, use documentViewer.setWatermark and pass an options object as shown below.

1WebViewer({
2  initialDoc: 'https://url/to/my_file.docx',
3  // ...
4}, viewerElement)
5  .then(instance => {
6    const { documentViewer } = instance.Core;
7
8    documentViewer.setWatermark({
9      // Draw diagonal watermark in middle of the document
10      diagonal: {
11        fontSize: 25, // or even smaller size
12        fontFamily: 'sans-serif',
13        color: 'red',
14        opacity: 50, // from 0 to 100
15        text: 'Watermark'
16      },
17
18      // Draw header watermark
19      header: {
20        fontSize: 10,
21        fontFamily: 'sans-serif',
22        color: 'red',
23        opacity: 70,
24        left: 'left watermark',
25        center: 'center watermark',
26        right: ''
27      }
28    });
29  });

Related Links

Apryse Docs Image

Draw custom content as watermark

The setWatermark method also allows you to draw custom content on the page. To do this, pass a custom function to the API as a part of the options object.

For the following sample, we will use a Promise which will resolve with the watermark options object. If the document hasn't been loaded yet then DocumentViewer will wait to finish loading it until the watermark options are ready.

1WebViewer({
2  initialDoc: 'https://url/to/my_file.docx',
3  // ...
4}, viewerElement)
5  .then(instance => {
6    const { documentViewer } = instance.Core;
7    const path = '/samples/full-apis/TestFiles/butterfly.png'
8    // Promise resolves with options object
9    const promise = new Promise(resolve => {
10      const img = new Image();
11      const options = {
12        footer: {
13          fontSize: 15,
14          fontFamily: 'sans-serif',
15          color: 'red',
16          opacity: 70,
17          left: 'left watermark',
18          center: 'center watermark'
19        },
20        custom: (ctx, pageNumber, pageWidth, pageHeight) => {
21          // the pageNumber is also passed in so you could have
22          // a different watermark for each page
23          ctx.drawImage(
24            img,
25            pageWidth / 2 - img.width / 2,
26            pageHeight / 2 - img.height / 2
27          );
28        }
29      };
30      img.onload = () => { 
31        return resolve(options);
32      };
33      img.src = path;
34    });
35    documentViewer.setWatermark(promise);
36  });

Related Links

Apryse Docs Image

Draw watermark text in custom positions

The setWatermarkcustom argument can also be used to draw text in custom positions.

1WebViewer({
2  // ...
3}, viewerElement)
4  .then(instance => {
5    const { documentViewer } = instance.Core;
6    documentViewer.setWatermark({
7      custom: (ctx, pageNumber, pageWidth, pageHeight) => {
8        // ctx is an instance of CanvasRenderingContext2D
9        // https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D
10        // Hence being able to leverage those properties
11        ctx.fillStyle = '#ff0000';
12        ctx.font = '20pt Arial';
13        ctx.globalAlpha = 0.4;
14    
15        ctx.save();
16        ctx.translate(0, pageHeight / 2);
17        ctx.rotate(-Math.PI / 2);
18        ctx.fillText('left side watermark', 0, 0);
19        ctx.restore();
20    
21        ctx.save();
22        ctx.translate(pageWidth, pageHeight / 2);
23        ctx.rotate(Math.PI / 2);
24        ctx.fillText('right side watermark', 0, 0);
25        ctx.restore();
26      },
27    });
28  });

Related Links

Apryse Docs Image

Draw watermark without DocumentViewer

If you're constructing your own Document instance then it also provides a setWatermark method.

1const filePath = '/webviewer-demo.pdf';
2const watermarkOptions = {
3 header: {
4     fontSize: 15,
5     color: 'blue',
6     center: 'center watermark',
7 },
8 diagonal: {
9     fontSize: 30,
10     fontFamily: 'sans-serif',
11     color: 'red',
12     opacity: 100,
13     text: 'Watermark'
14 }
15};
16const doc = await Core.createDocument(filePath, { l: 'Insert commercial license key here after purchase'});
17// Set watermark options object
18doc.setWatermark(watermarkOptions);
19// Draw canvas
20doc.loadCanvasAsync({
21 pageIndex: 0,
22 getZoom: () =>  0.8,  // 80% zoom,
23 drawComplete: pageCanvas => {
24   // Append canvas to dom to see the result
25   document.body.appendChild(pageCanvas);
26 },
27});

Related Links

Draw watermark dynamically

If you want to add a watermark or modify the existing watermark after pages are rendered, then after calling setWatermark you will also need to call the refreshAll and the updateView methods of DocumentViewer.

1WebViewer(...)
2  .then(instance => {
3    const { documentViewer } = instance.Core;
4    const watermarkOptions = {...};
5    documentViewer.setWatermark(watermarkOptions);
6    documentViewer.refreshAll();
7    documentViewer.updateView();
8  })

Related Links

If you are going to use a Promise then you need to call those two methods after the Promise has resolved:

1WebViewer(...)
2  .then(instance => {
3    const { documentViewer } = instance.Core;
4    const promise = new Promise(resolve => {
5      // some asynchronous operations to generate the watermark options object
6      resolve(watermarkOptions);
7    });
8    documentViewer.setWatermark(promise);
9    documentViewer.getWatermark().then(() => {
10      documentViewer.refreshAll();
11      documentViewer.updateView();
12    })
13  })

Related Links

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales