A Library for easily generating PDFs from Clojure
clj-pdf is available as a Maven artifact from Clojars:
Leiningen
[clj-pdf "0.7.7"]Maven
<dependency>
<groupId>clj-pdf</groupId>
<artifactId>clj-pdf</artifactId>
<version>0.7.7</version>
</dependency>write-doc will produce a PDF given a vector which defines the document and write it to out which can be either a string, in which case it's treated as a file name, or an output stream.
stream-doc takes input and output streams, then sequentially reads and appends the forms from the input stream to the output stream.
NOTE: using the :pages option will cause the complete document to reside in memory as it will need to be post processed.
All fields in the metadata section are optional:
{:title "Test doc"
:left-margin 10
:right-margin 10
:top-margin 20
:bottom-margin 25
:subject "Some subject"
:size "a4"
:orientation "landscape"
:author "John Doe"
:creator "Jane Doe"
:font {:size 11} ;specifies default font that will be used by top level elements
:doc-header ["inspired by" "William Shakespeare"]
:header "Page header text appears on each page"
:letterhead ;Sequence of any elements. If set, the first page shows letterhead instead of header
:footer "Page footer text appears on each page (includes page number)"
:pages true ;specifies if total pages should be printed in the footer of each page
}available page sizes:
"a0"
"a1"
"a2"
"a3"
"a4"
"a5"
"a6"
"a7"
"a8"
"a9"
"a10"
"arch-a"
"arch-b"
"arch-c"
"arch-d"
"arch-e"
"b0"
"b1"
"b2"
"b3"
"b4"
"b5"
"b6"
"b7"
"b8"
"b9"
"b10"
"crown-octavo"
"crown-quarto"
"demy-octavo"
"demy-quarto"
"executive"
"flsa"
"flse"
"halfletter"
"id-1"
"id-2"
"id-3"
"large-crown-octavo"
"large-crown-quarto"
"ledger"
"legal"
"letter"
"note"
"penguin-large-paperback"
"penguin-small-paperback"
"postcard"
"royal-octavo"
"royal-quarto"
"small-paperback"
"tabloid"defaults to A4 page size if none provided
orientation defaults to portrait, unless "landscape" is specified
A font is defined by a map consisting of the following parameters, all parameters are optional
- :family has following options: "courier", "helvetica", "times-roman", "symbol", "zapfdingbats" defaults to "helvetica"
- :size is a number default is 11
- :style has following options: "bold", "italic", "bold-italic", "normal", "strikethru", "underline" defaults to "normal"
- :color is a vector of [r g b] defaults to black
example font:
{:style "bold"
:size 18
:family "helvetica"
:color [0 234 123]}Each document section is represented by a vector starting with a keyword identifying the section followed by an optional map of metadata and the contents of the section.
tag :anchor
optional metadata:
- :style font
- :leading number
content:
iText idiosynchorsies:
- when both font style and leading number are specified the content must be a string
- when leading number is specified content can be a chunk or a string
- when only font style is specified content must be a string
- if no font style or leading is specified then content can be a chunk, a phrase, or a string
[:anchor {:style {:size 15} :leading 20} "some anchor"]
[:anchor [:phrase {:style "bold"} "some anchor phrase"]]
[:anchor "plain anchor"]tag :chapter
optional metadata:
- none
content:
- string
- paragraph
[:chapter "First Chapter"]
[:chapter [:paragraph "Second Chapter"]]tag :chunk
optional metadata:
- :style font
- :sub boolean sets chunk to subscript
- :super boolean sets chunk to superscript
[:chunk {:style "bold"} "small chunk of text"]
[:chunk {:super true} "5"]
[:chunk {:sub true} "2"]tag :heading
optional metadata:
- :style specifies the font for the heading
- :align specifies alignement of heading possible valuse "left|center|right"
[:heading "Lorem Ipsum"]
[:heading {:style {:size 15}} "Lorem Ipsum"]
[:heading {:style {:size 10 :color [100 40 150]} :align "right"}"Foo"]tag :image
image data can be one of java.net.URL, java.awt.Image, byte array, base64 string, or a filename string, images larger than the page margins will automatically be scaled to fit.
optional metadata:
- :xscale number - percentage relative to page size
- :yscale num - percentage relative to page size
- :width num - set width for image: overrides scaling
- :height num - set height for image: overrides scaling
- :align "left|center|right"
- :annotation ["title" "text"]
- :pad-left number
- :pad-right number
- :base64 boolean - if set the image is expected to be a Base64 string
[:image
{:xscale 0.5
:yscale 0.8
:align "center"
:annotation ["FOO" "BAR"]
:pad-left 100
:pad-right 50}
(javax.imageio.ImageIO/read "mandelbrot.jpg")]tag :line
creates a horizontal line
tag :list
optional metadata:
- :numbered boolean
- :lettered boolean
- :roman boolean
- :greek boolean
- :dingbats boolean
- :dingbats-char-num boolean
- :dingbatsnumber boolean
- :dingbatsnumber-type boolean
content:
- strings, phrases, or chunks
[:list {:roman true} [:chunk {:style "bold"} "a bold item"] "another item" "yet another item"]tag :paragraph
optional metadata:
- :indent number
- :keep-together boolean
- :leading number
- :align "left|center|right"
content:
- one or more elements (string, chunk, phrase, paragraph)
[:paragraph "a fine paragraph"]
[:paragraph {:keep-together true :indent 20} "a fine paragraph"]
[:paragraph {:indent 50} [:phrase {:style "bold" :size 18 :family "halvetica" :color [0 255 221]} "Hello Clojure!"]]
[:paragraph "256" [:chunk {:super true} "5"] " or 128" [:chunk {:sub true} "2"]]tag :phrase
optional metadata:
- :style font
- :leading number
content:
- strings and chunks
[:phrase "some text here"]
[:phrase {:style "bold" :size 18 :family "halvetica" :color [0 255 221]} "Hello Clojure!"]
[:phrase [:chunk {:style "italic"} "chunk one"] [:chunk {:size 20} "Big text"] "some other text"]tag :section
Chapter has to be the root element for any sections. Subsequently sections can only be parented under chapters and other sections, a section must contain a title followed by the content
optional metadata:
- :indent number
[:chapter "Chapter"
[:section "Section Title"
[:paragraph "Some content"]
[:paragraph "Some more content"]
[:section [:paragraph "Nested Section Title"]
[:paragraph "nested section content"]]]]
tag :spacer
creates a number of new lines equal to the number passed in (1 space is default)
[:spacer ] ;creates 1 new lines
[:spacer 5] ;creates 5 new linesA string will be automatically converted to a paragraph
"this text will be treated as a paragraph"
tag :subscript
optional metadata:
- :style font
creates a text chunk in subscript
[:subscript "some subscript text"]
[:subscript {:style "bold"} "some bold subscript text"]tag :superscript
optional metadata:
- :style font
creates a text chunk in subscript
[:superscript "some superscript text"]
[:superscript {:style "bold"} "some bold superscript text"]tag :table
metadata:
- :align table alignment on the page can be: "left" "right" "center"
- :color
[r g b](int values) - :header [{:color [r g b]} "column name" ...] if only a single column name is provided it will span all rows
- :spacing number
- :padding number
- :border boolean
- :border-width number
- :cell-border boolean
- :width number signifying the percentage of the page width that the table will take up
- :widths vector list of column widths in percentage
- :header is a vector of strings, which specify the headers for each column, can optionally start with metadata for setting header color
- :offset number
- :num-cols number
[:table {:header ["Row 1" "Row 2" "Row 3"] :width 50 :border false :cell-border false}
[[:cell {:colspan 2} "Foo"] "Bar"]
["foo1" "bar1" "baz1"]
["foo2" "bar2" "baz2"]]
[:table {:border-width 10 :header ["Row 1" "Row 2" "Row 3"]}
["foo" "bar" "baz"]
["foo1" "bar1" "baz1"]
["foo2" "bar2" "baz2"]]
[:table {:border false :header [{:color [100 100 100]} "Singe Header"]}
["foo" "bar" "baz"]
["foo1" "bar1" "baz1"]
["foo2" "bar2" "baz2"]]
[:table {:cell-border false :header [{:color [100 100 100]} "Row 1" "Row 2" "Row 3"] :cellSpacing 20 :header-color [100 100 100]}
["foo"
[:cell [:phrase {:style "italic" :size 18 :family "halvetica" :color [200 55 221]} "Hello Clojure!"]]
"baz"]
["foo1" [:cell {:color [100 10 200]} "bar1"] "baz1"]
["foo2" "bar2" "baz2"]]Cells can be optionally used inside tables to provide specific style for table elements
tag :cell
metadata:
- :color
[r g b](int values) - :colspan number
- :rowspan number
- :border boolean
- :set-border
[:top :bottom :left :right]list of enabled borders, pass empty vector to disable all borders - :border-width number
- :border-width-bottom number
- :border-width-left number
- :border-width-right number
- :border-width-top number
content:
Cell can contain any elements such as anchor, annotation, chunk, paragraph, or a phrase, which can each have their own style
note: Cells can contain other elements including tables
[:cell {:colspan 2} "Foo"]
[:cell {:colspan 3 :rowspan 2} "Foo"]
[:cell [:phrase {:style "italic" :size 18 :family "halvetica" :color [200 55 221]} "Hello Clojure!"]]
[:cell {:color [100 10 200]} "bar1"]
[:cell [:table ["Inner table Col1" "Inner table Col2" "Inner table Col3"]]]tag :chart
metadata:
- :type - bar-chart, line-chart, pie-chart
- :x-label - only used for line and bar charts
- :y-label - only used for line and bar charts
- :time-series - only used in line chart
- :time-format - can optionally be used with time-series to provide custom date formatting, defaults to "yyyy-MM-dd-HH:mm:ss"
- :horizontal - can be used with bar charts and line charts, not supported by time series
- :title
[:chart {:type "bar-chart" :title "Bar Chart" :x-label "Items" :y-label "Quality"} [2 "Foo"] [4 "Bar"] [10 "Baz"]]if :time-series is set to true then items on x axis must be dates, the default format is "yyyy-MM-dd-HH:mm:ss", for custom formatting options refer here
[:chart {:type "line-chart" :title "Line Chart" :x-label "checkpoints" :y-label "units"}
["Foo" [1 10] [2 13] [3 120] [4 455] [5 300] [6 600]]
["Bar" [1 13] [2 33] [3 320] [4 155] [5 200] [6 300]]]["chart",
{:x-label "time"
:y-label "progress"
:time-series true
:title "Time Chart"
:type "line-chart"}
["Incidents"
["2011-01-03-11:20:11" 200]
["2011-02-11-22:25:01" 400]
["2011-04-02-09:35:10" 350]
["2011-07-06-12:20:07" 600]]][:chart {:type "line-chart"
:time-series true
:time-format "MM/yy"
:title "Time Chart"
:x-label "time"
:y-label "progress"}
["Occurances" ["01/11" 200] ["02/12" 400] ["05/12" 350] ["11/13" 600]]][:chart {:type "pie-chart" :title "Big Pie"} ["One" 21] ["Two" 23] ["Three" 345]](write-doc
[{:title "Test doc"
:left-margin 10
:right-margin 50
:top-margin 20
:bottom-margin 25
:size "a4"
:orientation "landscape"
:subject "Some subject"
:author "John Doe"
:creator "Jane Doe"
:doc-header ["inspired by" "William Shakespeare"]
:header "page header"
:footer "page"
}
[:table {:header [{:color [100 100 100]} "FOO"] :cellSpacing 20}
["foo"
[:cell [:phrase {:style "italic" :size 18 :family "halvetica" :color [200 55 221]} "Hello Clojure!"]]
"baz"]
["foo1" [:cell {:color [100 10 200]} "bar1"] "baz1"]
["foo2" "bar2" [:cell [:table ["Inner table Col1" "Inner table Col2" "Inner table Col3"]]]]]
[:chapter "First Chapter"]
[:anchor {:style {:size 15} :leading 20} "some anchor"]
[:anchor [:phrase {:style "bold"} "some anchor phrase"]]
[:anchor "plain anchor"]
[:chunk {:style "bold"} "small chunk of text"]
[:phrase "some text here"]
[:phrase {:style "italic" :size 18 :family "halvetica" :color [0 255 221]} "Hello Clojure!"]
[:phrase [:chunk {:style "strikethru"} "chunk one"] [:chunk {:size 20} "Big text"] "some other text"]
[:paragraph "is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."]
[:paragraph {:indent 50} [:phrase {:style "bold" :size 18 :family "halvetica" :color [0 255 221]} "Hello Clojure!"]]
[:chapter [:paragraph "Second Chapter"]]
[:paragraph {:keep-together true :indent 20} "a fine paragraph"]
[:list {:roman true} [:chunk {:style "bold"} "a bold item"] "another item" "yet another item"]
[:chapter "Charts"]
[:chart {:type "bar-chart" :title "Bar Chart" :x-label "Items" :y-label "Quality"} [2 "Foo"] [4 "Bar"] [10 "Baz"]]
[:chart {:type "line-chart" :title "Line Chart" :x-label "checkpoints" :y-label "units"}
["Foo" [1 10] [2 13] [3 120] [4 455] [5 300] [6 600]]
["Bar" [1 13] [2 33] [3 320] [4 155] [5 200] [6 300]]]
[:chart {:type "pie-chart" :title "Big Pie"} ["One" 21] ["Two" 23] ["Three" 345]]
[:chart {:type "line-chart" :time-series true :title "Time Chart" :x-label "time" :y-label "progress"}
["Incidents"
["2011-01-03-11:20:11" 200]
["2011-01-03-11:25:11" 400]
["2011-01-03-11:35:11" 350]
["2011-01-03-12:20:11" 600]]]]
"test.pdf")- suggestions welcome :)
Distributed under LGPL, the same as iText version 2.1.7 and JFreeChart on which this library depends on.