> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/web/get-started/samples/custom-annotations.md).
# Custom annotations
Use JavaScript to create custom annotations in PDF viewer. Create custom annotations from scratch or update one of our 26 pre-built annotations.
Create custom PDF, Word, Excel, or PowerPoint annotations with this JavaScript sample (no servers or other external dependencies required). Annotations can be customized in several different ways – you can change appearances and behaviors, selection box and control handles. Change one of our pre-built annotations or create your own custom annotations that integrate directly into your workflow. A common example of a custom annotation would be creating a 'complete' annotation stamp that triggers a back-end workflow to mark a task item as complete. This sample works on all browsers (including IE11) and mobile devices without using plug-ins. To see an example visit our [custom annotation demo](https://showcase.apryse.com/custom-annotations/). Learn more about our [Web SDK](/web/get-started/guides.md).
{% tabs %}
{% tab title="JavaScript" %}
{% code lineNumbers="true" %}
```js
// eslint-disable-next-line no-undef
const WebViewerConstructor = isWebComponent() ? WebViewer.WebComponent : WebViewer;
(function(exports) {
const TRIANGLE_TOOL_NAME = 'AnnotationCreateTriangle';
WebViewerConstructor(
{
path: '../../../lib',
initialDoc: 'https://pdftron.s3.amazonaws.com/downloads/pl/demo-annotated.pdf',
},
document.getElementById('viewer')
).then(instance => {
samplesSetup(instance);
const { registerTool, setHeaderItems, setToolMode, unregisterTool, iframeWindow } = instance.UI;
const { documentViewer, annotationManager, Annotations, Tools, Math } = instance.Core;
// stamp.js
const customStampTool = window.createStampTool(instance);
const TriangleAnnotation = exports.TriangleAnnotationFactory.initialize(Annotations, Math);
const TriangleCreateTool = exports.TriangleCreateToolFactory.initialize(Tools, TriangleAnnotation);
// If we are using the WebComponent we need to change the window context
// eslint-disable-next-line no-undef
const context = isWebComponent() ? window : iframeWindow;
// register the annotation type so that it can be saved to XFDF files
documentViewer.getAnnotationManager().registerAnnotationType(TriangleAnnotation.prototype.elementName, TriangleAnnotation);
// function to check if an annotation is a triangle annotation. allows WebViewer UI to be able to style a selected custom triangle annotation
const isTriangleAnnot = annotation =>
annotation && annotation[exports.TriangleAnnotationFactory.ANNOT_TYPE] && annotation[exports.TriangleAnnotationFactory.ANNOT_TYPE] === exports.TriangleAnnotationFactory.TRIANGLE_ANNOT_ID;
const addTriangleTool = () => {
registerTool(
{
toolName: TRIANGLE_TOOL_NAME,
toolObject: new TriangleCreateTool(documentViewer),
buttonImage:
'',
buttonName: 'triangleToolButton',
tooltip: 'Triangle',
},
TriangleAnnotation,
annotation => isTriangleAnnot(annotation)
);
const triangleButton = {
type: 'toolButton',
toolName: TRIANGLE_TOOL_NAME,
};
setHeaderItems(header => {
header
.getHeader('toolbarGroup-Annotate')
.get('highlightToolGroupButton')
.insertBefore(triangleButton);
});
setToolMode(TRIANGLE_TOOL_NAME);
};
const addCustomStampTool = () => {
// Register tool
registerTool({
toolName: 'CustomStampTool',
toolObject: customStampTool,
buttonImage: '../../../samples/annotation/custom-annotations/stamp.png',
buttonName: 'customStampToolButton',
tooltip: 'Approved Stamp Tool',
});
// Add tool button in header
setHeaderItems(header => {
header
.getHeader('toolbarGroup-Annotate')
.get('highlightToolGroupButton')
.insertBefore({
type: 'toolButton',
toolName: 'CustomStampTool',
});
});
setToolMode('CustomStampTool');
};
const removeCustomStampTool = () => {
unregisterTool('CustomStampTool');
setToolMode('AnnotationEdit');
};
const removeTriangleTool = () => {
unregisterTool(TRIANGLE_TOOL_NAME);
setToolMode('AnnotationEdit');
};
document.getElementById('custom-stamp').onchange = e => {
if (e.target.checked) {
addCustomStampTool();
} else {
removeCustomStampTool();
}
};
document.getElementById('custom-triangle-tool').onchange = e => {
if (e.target.checked) {
addTriangleTool();
} else {
removeTriangleTool();
}
};
context.document.body.ondragover = e => {
e.preventDefault();
return false;
};
let dropPoint = {};
context.document.body.ondrop = e => {
const scrollElement = documentViewer.getScrollViewElement();
const scrollLeft = scrollElement.scrollLeft || 0;
const scrollTop = scrollElement.scrollTop || 0;
dropPoint = { x: e.pageX + scrollLeft, y: e.pageY + scrollTop };
e.preventDefault();
return false;
};
const addStamp = (imgData, point, rect) => {
point = point || {};
rect = rect || {};
const { documentViewer } = instance.Core;
const doc = documentViewer.getDocument();
const displayMode = documentViewer.getDisplayModeManager().getDisplayMode();
const page = displayMode.getSelectedPages(point, point);
if (!!point.x && page.first == null) {
return; // don't add to an invalid page location
}
const pageNumber = page.first !== null ? page.first : documentViewer.getCurrentPage();
const pageInfo = doc.getPageInfo(pageNumber);
const pagePoint = displayMode.windowToPage(point, pageNumber);
const zoom = documentViewer.getZoomLevel();
const stampAnnot = new Annotations.StampAnnotation();
stampAnnot.PageNumber = pageNumber;
const rotation = documentViewer.getCompleteRotation(pageNumber) * 90;
stampAnnot.Rotation = rotation;
if (rotation === 270 || rotation === 90) {
stampAnnot.Width = rect.height / zoom;
stampAnnot.Height = rect.width / zoom;
} else {
stampAnnot.Width = rect.width / zoom;
stampAnnot.Height = rect.height / zoom;
}
stampAnnot.X = (pagePoint.x || pageInfo.width / 2) - stampAnnot.Width / 2;
stampAnnot.Y = (pagePoint.y || pageInfo.height / 2) - stampAnnot.Height / 2;
stampAnnot.setImageData(imgData);
stampAnnot.Author = annotationManager.getCurrentUser();
annotationManager.deselectAllAnnotations();
annotationManager.addAnnotation(stampAnnot);
annotationManager.redrawAnnotation(stampAnnot);
annotationManager.selectAnnotation(stampAnnot);
};
// create a stamp image copy for drag and drop
const sampleImg = document.getElementById('sample-image');
const div = document.createElement('div');
const img = document.createElement('img');
img.id = 'sample-image-copy';
div.appendChild(img);
div.style.position = 'absolute';
div.style.top = '-500px';
div.style.left = '-500px';
document.body.appendChild(div);
const el = sampleImg;
img.src = el.src;
const height = el.height;
const width = (height / img.height) * img.width;
img.style.width = `${width}px`;
img.style.height = `${height}px`;
const c = document.createElement('canvas');
const ctx = c.getContext('2d');
c.width = width;
c.height = height;
ctx.drawImage(img, 0, 0, width, height);
img.src = c.toDataURL();
sampleImg.ondragstart = e => {
e.target.style.opacity = 0.5;
const copy = e.target.cloneNode(true);
copy.id = 'stamp-image-drag-copy';
const el = document.getElementById('sample-image-copy');
copy.src = el.src;
copy.style.width = el.width;
copy.style.height = el.height;
copy.style.padding = 0;
copy.style.position = 'absolute';
copy.style.top = '-1000px';
copy.style.left = '-1000px';
document.body.appendChild(copy);
e.dataTransfer.setDragImage(copy, copy.width * 0.5, copy.height * 0.5);
e.dataTransfer.setData('text', '');
};
sampleImg.ondragend = e => {
const el = document.getElementById('stamp-image-drag-copy');
addStamp(e.target.src, dropPoint, el.getBoundingClientRect());
e.target.style.opacity = 1;
document.body.removeChild(document.getElementById('stamp-image-drag-copy'));
e.preventDefault();
};
sampleImg.onclick = e => {
addStamp(e.target.src, {}, document.getElementById('sample-image-copy'));
};
document.getElementById('file-open').onchange = e => {
const fileReader = new FileReader();
fileReader.onload = () => {
const result = fileReader.result;
const uploadImg = new Image();
uploadImg.onload = () => {
const imgWidth = 250;
addStamp(result, {}, { width: imgWidth, height: (uploadImg.height / uploadImg.width) * imgWidth });
};
uploadImg.src = result;
};
if (e.target.files && e.target.files.length > 0) {
fileReader.readAsDataURL(e.target.files[0]);
}
};
});
})(window);
```
{% endcode %}
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.apryse.com/web/get-started/samples/custom-annotations.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.