> 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/annotation/annotation-types/highlightannotation.md). # Work with Highlight Annotations in WebViewer Elevate your text with Highlight Annotations, which mark text in vibrant colors akin to a highlighter pen. Explore key properties and functionalities for effective usage using web. The Apryse Web SDK 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. ![](https://3532544125-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX9YnTSKIHvV7m0A36LbO%2Fuploads%2Fgit-blob-a22fb4c74b07886c533851c1e95557b6043686d2%2F94fbca54c4259f59b9716be950119659eb78884d-413x142.png?alt=media) ## Instantiation {% tabs %} {% tab title="JavaScript (SDK v8.0+)" %} {% code lineNumbers="true" %} ```js WebViewer(...) .then(instance => { const { documentViewer, annotationManager, Annotations } = instance.Core; let debounce = null; // Automatically create highlight annotations on text selection documentViewer.addEventListener('textSelected', (quads, text, pageNumber) => { // Add some debouncing to prevent constant triggering during selection if (debounce) { clearTimeout(debounce); } debounce = setTimeout(() => { // Create annotation with object initializer const annot = new Annotations.TextHighlightAnnotation({ PageNumber: pageNumber, Quads: quads, StrokeColor: new Annotations.Color(255, 0, 0, 1), }); annotationManager.addAnnotation(annot); annotationManager.redrawAnnotation(annot); debounce = null; }, 1000); }); }); ``` {% endcode %} [DocumentViewer#textSelected](https://sdk.apryse.com/api/web/Core.DocumentViewer.html#event:textSelected) [TextHighlightAnnotation](https://sdk.apryse.com/api/web/Core.Annotations.TextHighlightAnnotation.html) [Color](https://sdk.apryse.com/api/web/Core.Annotations.Color.html) [AnnotationManager.addAnnotation](https://sdk.apryse.com/api/web/Core.AnnotationManager.html#addAnnotation) [AnnotationManager.redrawAnnotation](https://sdk.apryse.com/api/web/Core.AnnotationManager.html#redrawAnnotation) {% endtab %} {% tab title="JavaScript (SDK v6.0+)" %} {% code lineNumbers="true" %} ```js WebViewer(...) .then(instance => { const { docViewer, annotManager, Annotations } = instance; let debounce = null; // Automatically create highlight annotations on text selection docViewer.on('textSelected', (quads, text, pageNumber) => { // Add some debouncing to prevent constant triggering during selection if (debounce) { clearTimeout(debounce); } debounce = setTimeout(() => { // Create annotation const annot = new Annotations.TextHighlightAnnotation(); annot.PageNumber = pageNumber; annot.Quads = quads; annot.StrokeColor = new Annotations.Color(255, 0, 0, 1); annotManager.addAnnotation(annot); annotManager.redrawAnnotation(annot); debounce = null; }, 1000); }); }); ``` {% endcode %} [DocumentViewer#textSelected](https://sdk.apryse.com/api/web/Core.DocumentViewer.html#event:textSelected) [TextHighlightAnnotation](https://sdk.apryse.com/api/web/Core.Annotations.TextHighlightAnnotation.html) [Color](https://sdk.apryse.com/api/web/Core.Annotations.Color.html) [AnnotationManager.addAnnotation](https://sdk.apryse.com/api/web/Core.AnnotationManager.html#addAnnotation) [AnnotationManager.redrawAnnotation](https://sdk.apryse.com/api/web/Core.AnnotationManager.html#redrawAnnotation) {% endtab %} {% endtabs %} ## XFDF Element name: `highlight` {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```sh 70% of customers express interest in switching ``` {% endcode %} {% endtab %} {% endtabs %} ## 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](https://sdk.apryse.com/api/web/Core.Annotations.TextHighlightAnnotation.html). ### 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. {% tabs %} {% tab title="Shell" %} {% code lineNumbers="true" %} ```sh console.log(highlight.getQuads()); [ { // First quad of the first line "x1":58.24, "y1":98.97, "x2":265.13, "y2":98.97, "x3":265.13, "y3":87.47, "x4":58.25, "y4":87.47 }, ... // Second quad of the second line and so on ] ``` {% endcode %} {% endtab %} {% endtabs %} ### setQuads Using the `setQuads` API can be used to set the quads for the annotation as well. {% tabs %} {% tab title="JavaScript (SDK v8.0+)" %} {% code lineNumbers="true" %} ```js WebViewer(...) .then(instance => { const { annotationManager, Annotations } = instance.Core; annotationManager.addEventListener('annotationChanged', (annotations, action) => { if (annotations.length > 0 && action === 'add') { annotations.forEach(annot => { if (annot instanceof Annotations.TextHighlightAnnotation) { const quads = annot.getQuads(); quads.forEach(quad => { quad.x1 = Math.round(quad.x1 * 100) / 100; quad.y1 = Math.round(quad.y1 * 100) / 100; }); annot.setQuads(quads); } }); } }); }); ``` {% endcode %} [TextHighlightAnnotation.setQuads](https://sdk.apryse.com/api/web/Core.Annotations.TextHighlightAnnotation.html#setQuads) {% endtab %} {% tab title="JavaScript (SDK v6.0+)" %} {% code lineNumbers="true" %} ```js WebViewer(...) .then(instance => { const { annotManager, Annotations } = instance; annotManager.on('annotationChanged', (annotations, action) => { if (annotations.length > 0 && action === 'add') { annotations.forEach(annot => { if (annot instanceof Annotations.TextHighlightAnnotation) { const quads = annot.getQuads(); quads.forEach(quad => { quad.x1 = Math.round(quad.x1 * 100) / 100; quad.y1 = Math.round(quad.y1 * 100) / 100; }); annot.setQuads(quads); } }); } }); }); ``` {% endcode %} [TextHighlightAnnotation.setQuads](https://sdk.apryse.com/api/web/Core.Annotations.TextHighlightAnnotation.html#setQuads) {% endtab %} {% endtabs %} ## 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. --- # 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/annotation/annotation-types/highlightannotation.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.