module Prawn::Document::Annotations

Provides very low-level support for annotations. These extensions are mainly for use by prawn-format, so be sure to check that out if all you need is basic internal or external links.

Public Instance Methods

annotate(options) click to toggle source

Adds a new annotation (section 8.4 in PDF spec) to the current page. options must be a Hash describing the annotation.

# File lib/prawn/document/annotations.rb, line 22
def annotate(options)
  page.dictionary.data[:Annots] ||= []
  options = sanitize_annotation_hash(options)
  page.dictionary.data[:Annots] << ref!(options)
  return options
end
text_annotation(rect, contents, options={}) click to toggle source

A convenience method for creating Text annotations. rect must be an array of four numbers, describing the bounds of the annotation. contents should be a string, to be shown when the annotation is activated.

# File lib/prawn/document/annotations.rb, line 33
def text_annotation(rect, contents, options={})
  options = options.merge(:Subtype => :Text, :Rect => rect, :Contents => contents)
  annotate(options)
end