# `PdfElixide.Document.PageLabelRange`
[🔗](https://github.com/r8/pdf_elixide/blob/v0.16.0/lib/pdf_elixide/document/page_label_range.ex#L1)

One entry of a PDF's `/PageLabels` number tree — the numbering scheme in force
over a contiguous stretch of pages.

Obtain the list with `PdfElixide.Document.page_label_ranges/1`. A range starts
at `:start_page` and runs until the next range's `:start_page`, or to the end
of the document for the last one.

`PdfElixide.Document.page_labels/1` is the rendered form of the same data: one
label string per page, with a decimal fallback for pages no range covers.

## Fields

  * `:start_page` — the zero-based page index where this range begins.
  * `:style` — the numbering style, see `t:style/0`.
  * `:prefix` — a string prepended to every label in the range, or `nil` when
    the range declares no `/P`.
  * `:start_value` — the numeric value of the range's **first** page, which is
    not necessarily `1`. Later pages count up from it.

# `style`

```elixir
@type style() ::
  :decimal | :roman_upper | :roman_lower | :alpha_upper | :alpha_lower | :none
```

A range's numbering style.

`:none` means the label has no numeric part: it is `:prefix` alone, or the
empty string when the range has no prefix.

# `t`

```elixir
@type t() :: %PdfElixide.Document.PageLabelRange{
  prefix: String.t() | nil,
  start_page: non_neg_integer(),
  start_value: non_neg_integer(),
  style: style()
}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*