Section:

Highlight Annotations

Highlight annotations are annotations that highlight text a certain color. Similar to using a highlighter pen on a printed page.

Text highlight annotations use the stroke color as the highlight color. Setting a fill color or stroke thickness will have no visual impact on the annotation by default.

Apryse Docs Image

Instantiation

1WebViewer(...)
2  .then(instance => {
3    const { documentViewer, annotationManager, Annotations } = instance.Core;
4
5    let debounce = null;
6
7    // Automatically create highlight annotations on text selection
8    documentViewer.addEventListener('textSelected', (quads, text, pageNumber) => {
9      // Add some debouncing to prevent constant triggering during selection
10      if (debounce) {
11        clearTimeout(debounce);
12      }
13      debounce = setTimeout(() => {
14        // Create annotation with object initializer
15        const annot = new Annotations.TextHighlightAnnotation({
16          PageNumber: pageNumber,
17          Quads: quads,
18          StrokeColor: new Annotations.Color(255, 0, 0, 1),
19        });
20
21        annotationManager.addAnnotation(annot);
22        annotationManager.redrawAnnotation(annot);
23
24        debounce = null;
25      }, 1000);
26    });
27  });

Related Links

XFDF

Element name: highlight

sh

1<highlight color="#FFC67B" creationdate="D:20191108141220-08'00'" flags="print" date="D:20191108141227-08'00'" name="8a203791-7b84-8ec6-be2f-dd69a256b7ef" page="1" coords="255.98,464.1,279.33,464.1,255.98,453.19,279.33,453.19,36,448.57,254.41,448.57,36,437.07,254.41,437.07" rect="36,437.066,279.335,464.097" subject="Highlight" title="Guest">
2    <contents>70%
3of customers express interest in switching</contents>
4    <apref blend-mode="multiply" y="464.097" x="36" gennum="0" objnum="78"/>
5</highlight>

Required properties

PageNumber

Gets or sets the page number of a document that the annotation appears on.

Quads

Gets of sets the text quads of the annotation. Since text annotations can span multiple lines of text, the lines of text are represented with an array of quads.

Notable properties

For the full list of properties, please visit the annotation's API docs.

Author

The author of the annotation.

Color

Gets or sets the annotation's stroke color.

Hidden

Gets or sets whether the annotation is hidden.

Invisible

Gets or sets whether the annotation is invisible, only if it is an unknown annotation type. Generally for hiding annotations you should use "Hidden".

IsClickableOutsideRect

Gets or sets whether any parts of the annotation drawn outside of the rect are clickable.

Listable

Gets or sets whether the annotation should be listed in annotation lists. If set to false, the annotation will also become unselectable.

Locked

Gets or sets whether the annotation is locked or not. If it's locked it can't be edited or deleted, but the note can be edited.

LockedContents

Gets or sets whether the annotation contents are locked or not. If the contents are locked then note can't be edited but the annotation can be edited or deleted.

NoDelete

Gets or sets if this annotation can be deleted.

NoMove

Gets or sets whether or not the annotation can be moved.

NoResize

Gets or sets if this annotation can be resized by the user.

NoView

Gets or sets whether the annotation is visible on the screen. Differs from Hidden in that it can still be printed if the print flag is set.

Opacity

Gets or sets the opacity of the annotation.

Printable

Gets or sets whether the annotation should be displayed when printing the page.

ReadOnly

Gets or sets whether the annotation is readonly or not. If it's readonly both the annotation itself and its note can't be edited or deleted.

StrokeColor

Gets or sets the color of the annotation's stroke.

ToggleNoView

Gets or sets whether the ToggleNoView flag is set on the annotation.

Useful methods

getQuads

Although it is possible to get the quads using the Quads property, there is also a getQuads method on the annotation to get its quads.

sh

1console.log(highlight.getQuads());
2[
3   { // First quad of the first line
4      "x1":58.24,
5      "y1":98.97,
6      "x2":265.13,
7      "y2":98.97,
8      "x3":265.13,
9      "y3":87.47,
10      "x4":58.25,
11      "y4":87.47
12   },
13   ... // Second quad of the second line and so on
14]

setQuads

Using the setQuads API can be used to set the quads for the annotation as well.

1WebViewer(...)
2  .then(instance => {
3    const { annotationManager, Annotations } = instance.Core;
4
5    annotationManager.addEventListener('annotationChanged', (annotations, action) => {
6      if (annotations.length > 0 && action === 'add') {
7        annotations.forEach(annot => {
8          if (annot instanceof Annotations.TextHighlightAnnotation) {
9            const quads = annot.getQuads();
10            quads.forEach(quad => {
11              quad.x1 = Math.round(quad.x1 * 100) / 100;
12              quad.y1 = Math.round(quad.y1 * 100) / 100;
13            });
14            annot.setQuads(quads);
15          }
16        });
17      }
18    });
19  });

Related Links

Alternative use cases

Highlight annotations could alternatively be used as placeholders. Users could use them to highlight text to indicate where a redaction is needed or replaced with another annotation, like a FreeTextAnnotation.

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales