Liking cljdoc? Tell your friends :D

pdfplumber.core

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

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

charsclj

(chars source)
(chars source opts)

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

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

crop-pageclj

(crop-page doc opts)

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

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

extract-tableclj

(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 a single table. Accepts a document handle or a cropped page view. See
`pdfplumber.table/extract-table`.
sourceraw docstring

extract-tablesclj

(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 tables as a vector. Accepts a document handle or a cropped page view.
See `pdfplumber.table/extract-tables`.
sourceraw docstring

metadataclj

(metadata doc)

Document metadata map. See pdfplumber.document/metadata.

Document metadata map. See `pdfplumber.document/metadata`.
sourceraw docstring

objectsclj

(objects source)
(objects source opts)

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

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

open-pdfclj

(open-pdf source)

Open a PDF, returning a document handle. See pdfplumber.document/open-pdf. The caller must close it (or use with-pdf).

Open a PDF, returning a document handle. See `pdfplumber.document/open-pdf`.
The caller must close it (or use `with-pdf`).
sourceraw docstring

pageclj

(page doc n)

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

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

page-view?clj

(page-view? x)

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

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

pagesclj

(pages doc)

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

Vector of page maps. See `pdfplumber.document/pages`.
sourceraw docstring

textclj

(text source)
(text source opts)

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

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

with-pdfcljmacro

(with-pdf [binding source] & 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}))
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}))
sourceraw docstring

wordsclj

(words source)
(words source opts)

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

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

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close