elixir_latex v0.3.0

ElixirLatex.Job (elixir_latex v0.3.0)

Link to this section Summary

Types

assigns()
attachments()
body()
layout()
renderer()
t()
view()

Functions

assign(job, key, value)
put_attachment(job, key, value)
put_body(job, body)
put_data_url_attachment(job, key, data_url)
put_layout(job, layout)
put_view(job, view)
render(job, template, assigns \\ [])
set_renderer(job, renderer)

Link to this section Types

Link to this type

assigns()

@type assigns() :: %{optional(atom()) => any()}
Link to this type

attachments()

@type attachments() :: %{optional(atom() | binary()) => iodata()}
Link to this type

body()

@type body() :: iodata() | nil
Link to this type

layout()

@type layout() :: {atom(), binary() | atom()} | false
Link to this type

renderer()

@type renderer() :: binary() | :xelatex | :latex | :pdflatex
Link to this type

t()

@type t() :: %ElixirLatex.Job{
  assigns: assigns(),
  attachments: attachments(),
  body: body(),
  job_name: binary() | nil,
  layout: layout(),
  renderer: renderer(),
  view: view()
}
Link to this type

view()

@type view() :: atom() | false

Link to this section Functions

Link to this function

assign(job, key, value)

@spec assign(t(), atom(), term()) :: t()
Link to this function

put_attachment(job, key, value)

@spec put_attachment(t(), atom() | binary(), iodata()) :: t()
Link to this function

put_body(job, body)

@spec put_body(t(), body()) :: t()
Link to this function

put_data_url_attachment(job, key, data_url)

@spec put_data_url_attachment(t(), atom() | binary(), binary()) :: t() | :error
Link to this function

put_layout(job, layout)

@spec put_layout(t(), layout()) :: t()
Link to this function

put_view(job, view)

@spec put_view(t(), view()) :: t()
Link to this function

render(job, template, assigns \\ [])

Link to this function

set_renderer(job, renderer)

@spec set_renderer(t(), renderer()) :: t()