Skip to main content

Module annotations

Module annotations 

Source
Expand description

Basic PDF annotations support according to ISO 32000-1 Chapter 12.5

This module provides basic annotation types including text annotations, link annotations, and markup annotations.

Structs§

Annotation
Base annotation structure
AnnotationFlags
Annotation flags according to ISO 32000-1 Section 12.5.3
AnnotationManager
Annotation manager
BorderStyle
Border style for annotations
CircleAnnotation
Circle annotation
FileAttachmentAnnotation
File attachment annotation
FreeTextAnnotation
Free text annotation
HighlightAnnotation
Highlight annotation
InkAnnotation
Ink annotation (freehand drawing)
LineAnnotation
Line annotation
LinkAnnotation
Link annotation
MarkupAnnotation
Markup annotation
PolygonAnnotation
Polygon annotation - displays a closed polygon on the page
PolylineAnnotation
Polyline annotation - displays an open polyline on the page
PopupAnnotation
Popup annotation - displays text in a pop-up window
PopupFlags
Flags for popup annotation behavior
QuadPoints
Quad points defining the region to be marked up
SquareAnnotation
Square annotation
StampAnnotation
Stamp annotation
TextAnnotation
Text annotation (sticky note)

Enums§

AnnotationType
Annotation types according to ISO 32000-1 Table 169
BorderStyleType
Border style type
FileAttachmentIcon
File attachment icon types
HighlightMode
Highlight mode for links
Icon
Icon types for text annotations
LineEndingStyle
Line ending styles
LinkAction
Link action types
LinkDestination
Link destination types (deprecated - use structure::Destination instead)
MarkupType
Markup annotation types
StampName
Standard stamp names

Functions§

create_markup_popup
Create a popup for a markup annotation
create_open_popup
Create an initially open popup
create_rectangle_polygon
Helper function to create a rectangle annotation from four points
create_regular_polygon
Helper function to create a regular polygon
create_text_popup
Create a popup for a text annotation
create_triangle
Helper function to create a triangle annotation