Struct AnnotationBuilder 

pub struct AnnotationBuilder { /* private fields */ }

Builder for creating a PDF annotation and adding it to a document.

Example

use pdf_annot::builder::{AnnotationBuilder, AnnotSubtype, AnnotRect};

let mut doc = lopdf::Document::with_version("1.7");
// ... add pages ...
let annot_id = AnnotationBuilder::new(AnnotSubtype::Square, AnnotRect::new(100.0, 200.0, 300.0, 400.0))
    .color(1.0, 0.0, 0.0)
    .border_width(2.0)
    .contents("A red square")
    .build(&mut doc)
    .unwrap();

Implementations

impl AnnotationBuilder

pub fn new(subtype: AnnotSubtype, rect: AnnotRect) -> Self

Create a new annotation builder for the given subtype and rectangle.

pub fn free_text(rect: AnnotRect, text: &str, font_size: f64) -> Self

Create a FreeText annotation with the given text and font size.

pub fn sticky_note(rect: AnnotRect, icon: TextIcon) -> Self

Create a Text (sticky note) annotation.

pub fn stamp(rect: AnnotRect, name: StampName) -> Self

Create a Stamp annotation with a standard stamp name.

pub fn stamp_custom(rect: AnnotRect, name: &str) -> Self

Create a Stamp annotation with a custom name.

pub fn link_uri(rect: AnnotRect, uri: &str) -> Self

Create a Link annotation with a URI action.

pub fn link_dest(rect: AnnotRect, dest: &str) -> Self

Create a Link annotation with a named destination.

pub fn square(rect: AnnotRect) -> Self

Create a Square annotation.

pub fn circle(rect: AnnotRect) -> Self

Create a Circle annotation.

pub fn line(x1: f64, y1: f64, x2: f64, y2: f64) -> Self

Create a Line annotation between two points.

Automatically pads the bounding rect so it is never zero-area.

pub fn ink(rect: AnnotRect, strokes: Vec<Vec<f64>>) -> Self

Create an Ink annotation from stroke paths.

pub fn polygon(rect: AnnotRect, vertices: Vec<f64>) -> Self

Create a Polygon annotation from vertices.

pub fn polyline(rect: AnnotRect, vertices: Vec<f64>) -> Self

Create a PolyLine annotation from vertices.

pub fn highlight(rect: AnnotRect) -> Self

Create a Highlight markup annotation.

pub fn underline(rect: AnnotRect) -> Self

Create an Underline markup annotation.

pub fn strikeout(rect: AnnotRect) -> Self

Create a StrikeOut markup annotation.

pub fn squiggly(rect: AnnotRect) -> Self

Create a Squiggly markup annotation.

pub fn color(self, r: f64, g: f64, b: f64) -> Self

Set the annotation color (RGB, 0.0–1.0).

pub fn interior_color(self, r: f64, g: f64, b: f64) -> Self

Set the interior (fill) color for annotations that support it.

pub fn opacity(self, alpha: f64) -> Self

Set the opacity (CA/ca, 0.0–1.0).

pub fn border_width(self, width: f64) -> Self

Set the border/stroke width.

pub fn contents(self, text: impl Into<String>) -> Self

Set the /Contents text.

pub fn flags(self, flags: u32) -> Self

Set the annotation flags (raw u32).

pub fn alignment(self, q: i64) -> Self

Set text alignment for FreeText annotations (0=left, 1=center, 2=right).

pub fn line_endings(self, start: LineEnding, end: LineEnding) -> Self

Set line endings for Line annotations.

pub fn dash(self, pattern: Vec<f64>) -> Self

Set a dash pattern for stroked annotations.

pub fn quad_points(self, points: Vec<f64>) -> Self

Set QuadPoints for text markup annotations.

Each quadrilateral is defined by 8 values in page coordinates: [x1,y1, x2,y2, x3,y3, x4,y4] where the points define the corners of the marked text region. Multiple quads can be concatenated for multi-line selections.

pub fn quad_points_from_rect(self, rect: &AnnotRect) -> Self

Set QuadPoints from a simple rectangle (single quad).

pub fn appearance( self, f: impl FnOnce(&mut AppearanceStreamBuilder) + 'static, ) -> Self

Provide a custom appearance builder closure.

pub fn build(self, doc: &mut Document) -> Result<ObjectId, AnnotBuildError>

Build the annotation, add it to the document, and return the annotation object ID.

This creates the annotation dictionary, generates the appearance stream, and adds both as objects to the document. The annotation is NOT automatically added to any page’s /Annots array — use add_to_page for that.