excel-clj.file — org.clojars.mjdowney/excel-clj 2.0.0

Write Clojure grids of [[cell]] as Excel worksheets, convert Excel worksheets to PDFs, and read Excel worksheets.

A cell can be either a plain value (a string, java.util.Date, etc.) or such a value wrapped in a map which also includes style and dimension data.

Check out the (example) function at the bottom of this namespace for more.

append! clj

(append! workbook from-path to-path)

(append! workbook
         from-path
         to-path
         {:keys [streaming? auto-size-cols?] :or {streaming? true} :as ops})

append-stream! clj

(append-stream! workbook from-stream stream)

(append-stream!
  workbook
  from-stream
  stream
  {:keys [streaming? auto-size-cols?] :or {streaming? true} :as ops})

convert-pdf! clj

(convert-pdf! from-document pdf-path)

Convert the from-document, either a File or a path to any office document, to pdf format and write the pdf to the given pdf-path.

Requires OpenOffice. See https://github.com/sbraconnier/jodconverter.

Returns a File pointing at the PDF.

default-ops clj

(default-ops workbook)

Decide if sheet columns should be autosized by default based on how many rows there are.

This check is careful to preserve the laziness of grids as much as possible.

example clj

(example)

Write & open a sheet composed of a simple grid.

example-plus clj

(example-plus)

Write & open a sheet composed of a more involved grid.

force-extension clj

(force-extension path ext)

open clj

(open file-path)

Open the given file path with the default program.

quick-open! clj

(quick-open! workbook)

quick-open-pdf! clj

(quick-open-pdf! workbook)

temp clj

(temp ext)

Return a (string) path to a temp file with the given extension.

write! clj

(write! workbook path)

(write! workbook
        path
        {:keys [streaming? auto-size-cols?] :or {streaming? true} :as ops})

write* clj

(write* workbook poi-writer {:keys [streaming? auto-size-cols?] :as ops})

For best performance, use {:streaming true, :auto-size-cols? false}.

write-pdf! clj

(write-pdf! workbook path)

write-rows! clj

(write-rows! sh rows-seq)

Write the rows via the poi/SheetWriter sh, returning the max row width.

write-stream! clj

(write-stream! workbook stream)

(write-stream!
  workbook
  stream
  {:keys [streaming? auto-size-cols?] :or {streaming? true} :as ops})