Namespace: Annotations

PSPDFKit.Annotations

Annotation API (with all available annotation types). All classes are based on Immutable.Record.

Annotation

Base annotation type from which all annotations inherit.
CommentMarkerAnnotation

Root annotation used for comments.
EllipseAnnotation

Display a ellipse on a page.
HighlightAnnotation

Highlight markup annotation.
ImageAnnotation

Display an image annotation, which represent an images in a PDF file.
InkAnnotation

Display free hand drawings on a page.
LineAnnotation

Display a straight line on a page.
LinkAnnotation

Triggers an action when clicked.
MarkupAnnotation

Base annotation type for all markup annotations.
MediaAnnotation

Display a media file in a document.
NoteAnnotation

A text note that will be rendered inside the bounding box.
PolygonAnnotation

Display a polygon on a page.
PolylineAnnotation

Display a polyline on a page.
RectangleAnnotation

Display a rectangle on a page.
RedactionAnnotation

Mark a region for redaction.
ShapeAnnotation

Base annotation type for all shape annotations.
SquiggleAnnotation

Squiggle markup annotation.
StampAnnotation

Display a stamp annotation, which represent a predefined or customized stamp in a PDF file.
StrikeOutAnnotation

Strike out markup annotation.
TextAnnotation

Free form text that will be rendered inside the bounding box.
UnderlineAnnotation

Underline markup annotation.
UnknownAnnotation

Unknown or unsupported annotation type.
WidgetAnnotation

Draw form elements, linked to PSPDFKit.FormFields.FormFields, on a page.

Annotation deserializer. Converts an annotation object to a PSPDFKit.Annotations.Annotation.

Name	Type	Description
`annotation`	object	Serialized Annotation

Annotation serializer. Converts one of the supported PSPDFKit.Annotations to InstantJSON compliant objects.

Type	Description
PSPDFKit.Annotations.Annotation