Add a font to the list of available fonts.

Currently only Type 1 AFM/PFB fonts are supported.

fonts_dir = Application.app_dir(:my_app) |> Path.join("priv", "fonts")

pdf
|> Pdf.add_font(Path.join(fonts_dir, "DejavuSans.afm")
|> Pdf.add_font(Path.join(fonts_dir, "DejavuSans-Bold.afm")

The font can then be set with set_font/3.

You have to add_font/2 all variants you want to use, bold, italic, ...

Add an images (PNG, or JPEG only) at the given coordinates.

Add an images (PNG, or JPEG only) at the given coordinates.

You can specify a :width and :height in the options, the image will then be scaled.

Add a new page to the Pdf with the current page size.

The new page will inherit the font from the current page, if set.

Add a new page to the Pdf with the given page size.

The new page will inherit the font from the current page, if set.

Adds an autoprint action to the Pdf.

This is can be useful for generating a PDF that will automatically open the print dialog in a browser

Builds a PDF document taking care of cleaning up resources on completion.

Pdf.build([size: :a3], fn pdf ->
  pdf
  |> Pdf.set_font("Helvetica", 12)
  |> Pdf.text_at({100, 100}, "Open")
  |> Pdf.write_to("test.pdf")
end)

is equivalent to

{:ok, pdf} = Pdf.new(size: :a3)
pdf
|> Pdf.set_font("Helvetica", 12)
|> Pdf.text_at({100, 100}, "Open")
|> Pdf.write_to("test.pdf")
|> Pdf.cleanup()

Stop the Pdf process releasing all document memory.

@spec cm(number()) :: integer()

Convert the given value from cm to Pdf points

Create an image from binary data. Only PNG and JPEG images are supported. The image can be drawn with draw_image/3.

@spec cursor(pid()) :: number()

Gets the current cursor position, that is the vertical position.

Draw an image at the given coordinates. The image should be previously created with create_image/2.

The image will be drawn with its bottom left corner at the given coordinates.

Options:

• :width (optional) the width to draw the image at
• :height (optional) the height to draw the image at

If only width or height is provided, the image will be scaled relative to the supplied dimension. If neither is provided, the image will be drawn at its original size.

The cursor will be set to the y coordinate of the image

Export the Pdf to a binary representation.

This is can be used in eg Phoenix to send a PDF to the browser.

  report =
    pdf
    |> ...
    |> Pdf.export()

 conn
  |> put_resp_content_type("application/pdf")
  |> put_resp_header(
    "content-disposition",
    "attachment; filename=\"document.pdf\""
  )
  |> send_resp(200, report)

@spec fill(pid()) :: pid()

Fill the current drawing with the previously set color.

@spec inches(number()) :: integer()

Convert the given value from inches to Pdf points

@spec line(pid(), coords(), coords()) :: pid()

Draw a line between 2 points.

@spec line_append(pid(), coords()) :: pid()

Draw a line from the last position to the given coordinates.

  pdf
  |> Pdf.move_to({100, 100})
  |> Pdf.line_append({200, 200})

@spec link(pid(), coords(), dimension(), binary()) :: pid()

Add a clickable link annotation to the current page.

The coordinates {x, y} are the lower-left corner of the link rectangle. The dimensions {w, h} are the width and height of the rectangle.

@spec link_to_page(pid(), coords(), dimension(), integer()) :: pid()

Add a clickable link annotation to a specific page number in the document.

The coordinates {x, y} are the lower-left corner of the link rectangle. The dimensions {w, h} are the width and height of the rectangle.

If the specified page number does not exist when rendering, the link is silently dropped.

@spec mm(number()) :: integer()

Convert the given value from mm to Pdf points

Move the cursor amount points down.

@spec move_to(pid(), coords()) :: pid()

Move the cursor to the given coordinates.

@spec new(any()) :: :ignore | {:error, any()} | {:ok, pid()}

Create a new Pdf process

The following options can be given:

There is no standard font selected when creating a new PDF, so set one with set_font/3 before adding text.

Returns the current page number.

@spec picas(number()) :: number()

Convert the given value from picas to Pdf points

@spec pixels_to_points(pixels :: number(), dpi :: number()) :: integer()

Convert the given value from pixels to Pdf points

The unit of measurement in a Pdf are points, where 1 point = 1/72 inch. This means that a standard A4 page, 8.27 inch, translates to 595 points.

@spec rectangle(pid(), coords(), dimension()) :: pid()

Draw a rectangle from coordinates x,y (lower left corner) for a given width and height.

@spec remove_page(pid()) :: pid()

Remove the current page from the Pdf.

@spec render_table(pid(), coords(), dimension(), table()) ::
  {pid(), :complete | continuation()}

Render a table in the document at the given coordinates.

Sets the author in the PDF information section.

Sets the creator in the PDF information section.

@spec set_cursor(pid(), number()) :: pid()

Set the cursor position.

@spec set_fill_color(pid(), color_name() | rgb() | cmyk()) :: pid()

Set the color to use when filling.

This takes either a Pdf.Color.color/1 atom, an RGB tuple or a CMYK tuple.

@spec set_font(pid(), binary(), integer() | list()) :: pid()

Sets the font that will be used for all text from here on. You can either specify the font size, or a list of options:

Sets the font size.

The font has to have been previously set!

@spec set_info(pid(), info_list()) :: pid()

Set multiple keys in the PDF information section.

Valid keys

• :author
• :created
• :creator
• :keywords
• :modified
• :producer
• :subject
• :title

Sets the keywords in the PDF information section.

@spec set_line_cap(pid(), cap_style()) :: pid()

The line endings to draw, see cap_style/0.

@spec set_line_join(pid(), join_style()) :: pid()

The join style to use where lines meet, see join_style/0.

@spec set_line_width(pid(), number()) :: pid()

The width to use when drawing lines.

Sets the producer in the PDF information section.

@spec set_stroke_color(pid(), color_name() | rgb() | cmyk()) :: pid()

Set the color to use when drawing lines.

This takes either a Pdf.Color.color/1 atom, an RGB tuple or a CMYK tuple.

Sets the subject in the PDF information section.

Leading is a typography term that describes the distance between each line of text. The name comes from a time when typesetting was done by hand and pieces of lead were used to separate the lines.

Today, leading is often used synonymously with "line height" or "line spacing."

Sets the title in the PDF information section.

Returns a {width, height} for the current page.

@spec stroke(pid()) :: pid()

Perform all the previous graphic commands.

Add a table in the document at the given coordinates.

See Tables for more information on how to use tables.

Add a table in the document at the given coordinates. Raises an exception if the table does not fit the dimensions.

See Tables for more information on how to use tables.

Writes the text at the given coordinates. The coordinates are the bottom left of the text baseline.

The text can be either a binary or a list of binaries or annotated binaries. All text will be drawn on the same line, no wrapping will occur, it may overrun the page.

When given a list, you can supply a mix of binaries and annotated binaries. An annotated binary is a tuple {binary, options}, with the options being:

When setting bold: true or italic: true, make sure that your current font supports these or an error will occur. If using an external font, you have to add_font/2 all variants you want to use.

Writes the text at the given coordinates. The coordinates are the bottom left of the text.

The text can be either a binary or a list of binaries or annotated binaries, see text_at/3. All text will be drawn on the same line, no wrapping will occur, it may overrun the page.

The :kerning option if set to true will apply to all rendered text. Kerning refers to the spacing between the characters of a font. Without kerning, each character takes up a block of space and the next character is printed after it. When kerning is applied to a font, the characters can vertically overlap. This does not mean that the characters actually touch, but instead it allows part of two characters to take up the same vertical space. Kerning is available in some fonts.

@spec text_lines(pid(), coords(), list(), keyword()) :: pid()

This function draws a number of text lines starting at the given coordinates. The list can overrun the page, no errors or wrapping will occur.

Kerning can be set, see text_at/4 for more information.

@spec text_wrap(pid(), coords(), dimension(), binary() | list()) ::
  {pid(), :complete | term()}

Writes the text wrapped within the confines of the given dimensions. The {x,y} is the top-left of corner of the box, for this reason it is not wise to try to match it up with text_at on the same line.

The y-coordinate can also be set to :cursor.

The text will break at whitespace, such as, space, soft-hyphen, hyphen, cr, lf, tab, ...

If the text is too large for the box, it may overrun its boundaries, but only horizontally.

This function will return a tuple {pid, :complete} if all text was rendered, or {pid, remaining} if not. It can subsequently be called with the remaining data, after eg starting a new page, until {pid, :complete}.

The text can be either a binary or a list of binaries or annotated binaries. The :kerning option if set will apply to all rendered text.

When given a list, you can supply a mix of binaries and annotated binaries. An annotated binary is a tuple {binary, options}, with the options being:

When choosing :bold or :italic, make sure that your current font supports these or an error will occur. If using an external font, you have to add_font/2 all variants you want to use.

@spec text_wrap(pid(), coords(), dimension(), binary() | list(), keyword()) ::
  {pid(), :complete | term()}

This function has the same options as text_wrap/4, but also supports additional options that will be applied to the complete text.

@spec text_wrap!(pid(), coords(), dimension(), binary() | list()) :: pid()

This function has the same options as text_wrap/4, but if the text is too large for the box, a RuntimeError will be raised.

@spec text_wrap!(pid(), coords(), dimension(), binary() | list(), keyword()) :: pid()

This function has the same options as text_wrap/5, but if the text is too large for the box, a RuntimeError will be raised.

Write the PDF to the given path