How to set value of "trn-custom-data" for creating highlight annotations?

Which product are you using?
PDF.js Express Plus

PDF.js Express Version

Detailed description of issue
I want to set value for “trn-custom-data” when creating highlight annotations.

Expected behaviour
I want to get this value of “trn-custom-data” later for performing some action.

Does your issue happen with every document, or just one?
Yes. Need for all document annotation.

Code snippet

documentViewer.addEventListener('documentLoaded', () => {
      const highlight = new Annotations.TextHighlightAnnotation();
      // Want to set value here
      highlight.trn-custom-data = "Some example text";

      highlight.PageNumber = 4;
      highlight.X = 405;
      highlight.Y = 165;
      highlight.Width = 275;
      highlight.Height = 25;
      highlight.StrokeColor = new Annotations.Color(255, 255, 0);
      // you might get the quads from text selection, a server calculation, etc
      highlight.Quads = [
        { x1: 644, y1: 178, x2: 682, y2: 178, x3: 682, y3: 168, x4: 644, y4: 168 },
        { x1: 408, y1: 190, x2: 458, y2: 190, x3: 458, y3: 180, x4: 408, y4: 180 }


Hello, I’m Ron, an automated tech support bot :robot:

While you wait for one of our customer support representatives to get back to you, please check out some of these documentation pages:


Hey there!

You can use the setCustomData and getCustomData APIs to do that.

highlight.setCustomData("key", "value")
highlight.getCustomData("key") // returns "value"


When I create TextHiglightAnnotation by programmatically then it make difference from the default pdfjs highlight tool.

Here is my code.

const highlight = new Annotations.TextHighlightAnnotation();
        highlight.Author = annot.Author;
        highlight.Hidden = false;
        highlight.Quads = annot.Quads;
        highlight.StrokeColor = new Annotations.Color(255, 176, 176, 1);
        highlight.PageNumber = annot.getPageNumber();
        highlight.Locked = false;
        highlight.setCustomData("trn-custom-data", "Test Data");
        highlight.Subject = 'Highlight';
        annotManager.addAnnotation(highlight, true);


Hi there,

That is not related to this ticket - please open a new issue.