PdfElixide.Document.Word (pdf_elixide v0.23.0)

Copy Markdown View Source

A single word extracted from a PDF page, with its zero-based page index, bounding box, and font metadata.

:rotation is the text-matrix rotation, in degrees, of the run the word was cut from — the same value as the :rotation of the PdfElixide.Document.Span it came from — 0.0 for upright text, and 0.0 when its characters disagree. On a page whose PdfElixide.Document.Page.rotation/1 is 90 or 270 it also says whether :bbox was mapped into the displayed frame; see Rotated pages and extracted geometry.

Float fields follow the "Unbounded values" rule in PdfElixide.Geometry.Rect.

Summary

Types

t()

@type t() :: %PdfElixide.Document.Word{
  bbox: PdfElixide.Geometry.Rect.t(),
  bold?: boolean(),
  font: String.t(),
  font_size: float(),
  italic?: boolean(),
  page: non_neg_integer(),
  rotation: float(),
  text: String.t()
}