Fill color. Value must be a CSS-style, six-digit hex color string (like
'#fa0404'
).
Determines the first "letter" of text to highlight. Value is a zero-based
index into the UTF-16 code units for the text of the page where the
highlight begins (specified by pageNumber
) determining the first grapheme
("letter") to include in the highlight. Value must be an integer greater
than or equal to 0
. If the value falls in the middle of a grapheme that
is made up of multiple UTF-16 code units, the highlight will automatically
expand to include the entire grapheme.
Unique identifier for the annotation.
One-indexed page number where the highlight annotation ends. Must be an
integer greater than or equal to pageNumber
.
Determines the last "letter" of text to highlight. Value is a zero-based
index into the UTF-16 code units for the text of the page where the
highlight ends (specified by lastPageNumber
) determining the last
grapheme ("letter") to include in the highlight. Value must be an integer
greater than or equal to 0
. If the value falls in the middle of a
grapheme that is made up of multiple UTF-16 code units, the highlight will
automatically expand to include the entire grapheme. Note that this end
index is inclusive: the grapheme indicated by the value will be included in
the highlight.
One-indexed page number where the annotation is placed. Must be an integer greater than zero.
Internal metadata about how to render a text highlight. When this property is present, you should not modify or remove it. Calls to PdfViewerControl.getAnnotations will include this property so that, if you persist the annotations and then reload them in a future version of our viewer, we can ensure the text highlight is positioned correctly.
Indicates this annotation is a TextHighlight.
Text highlight annotation state.