NativeElixirPdfUtilities.Validators.PageGeometryValidator (native_elixir_pdf_utilities v1.1.0)

View Source

Owns renderer page-size and margin grammar and canonical option admission.

Summary

Functions

Converts an applicable CSS page-margin value to a renderer margin value.

Converts an applicable CSS page-size descriptor to a renderer page-size value.

Resolves a nonnegative renderer margin into top, right, bottom, and left points.

Resolves a renderer page-size value to a positive {width, height} point tuple.

Types

margin_input()

@type margin_input() :: number() | String.t() | map()

margins()

@type margins() :: %{top: float(), right: float(), bottom: float(), left: float()}

orientation()

@type orientation() :: :portrait | :landscape

page_size_input()

@type page_size_input() ::
  page_size_name()
  | :"jis-b5"
  | :"jis-b4"
  | {page_size_name() | :"jis-b5" | :"jis-b4", orientation()}
  | {orientation(), page_size_name() | :"jis-b5" | :"jis-b4"}
  | {number(), number()}
  | String.t()

page_size_name()

@type page_size_name() ::
  :a5 | :a4 | :a3 | :b5 | :b4 | :jis_b5 | :jis_b4 | :letter | :legal | :ledger

Functions

css_margin_option(value)

@spec css_margin_option(String.t()) :: number() | String.t() | margins() | nil

Converts an applicable CSS page-margin value to a renderer margin value.

css_page_size_option(value)

@spec css_page_size_option(String.t()) :: page_size_input() | nil

Converts an applicable CSS page-size descriptor to a renderer page-size value.

normalize_margins(margin)

@spec normalize_margins(term()) :: {:ok, margins()} | {:error, :invalid_margin}

Resolves a nonnegative renderer margin into top, right, bottom, and left points.

normalize_page_size(page_size)

@spec normalize_page_size(term()) ::
  {:ok, {float(), float()}} | {:error, :invalid_page_size}

Resolves a renderer page-size value to a positive {width, height} point tuple.