pdfplumber.core — net.clojars.savya/pdfplumber-clj 1.11.0

Public API for pdfplumber-clj: open PDFs and extract text, words, characters, geometric objects, and tables as plain Clojure data.

annots clj

(annots source)

(annots source opts)

Page annotations. See pdfplumber.objects/annots.

attachments clj

(attachments doc)

(attachments doc opts)

Document attachments and optional decoded data. See pdfplumber.attachments/attachments.

chars clj

(chars source)

(chars source opts)

Vector of character maps. Accepts a document handle or a cropped page view. See pdfplumber.text/chars.

crop clj

(crop source bbox)

(crop source bbox opts)

Derived page crop with partial-object clipping.

crop-page clj

(crop-page doc opts)

A cropped page view (restricts extraction to a bbox). See pdfplumber.page/crop-page.

curves clj

(curves source)

(curves source opts)

Painted curve objects. See pdfplumber.objects/curves.

dedupe-chars clj

(dedupe-chars source)

(dedupe-chars source opts)

Extract and deduplicate chars. See pdfplumber.text/dedupe-chars.

edges clj

(edges source)

(edges source opts)

Normalized page edges. See pdfplumber.objects/edges.

export-fdf clj

(export-fdf doc dest)

Export AcroForm data to a path, File, or OutputStream and return the destination.

extract-table clj

(extract-table source)

(extract-table source opts)

Extract a single table. Accepts a document handle or a cropped page view. See pdfplumber.table/extract-table.

extract-tables clj

(extract-tables source)

(extract-tables source opts)

Extract tables as a vector. Accepts a document handle or a cropped page view. See pdfplumber.table/extract-tables.

extract-text clj

(extract-text source)

(extract-text source opts)

Advanced text extraction. See pdfplumber.text/extract-text.

extract-text-lines clj

(extract-text-lines source)

(extract-text-lines source opts)

Positional text lines. See pdfplumber.text/extract-text-lines.

extract-text-simple clj

(extract-text-simple source)

(extract-text-simple source opts)

Fast doctop/char-gap text extraction. See pdfplumber.text/extract-text-simple.

extract-words clj

(extract-words source)

(extract-words source opts)

Advanced word extraction. See pdfplumber.text/extract-words.

field-values clj

(field-values doc)

Map of terminal field names to values. See pdfplumber.form/field-values.

filter clj

filter-page clj

(filter-page source pred)

(filter-page source pred opts)

Derived view filtered by an object predicate.

find-table clj

(find-table source)

(find-table source opts)

Find the first rich Table map. See pdfplumber.table/find-table.

find-tables clj

(find-tables source)

(find-tables source opts)

Find rich Table maps. See pdfplumber.table/find-tables.

flatten clj

(flatten doc)

Flatten AcroForm fields into page content and return the document handle.

form-fields clj

(form-fields doc)

Vector of terminal AcroForm fields. See pdfplumber.form/form-fields.

horizontal-edges clj

(horizontal-edges source)

(horizontal-edges source opts)

Horizontal page edges. See pdfplumber.objects/horizontal-edges.

hyperlinks clj

(hyperlinks source)

(hyperlinks source opts)

URI link annotations. See pdfplumber.objects/hyperlinks.

images clj

(images source)

(images source opts)

Vector of drawn image objects. Accepts a document handle or a cropped page view. See pdfplumber.objects/images.

import-fdf clj

(import-fdf doc source)

Import FDF data from bytes, an InputStream, or a path and return the document handle.

lines clj

(lines source)

(lines source opts)

Painted line objects. See pdfplumber.objects/lines.

metadata clj

(metadata doc)

Document metadata map. See pdfplumber.document/metadata.

objects clj

(objects source)

(objects source opts)

Vector of page object maps (lines, rects, curves, images). Accepts a document handle or a cropped page view. See pdfplumber.objects/objects.

objects-by-type clj

(objects-by-type source)

(objects-by-type source opts)

Object maps grouped by type. See pdfplumber.objects/objects-by-type.

open-pdf clj

(open-pdf source)

(open-pdf source opts)

Open a PDF, returning a document handle. See pdfplumber.document/open-pdf. Pass {:password string} as an optional second argument for encrypted PDFs. The caller must close it (or use with-pdf).

outline clj

(outline doc)

Nested document outline. See pdfplumber.outline/outline.

outside-bbox clj

(outside-bbox source bbox)

(outside-bbox source bbox opts)

Derived view containing only objects outside a bbox.

page clj

(page doc n)

Page map for 1-based page number n. See pdfplumber.document/page.

page-image? clj

(page-image? x)

True when x is a PageImage. See pdfplumber.image/page-image?.

page-reducible clj

(page-reducible source extractor)

(page-reducible source extractor opts)

Reducible page stream from an extractor function. See pdfplumber.reducible/page-reducible.

page-structure-tree clj

(page-structure-tree doc n)

Logical structure associated with 1-based page n. See pdfplumber.structure/page-structure-tree.

page-view? clj

(page-view? x)

True when x is a cropped page view. See pdfplumber.page/page-view?.

pages clj

(pages doc)

Vector of page maps. See pdfplumber.document/pages.

permissions clj

(permissions doc)

Encryption and access-permission flags. See pdfplumber.permissions/permissions.

rects clj

(rects source)

(rects source opts)

Painted rectangle objects. See pdfplumber.objects/rects.

reducible-annots clj

(reducible-annots source)

(reducible-annots source opts)

Page-at-a-time reducible annotation stream. See pdfplumber.reducible/reducible-annots.

reducible-chars clj

(reducible-chars source)

(reducible-chars source opts)

Single-pass reducible character stream. See pdfplumber.reducible/reducible-chars.

reducible-curves clj

(reducible-curves source)

(reducible-curves source opts)

Page-at-a-time reducible painted-curve stream. See pdfplumber.reducible/reducible-curves.

reducible-images clj

(reducible-images source)

(reducible-images source opts)

Page-at-a-time reducible drawn-image stream. See pdfplumber.reducible/reducible-images.

reducible-lines clj

(reducible-lines source)

(reducible-lines source opts)

Page-at-a-time reducible painted-line stream. See pdfplumber.reducible/reducible-lines.

reducible-objects clj

(reducible-objects source)

(reducible-objects source opts)

Page-at-a-time reducible object stream. See pdfplumber.reducible/reducible-objects.

reducible-rects clj

(reducible-rects source)

(reducible-rects source opts)

Page-at-a-time reducible painted-rectangle stream. See pdfplumber.reducible/reducible-rects.

reducible-words clj

(reducible-words source)

(reducible-words source opts)

Page-at-a-time reducible word stream. See pdfplumber.reducible/reducible-words.

refresh-appearances clj

(refresh-appearances doc)

Regenerate AcroForm field appearance streams and return the document handle.

search clj

(search source pattern)

(search source pattern opts)

Positional regex or literal search. See pdfplumber.text/search.

set-values clj

(set-values doc values)

Set AcroForm field values and return the document handle.

signatures clj

(signatures doc)

Digital-signature metadata and document-coverage signals. See pdfplumber.signature/signatures.

signed? clj

(signed? doc)

True when the document contains a signature dictionary. See pdfplumber.signature/signed?.

structure-tree clj

(structure-tree doc)

Tagged-PDF logical structure as nested element maps, or [] when the PDF is untagged. See pdfplumber.structure/structure-tree.

table->maps clj

(table->maps table-data)

(table->maps table-data opts)

Convert an extracted table or raw rows to header-keyed maps. See pdfplumber.table/table->maps.

text clj

(text source)

(text source opts)

Reconstructed text string. Accepts a document handle or a cropped page view. See pdfplumber.text/text.

text-map clj

(text-map source)

(text-map source opts)

Text and its source-char mapping. See pdfplumber.text/text-map.

to-image clj

(to-image source)

(to-image source opts)

Render a page or cropped page view as a PageImage for visual debugging. Accepts a document handle or a cropped page view. Thread the result through the overlay/save verbs in pdfplumber.image (draw-rect, draw-line, outline-words, debug-tablefinder, save, ...). See pdfplumber.image/to-image.

vertical-edges clj

(vertical-edges source)

(vertical-edges source opts)

Vertical page edges. See pdfplumber.objects/vertical-edges.

with-pdf clj macro

(with-pdf [binding source & [opts]] & body)

Open source, bind the document handle to binding, evaluate body, and always close the document on exit (including on exception).

(with-pdf [doc "statement.pdf"]
  (text doc {:page 1}))

(with-pdf [doc "statement.pdf" {:password "hunter2"}]
  (text doc {:page 1}))

within-bbox clj

(within-bbox source bbox)

(within-bbox source bbox opts)

Derived view containing only wholly enclosed objects.

word-map clj

(word-map source)

(word-map source opts)

Words and their contributing chars. See pdfplumber.text/word-map.

words clj

(words source)

(words source opts)

Vector of word maps. Accepts a document handle or a cropped page view. See pdfplumber.text/words.