genpdfi

https://docs.rs/genpdfi/latest/genpdfi/
Admin
genpdfi is a high-level PDF generator for Rust built on top of printpdf and rusttype that handles...
Tokens:50,387
Snippets:826
Trust Score:9.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize Color instances

Source: https://docs.rs/genpdfi/latest/genpdfi/style/enum.Color.html?search=

Examples of creating Color instances using the available variants.

```rust
let red = genpdfi::style::Color::Rgb(255, 0, 0);
let cyan = genpdfi::style::Color::Cmyk(255, 0, 0, 0);
let grey = genpdfi::style::Color::Greyscale(127);
```

--------------------------------

### OrderedList::with_start(start: usize)

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html

Creates a new OrderedList instance starting at a specific number.

```APIDOC
## OrderedList::with_start(start: usize)

### Description
Creates a new instance of an ordered list that begins numbering at the provided integer.

### Parameters
- **start** (usize) - Required - The starting number for the list.
```

--------------------------------

### Creating and Configuring an Image

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Image.html?search=

Example showing how to load an image from a path and apply alignment and scaling transformations.

```rust
use std::convert::TryFrom;
use genpdfi::elements;
let image = elements::Image::from_path("examples/images/test_image.jpg")
      .expect("Failed to load test image")
      .with_alignment(genpdfi::Alignment::Center) // Center the image on the page.
      .with_scale(genpdfi::Scale::new(0.5, 2.0)); // Squeeze and then stretch upwards.
```

--------------------------------

### FramedElement Usage Examples

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.FramedElement.html?search=

Examples showing how to create a framed element directly or using the Element trait extension.

```rust
use genpdfi::elements;
let p = elements::FramedElement::new(
    elements::Paragraph::new("text"),
);
```

```rust
use genpdfi::{elements, style, Element as _};
let p = elements::Paragraph::new("text").framed(style::LineStyle::new());
```

--------------------------------

### Creating StyledString Instances

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.StyledString.html

Examples of how to instantiate a new StyledString with different style effects or colors.

```rust
use genpdfi::style;
let ss1 = style::StyledString::new("bold".to_owned(), style::Effect::Bold, None);
let ss2 = style::StyledString::new("red".to_owned(), style::Color::Rgb(255, 0, 0), None);
```

--------------------------------

### OrderedList::with_start

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=std%3A%3Avec

Creates a new ordered list instance starting at a specified number.

```APIDOC
### pub fn with_start(start: usize) -> OrderedList

Creates a new ordered list with the given start number.
```

--------------------------------

### OrderedList::with_start

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=

Creates a new ordered list instance with a custom starting number.

```APIDOC
## pub fn with_start(start: usize) -> OrderedList

### Description
Creates a new ordered list with the given start number.

### Parameters
- **start** (usize) - The starting number for the list.
```

--------------------------------

### OrderedList::with_start

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new ordered list instance with a custom starting number.

```APIDOC
## pub fn with_start(start: usize) -> OrderedList

### Description
Creates a new ordered list with the given start number.
```

--------------------------------

### OrderedList::with_start

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new OrderedList instance starting at a specific number.

```APIDOC
## OrderedList::with_start

### Description
Creates a new instance of an OrderedList that begins numbering at the provided integer.

### Signature
`pub fn with_start(start: usize) -> OrderedList`

### Example
```rust
use genpdfi::elements;
let list = elements::OrderedList::with_start(5);
```
```

--------------------------------

### Creating and Populating an OrderedList

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=u32+-%3E+bool

Examples demonstrating how to initialize an OrderedList and add elements using setters or chained methods.

```rust
use genpdfi::elements;
let mut list = elements::OrderedList::new();
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));
```

```rust
use genpdfi::elements;
let mut list = elements::OrderedList::with_start(5);
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));
```

```rust
use genpdfi::elements;
let list = elements::OrderedList::new()
    .element(elements::Paragraph::new("first"))
    .element(elements::Paragraph::new("second"))
    .element(elements::Paragraph::new("third"));
```

--------------------------------

### Apply styles to elements

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.StyledElement.html

Examples showing how to apply styles using the constructor or the trait method.

```rust
use genpdfi::{elements, style};
let p = elements::StyledElement::new(
    elements::Paragraph::new("text"),
    style::Effect::Bold,
);
```

```rust
use genpdfi::{elements, style, Element as _};
let p = elements::Paragraph::new("text")
    .styled(style::Effect::Bold);
```

--------------------------------

### Create and configure TableLayout

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.TableLayout.html?search=

Examples demonstrating how to initialize a table and add rows using either setter methods or a chained builder pattern.

```rust
use genpdfi::elements;
let mut table = elements::TableLayout::new(vec![1, 1]);
table.set_cell_decorator(elements::FrameCellDecorator::new(true, true, false));
let mut row = table.row();
row.push_element(elements::Paragraph::new("Cell 1"));
row.push_element(elements::Paragraph::new("Cell 2"));
row.push().expect("Invalid table row");
```

```rust
use genpdfi::elements;
let table = elements::TableLayout::new(vec![1, 1])
    .row()
    .element(elements::Paragraph::new("Cell 1"))
    .element(elements::Paragraph::new("Cell 2"))
    .push()
    .expect("Invalid table row");
```

--------------------------------

### Create a new StyledCow

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.StyledCow.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Examples of initializing a StyledCow instance using different string types and style effects.

```rust
use genpdfi::style;
let ss1 = style::StyledCow::new("bold", style::Effect::Bold, None);
let ss2 = style::StyledCow::new("red".to_owned(), style::Color::Rgb(255, 0, 0), None);
```

--------------------------------

### Create and populate a LinearLayout

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.LinearLayout.html

Examples demonstrating how to initialize a vertical layout and add elements using either mutable push operations or a chained builder pattern.

```rust
use genpdfi::elements;
let mut layout = elements::LinearLayout::vertical();
layout.push(elements::Paragraph::new("Test1"));
layout.push(elements::Paragraph::new("Test2"));
```

```rust
use genpdfi::elements;
let layout = elements::LinearLayout::vertical()
    .element(elements::Paragraph::new("Test1"))
    .element(elements::Paragraph::new("Test2"));
```

--------------------------------

### Create OrderedList with custom start number

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=

Initialize an ordered list starting from a specific integer value.

```rust
use genpdfi::elements;
let mut list = elements::OrderedList::with_start(5);
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));
```

--------------------------------

### Construct and Configure Paragraph

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Paragraph.html?search=

Examples demonstrating how to build a paragraph using either mutable setters or a chained builder pattern.

```rust
use genpdfi::{elements, style};
let mut p = elements::Paragraph::default();
p.push("This is an ");
p.push_styled("important", style::Color::Rgb(255, 0, 0));
p.push(" message!");
p.set_alignment(genpdfi::Alignment::Center);
```

```rust
use genpdfi::{elements, style};
let p = elements::Paragraph::default()
    .string("This is an ")
    .styled_string("important", style::Color::Rgb(255, 0, 0))
    .string(" message!")
    .aligned(genpdfi::Alignment::Center);
```

--------------------------------

### PaddedElement Usage Examples

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.PaddedElement.html

Demonstrates how to create a padded element using the constructor or the trait method.

```rust
use genpdfi::elements;
let p = elements::PaddedElement::new(
    elements::Paragraph::new("text"),
    genpdfi::Margins::trbl(5, 2, 5, 10),
);
```

```rust
use genpdfi::{elements, Element as _};
let p = elements::Paragraph::new("text")
    .padded(genpdfi::Margins::trbl(5, 2, 5, 10));
```

--------------------------------

### OrderedList::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=

Creates a new ordered list instance starting at 1.

```APIDOC
## pub fn new() -> OrderedList

### Description
Creates a new ordered list starting at 1.
```

--------------------------------

### OrderedList::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=std%3A%3Avec

Creates a new ordered list instance starting at 1.

```APIDOC
### pub fn new() -> OrderedList

Creates a new ordered list starting at 1.
```

--------------------------------

### Example Usage of subset_font

Source: https://docs.rs/genpdfi/latest/genpdfi/subsetting/fn.subset_font.html?search=

Demonstrates how to read a font file, define the text to include, and generate a subset font.

```rust
use genpdfi::subsetting::subset_font;

let font_data = std::fs::read("font.ttf").unwrap();
let text = "Hello World ăâîșț";  // Romanian characters
let subset = subset_font(&font_data, text).unwrap();

// subset now contains a smaller font with only the used glyphs
assert!(subset.len() < font_data.len());
```

--------------------------------

### Populating TableLayoutRow

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.TableLayoutRow.html?search=

Examples demonstrating how to add elements to a table row using either explicit setters or a chained builder pattern.

```rust
use genpdfi::elements;
let mut table = elements::TableLayout::new(vec![1, 1]);
let mut row = table.row();
row.push_element(elements::Paragraph::new("Cell 1"));
row.push_element(elements::Paragraph::new("Cell 2"));
row.push().expect("Invalid table row");
```

```rust
use genpdfi::elements;
let table = elements::TableLayout::new(vec![1, 1])
    .row()
    .element(elements::Paragraph::new("Cell 1"))
    .element(elements::Paragraph::new("Cell 2"))
    .push()
    .expect("Invalid table row");
```

--------------------------------

### Create a custom bullet point

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.BulletPoint.html?search=

Example showing how to instantiate a BulletPoint with a custom bullet symbol using the with_bullet method.

```rust
use genpdfi::elements;
let layout = elements::LinearLayout::vertical()
    .element(elements::BulletPoint::new(elements::Paragraph::new("first"))
        .with_bullet("a)"))
    .element(elements::BulletPoint::new(elements::Paragraph::new("second"))
        .with_bullet("b)"));
```

--------------------------------

### Create and render a PDF document

Source: https://docs.rs/genpdfi/latest/genpdfi/struct.Document.html?search=

Initializes a document with a font family, adds a paragraph, and renders the output to a file.

```rust
// Load a font from the file system
let font_family = genpdfi::fonts::from_files("./fonts", "LiberationSans", None)
    .expect("Failed to load font family");
// Create a document and set the default font family
let mut doc = genpdfi::Document::new(font_family);
doc.push(genpdfi::elements::Paragraph::new("Document content"));
doc.render_to_file("output.pdf").expect("Failed to render document");
```

--------------------------------

### Text Formatting Properties

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.Style.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods to get and set text effects and font attributes.

```APIDOC
## Style::color(&self) -> Option<Color>
Returns the outline color for this style, if set.

## Style::is_bold(&self) -> bool
Returns whether the bold text effect is set.

## Style::set_bold(&mut self)
Sets the bold effect for this style.

## Style::bold(self) -> Style
Sets the bold effect for this style and returns it.

## Style::font_size(&self) -> u8
Returns the font size for this style in points, or 12 if no font size is set.

## Style::set_font_size(&mut self, font_size: u8)
Sets the font size in points for this style.

## Style::with_font_size(self, font_size: u8) -> Style
Sets the font size in points for this style and returns it.
```

--------------------------------

### Get font metrics

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.Font.html?search=u32+-%3E+bool

Methods to retrieve vertical metrics for a specific font size.

```rust
pub fn get_line_height(&self, font_size: u8) -> Mm
```

```rust
pub fn glyph_height(&self, font_size: u8) -> Mm
```

```rust
pub fn ascent(&self, font_size: u8) -> Mm
```

```rust
pub fn descent(&self, font_size: u8) -> Mm
```

```rust
pub fn metrics(&self, font_size: u8) -> Metrics
```

--------------------------------

### Create styled strings with genpdfi

Source: https://docs.rs/genpdfi/latest/genpdfi/style/index.html

Demonstrates initializing a Style object and applying it to StyledStr instances with specific formatting or colors.

```rust
use genpdfi::style;
let style = style::Style::new().bold();
let ss1 = style::StyledStr::new("bold", style, None);
let ss2 = style::StyledStr::new("red", style::Color::Rgb(255, 0, 0), None);
```

--------------------------------

### StyledCow::new

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.StyledCow.html

Creates a new StyledCow instance from a string, style, and optional link.

```APIDOC
## pub fn new(s: impl Into<Cow<'s, str>>, style: impl Into<Style>, link: Option<String>) -> StyledCow<'s>

### Description
Creates a new styled string from the given string and style.

### Parameters
- **s** (impl Into<Cow<'s, str>>) - The string content to be styled.
- **style** (impl Into<Style>) - The style annotation to apply.
- **link** (Option<String>) - An optional link to associate with the string.
```

--------------------------------

### Create and populate a table using setters

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.TableLayout.html

Demonstrates creating a table with specific column weights and adding rows using the setter-based API.

```rust
use genpdfi::elements;
let mut table = elements::TableLayout::new(vec![1, 1]);
table.set_cell_decorator(elements::FrameCellDecorator::new(true, true, false));
let mut row = table.row();
row.push_element(elements::Paragraph::new("Cell 1"));
row.push_element(elements::Paragraph::new("Cell 2"));
row.push().expect("Invalid table row");
```

--------------------------------

### UnorderedList::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.UnorderedList.html

Creates a new, empty UnorderedList instance.

```APIDOC
## UnorderedList::new()

### Description
Creates a new instance of an unordered list with default settings.

### Signature
`pub fn new() -> UnorderedList`
```

--------------------------------

### Initialize and use FontFallbackChain

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.FontFallbackChain.html?search=

Demonstrates creating a fallback chain and querying fonts for specific characters.

```rust
use genpdfi::fonts::{FontData, FontFallbackChain};

let primary = FontData::load("NotoSans.ttf", None).unwrap();
let cyrillic = FontData::load("NotoSansCyrillic.ttf", None).unwrap();
let emoji = FontData::load("NotoEmoji.ttf", None).unwrap();

let chain = FontFallbackChain::new(primary)
    .with_fallback(cyrillic)
    .with_fallback(emoji);

// Automatically uses the right font for each character
let font_for_a = chain.find_font_for_char('a');      // Uses primary (Noto Sans)
let font_for_я = chain.find_font_for_char('я');      // Uses cyrillic fallback
let font_for_emoji = chain.find_font_for_char('😀'); // Uses emoji fallback
```

--------------------------------

### StyledCow::new

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.StyledCow.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new styled string instance.

```APIDOC
## pub fn new(s: impl Into<Cow<'s, str>>, style: impl Into<Style>, link: Option<String>) -> StyledCow<'s>

### Description
Creates a new styled string from the given string and style.

### Parameters
- **s** (impl Into<Cow<'s, str>>) - The string content.
- **style** (impl Into<Style>) - The style annotation.
- **link** (Option<String>) - Optional link annotation.
```

--------------------------------

### GlyphIdMap::new

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.GlyphIdMap.html?search=

Creates a new, empty instance of GlyphIdMap.

```APIDOC
## pub fn new() -> Self

### Description
Creates a new empty glyph ID map.
```

--------------------------------

### LineStyle Configuration Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.LineStyle.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for setting and retrieving the thickness and color of a LineStyle object.

```APIDOC
## Configuration Methods

### set_thickness(&mut self, thickness: impl Into<Mm>)
Sets the line thickness. A value of 0.0 renders as 1px wide.

### with_thickness(self, thickness: impl Into<Mm>) -> Self
Sets the line thickness and returns the modified LineStyle.

### thickness(&self) -> Mm
Returns the current line thickness.

### set_color(&mut self, color: Color)
Sets the line color.

### with_color(self, color: Color) -> Self
Sets the line color and returns the modified LineStyle.

### color(&self) -> Color
Returns the current line color.
```

--------------------------------

### Create UnorderedList with setters

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.UnorderedList.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Initialize a new list and add elements using the push method.

```rust
use genpdfi::elements;
let mut list = elements::UnorderedList::new();
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));
```

--------------------------------

### Size::new

Source: https://docs.rs/genpdfi/latest/genpdfi/struct.Size.html

Creates a new Size instance with the specified width and height.

```APIDOC
## pub fn new(width: impl Into<Mm>, height: impl Into<Mm>) -> Size

### Description
Creates a new size from the given width and height.

### Parameters
- **width** (impl Into<Mm>) - Required - The width of the area.
- **height** (impl Into<Mm>) - Required - The height of the area.
```

--------------------------------

### Create OrderedList using method chaining

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=

Initialize and populate an ordered list using the fluent element method.

```rust
use genpdfi::elements;
let list = elements::OrderedList::new()
    .element(elements::Paragraph::new("first"))
    .element(elements::Paragraph::new("second"))
    .element(elements::Paragraph::new("third"));
```

--------------------------------

### Image Construction and Configuration

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Image.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for creating an Image instance from various sources and configuring its layout properties.

```APIDOC
## Image Construction

### from_path(path: impl AsRef<Path>) -> Result<Self, Error>
Creates a new image by reading from the given path.

### from_reader<R>(reader: R) -> Result<Self, Error> where R: BufRead + Read + Seek
Creates a new image from the given reader.

### from_dynamic_image(data: DynamicImage) -> Result<Self, Error>
Creates a new image from an already loaded image.

## Image Configuration

### with_position(self, position: impl Into<Position>) -> Self
Translates the image to a position and returns the instance.

### with_scale(self, scale: impl Into<Scale>) -> Self
Scales the image and returns the instance.

### with_alignment(self, alignment: impl Into<Alignment>) -> Self
Sets the alignment and returns the instance.

### with_clockwise_rotation(self, rotation: impl Into<Rotation>) -> Self
Sets the clockwise rotation and returns the instance.

### with_dpi(self, dpi: f32) -> Self
Sets the expected DPI and returns the instance.
```

--------------------------------

### Create Margins Instances

Source: https://docs.rs/genpdfi/latest/genpdfi/struct.Margins.html?search=

Methods to initialize Margins using specific side values, vertical/horizontal pairs, or a single uniform value.

```rust
pub fn trbl( top: impl Into<Mm>, right: impl Into<Mm>, bottom: impl Into<Mm>, left: impl Into<Mm>, ) -> Margins
```

```rust
pub fn vh(vertical: impl Into<Mm>, horizontal: impl Into<Mm>) -> Margins
```

```rust
pub fn all(all: impl Into<Mm>) -> Margins
```

--------------------------------

### Create OrderedList with setters

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=

Initialize an ordered list and add elements using the push method.

```rust
use genpdfi::elements;
let mut list = elements::OrderedList::new();
list.push(elements::Paragraph::new("first"));
list.push(elements::Paragraph::new("second"));
list.push(elements::Paragraph::new("third"));
```

--------------------------------

### Create a new Break instance

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Break.html?search=u32+-%3E+bool

Demonstrates how to instantiate a Break element to draw a specific number of empty lines.

```rust
// Draws 5 empty lines (calculating the line height using the current style)
let b = genpdfi::elements::Break::new(5.0);
```

--------------------------------

### OrderedList::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new, empty OrderedList instance.

```APIDOC
## OrderedList::new

### Description
Creates a new instance of an OrderedList with default settings.

### Signature
`pub fn new() -> OrderedList`

### Example
```rust
use genpdfi::elements;
let list = elements::OrderedList::new();
```
```

--------------------------------

### Renderer methods

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Renderer.html?search=std%3A%3Avec

Methods for initializing, configuring, and manipulating the PDF document.

```rust
pub fn new( size: impl Into<Size>, title: impl AsRef<str>, ) -> Result<Renderer, Error>
```

```rust
pub fn with_conformance(self, conformance: PdfConformance) -> Self
```

```rust
pub fn with_creation_date(self, date: OffsetDateTime) -> Self
```

```rust
pub fn with_modification_date(self, date: OffsetDateTime) -> Self
```

```rust
pub fn add_page(&mut self, size: impl Into<Size>)
```

```rust
pub fn page_count(&self) -> usize
```

```rust
pub fn get_page(&self, idx: usize) -> Option<&Page>
```

```rust
pub fn get_page_mut(&mut self, idx: usize) -> Option<&mut Page>
```

```rust
pub fn first_page(&self) -> &Page
```

```rust
pub fn first_page_mut(&mut self) -> &mut Page
```

```rust
pub fn last_page(&self) -> &Page
```

```rust
pub fn last_page_mut(&mut self) -> &mut Page
```

```rust
pub fn add_builtin_font( &self, builtin: BuiltinFont, ) -> Result<IndirectFontRef, Error>
```

```rust
pub fn add_embedded_font(&self, data: &[u8]) -> Result<IndirectFontRef, Error>
```

```rust
pub fn write(self, w: impl Write) -> Result<(), Error>
```

--------------------------------

### Implement From for T

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html

Returns the argument unchanged.

```rust
impl<T> From<T> for T
```

```rust
fn from(t: T) -> T
```

--------------------------------

### LineStyle::new

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.LineStyle.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of LineStyle with default values (0.1mm thickness, black color).

```APIDOC
## pub fn new() -> LineStyle

### Description
Creates a new line style with default values.

### Returns
- **LineStyle** - A new instance of LineStyle.
```

--------------------------------

### Scale::new

Source: https://docs.rs/genpdfi/latest/genpdfi/struct.Scale.html

Creates a new Scale instance with specified x and y scaling percentages.

```APIDOC
## pub fn new(x: impl Into<f32>, y: impl Into<f32>) -> Scale

### Description
Creates a new scale for the given x/y values. The values represent the percentage to scale on the respective axes.

### Parameters
- **x** (impl Into<f32>) - Required - The percentage to scale on the x-axis.
- **y** (impl Into<f32>) - Required - The percentage to scale on the y-axis.

### Returns
- **Scale** - A new Scale instance.
```

--------------------------------

### StyledStr::new

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.StyledStr.html

Creates a new styled string instance from a given string, style, and optional link.

```APIDOC
## pub fn new(s: &'s str, style: impl Into<Style>, link: Option<&'s str>) -> StyledStr<'s>

### Description
Creates a new styled string from the given string and style.

### Parameters
- **s** (&'s str) - The string content.
- **style** (impl Into<Style>) - The style annotation to apply.
- **link** (Option<&'s str>) - An optional link annotation.
```

--------------------------------

### StyledString::new

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.StyledString.html?search=

Creates a new StyledString instance with the provided text, style, and optional link.

```APIDOC
## pub fn new(s: impl Into<String>, style: impl Into<Style>, link: Option<String>) -> StyledString

### Description
Creates a new styled string from the given string and style.

### Parameters
- **s** (impl Into<String>) - The string content.
- **style** (impl Into<Style>) - The style annotation to apply.
- **link** (Option<String>) - An optional link associated with the string.
```

--------------------------------

### Create UnorderedList using chaining

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.UnorderedList.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Build a list fluently by chaining element calls.

```rust
use genpdfi::elements;
let list = elements::UnorderedList::new()
    .element(elements::Paragraph::new("first"))
    .element(elements::Paragraph::new("second"))
    .element(elements::Paragraph::new("third"));
```

--------------------------------

### pub fn from_files

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/fn.from_files.html?search=std%3A%3Avec

Loads a font family from a directory. It expects specific font files (Regular, Bold, Italic, BoldItalic) to exist at the provided path.

```APIDOC
## Function: genpdfi::fonts::from_files

### Description
Loads the font family at the given path with the given name. This method assumes that at the given path, the following files exist and are valid font files: `{name}-Regular.ttf`, `{name}-Bold.ttf`, `{name}-Italic.ttf`, and `{name}-BoldItalic.ttf`.

### Signature
`pub fn from_files(dir: impl AsRef<Path>, name: &str, builtin: Option<Builtin>) -> Result<FontFamily<FontData>, Error>`

### Parameters
- **dir** (impl AsRef<Path>) - The directory path containing the font files.
- **name** (str) - The base name of the font files.
- **builtin** (Option<Builtin>) - Optional built-in PDF font configuration. If set, built-in PDF fonts are used instead of embedding the fonts in the PDF file.

### Returns
- **Result<FontFamily<FontData>, Error>** - Returns a FontFamily object on success, or an Error if the files cannot be loaded or are invalid.
```

--------------------------------

### TableLayout::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.TableLayout.html

Creates a new table layout instance with specified column weights.

```APIDOC
## pub fn new(column_weights: Vec<usize>) -> TableLayout

### Description
Creates a new table layout with the given column weights. The column weights determine the relative width of the columns, and the number of weights defines the total number of columns.

### Parameters
- **column_weights** (Vec<usize>) - Required - A vector of integers representing the relative width of each column.
```

--------------------------------

### TableLayout::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.TableLayout.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new table layout instance with specified column weights.

```APIDOC
## pub fn new(column_weights: Vec<usize>) -> TableLayout

### Description
Creates a new table layout with the given column weights. The column weights determine the relative width of each column, and the length of the vector defines the total number of columns.

### Parameters
- **column_weights** (Vec<usize>) - Required - A vector of integers representing the relative width of each column.
```

--------------------------------

### TableLayout::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.TableLayout.html?search=u32+-%3E+bool

Creates a new table layout instance with specified column weights.

```APIDOC
## pub fn new(column_weights: Vec<usize>) -> TableLayout

### Description
Creates a new table layout with the given column weights. The column weights determine the relative width of each column, and the length of the vector defines the total number of columns.

### Parameters
- **column_weights** (Vec<usize>) - Required - A vector of weights determining the relative width of each column.
```

--------------------------------

### SimplePageDecorator Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/struct.SimplePageDecorator.html?search=u32+-%3E+bool

Methods available for initializing and configuring a SimplePageDecorator instance.

```APIDOC
## pub fn new() -> SimplePageDecorator

### Description
Creates a new page decorator that does not modify the page by default.

## pub fn set_margins(&mut self, margins: impl Into<Margins>)

### Description
Sets the margins for all pages of the document. If not called, the full page area is used.

## pub fn set_header<F, E>(&mut self, cb: F)

### Description
Sets a header generator for the document. The closure is called once per page with the page number (starting at 1), and the returned element is rendered at the top of the page.
```

--------------------------------

### StyledString::new

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.StyledString.html

Creates a new StyledString instance with the specified text, style, and optional link.

```APIDOC
## pub fn new(s: impl Into<String>, style: impl Into<Style>, link: Option<String>) -> StyledString

### Description
Creates a new styled string from the given string and style.

### Parameters
- **s** (impl Into<String>) - Required - The string content.
- **style** (impl Into<Style>) - Required - The style annotation.
- **link** (Option<String>) - Optional - The link annotation.
```

--------------------------------

### OrderedList::new()

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.OrderedList.html

Creates a new, empty OrderedList instance.

```APIDOC
## OrderedList::new()

### Description
Creates a new instance of an ordered list with default settings.

### Signature
`pub fn new() -> OrderedList`
```

--------------------------------

### Style Management Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/style/struct.Style.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for creating, merging, and combining style configurations.

```APIDOC
## Style::new()
Creates a new style without settings.

## Style::merge(&mut self, style: impl Into<Style>)
Merges the given style into this style.

## Style::and(self, style: impl Into<Style>) -> Style
Combines this style and the given style and returns the result.

## Style::combine(left: impl Into<Style>, right: impl Into<Style>) -> Style
Creates a new style by combining the given styles.
```

--------------------------------

### UnorderedList Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.UnorderedList.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Methods for initializing and adding elements to an UnorderedList.

```APIDOC
## pub fn new() -> UnorderedList
Creates a new unordered list with the default bullet point symbol.

## pub fn with_bullet(bullet: impl Into<String>) -> UnorderedList
Creates a new unordered list with the given bullet point symbol.

## pub fn push<E: Element + 'static>(&mut self, element: E)
Adds an element to this list.

## pub fn element<E: Element + 'static>(self, element: E) -> Self
Adds an element to this list and returns the list.
```

--------------------------------

### LinearLayout::push

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.LinearLayout.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Adds an element to the existing layout instance.

```APIDOC
## pub fn push<E: IntoBoxedElement>(&mut self, element: E)

### Description
Adds the given element to this layout.

### Parameters
- **element** (E) - The element to add to the layout.
```

--------------------------------

### Renderer::new

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Renderer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new PDF document renderer with one page of the given size and the given title.

```APIDOC
## pub fn new(size: impl Into<Size>, title: impl AsRef<str>) -> Result<Renderer, Error>

### Description
Creates a new PDF document renderer with one page of the given size and the given title.

### Parameters
- **size** (impl Into<Size>) - Required - The size of the initial page.
- **title** (impl AsRef<str>) - Required - The title of the PDF document.

### Returns
- **Result<Renderer, Error>** - A new Renderer instance or an error if initialization fails.
```

--------------------------------

### Renderer::new

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Renderer.html

Creates a new PDF document renderer with one page of the given size and the given title.

```APIDOC
## pub fn new(size: impl Into<Size>, title: impl AsRef<str>) -> Result<Renderer, Error>

### Description
Creates a new PDF document renderer with one page of the given size and the given title.
```

--------------------------------

### Font implementation methods

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.Font.html?search=std%3A%3Avec

Methods for retrieving font metrics and character-specific data.

```rust
pub fn is_builtin(&self) -> bool
```

```rust
pub fn get_line_height(&self, font_size: u8) -> Mm
```

```rust
pub fn glyph_height(&self, font_size: u8) -> Mm
```

```rust
pub fn ascent(&self, font_size: u8) -> Mm
```

```rust
pub fn descent(&self, font_size: u8) -> Mm
```

```rust
pub fn char_width(&self, font_cache: &FontCache, c: char, font_size: u8) -> Mm
```

```rust
pub fn char_left_side_bearing( &self, font_cache: &FontCache, c: char, font_size: u8, ) -> Mm
```

```rust
pub fn str_width(&self, font_cache: &FontCache, s: &str, font_size: u8) -> Mm
```

```rust
pub fn kerning<I>(&self, font_cache: &FontCache, iter: I) -> Vec<f32>
where I: IntoIterator<Item = char>,
```

```rust
pub fn glyph_ids<I>(&self, font_cache: &FontCache, iter: I) -> Vec<u16>
where I: IntoIterator<Item = char>,
```

```rust
pub fn metrics(&self, font_size: u8) -> Metrics
```

--------------------------------

### pub fn first_layer(&self) -> Layer<'_>

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Page.html?search=u32+-%3E+bool

Returns the first layer of the page.

```APIDOC
## pub fn first_layer(&self) -> Layer<'_>

### Description
Returns the first layer of this page.

### Returns
- **Layer<'_>** - The first layer instance.
```

--------------------------------

### LinearLayout::push

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.LinearLayout.html?search=

Adds the given element to this layout.

```APIDOC
## pub fn push<E: IntoBoxedElement>(&mut self, element: E)

### Description
Adds the given element to this layout.

### Parameters
- **element** (E: IntoBoxedElement) - The element to add to the layout.
```

--------------------------------

### render

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Image.html?search=u32+-%3E+bool

Renders the image element to the specified area using the provided context, style, and font cache.

```APIDOC
## fn render(&mut self, _context: &Context, area: Area<'_>, _style: Style) -> Result<RenderResult, Error>

### Description
Renders this element to the given area using the given style and font cache.

### Parameters
- **_context** (&Context) - The rendering context.
- **area** (Area<'_>) - The target area for rendering.
- **_style** (Style) - The style to apply during rendering.

### Returns
- **Result<RenderResult, Error>** - Returns a RenderResult on success, or an Error if rendering fails.
```

--------------------------------

### pub fn from_files

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/fn.from_files.html

Loads a font family from a directory based on a provided name. It expects four specific font files to exist at the path and optionally allows for the use of built-in PDF fonts.

```APIDOC
## Function: from_files

### Description
Loads the font family at the given path with the given name. This method assumes that at the given path, the following files exist and are valid font files: `{name}-Regular.ttf`, `{name}-Bold.ttf`, `{name}-Italic.ttf`, and `{name}-BoldItalic.ttf`.

### Signature
`pub fn from_files(dir: impl AsRef<Path>, name: &str, builtin: Option<Builtin>) -> Result<FontFamily<FontData>, Error>`

### Parameters
- **dir** (impl AsRef<Path>) - Required - The directory path where the font files are located.
- **name** (str) - Required - The base name used to identify the font files.
- **builtin** (Option<Builtin>) - Optional - If set, built-in PDF fonts are used instead of embedding the fonts in the PDF file.
```

--------------------------------

### Paragraph Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Paragraph.html?search=u32+-%3E+bool

Methods available for constructing and configuring a Paragraph instance.

```APIDOC
## Paragraph Methods

### new(text: impl Into<StyledString>) -> Paragraph
Creates a new paragraph with the given content.

### set_alignment(&mut self, alignment: Alignment)
Sets the alignment of this paragraph.

### aligned(self, alignment: Alignment) -> Self
Sets the alignment of this paragraph and returns the paragraph.

### push(&mut self, s: impl Into<StyledString>)
Adds a string to the end of this paragraph.

### string(self, s: impl Into<StyledString>) -> Self
Adds a string to the end of this paragraph and returns the paragraph.

### push_styled(&mut self, s: impl Into<String>, style: impl Into<Style>)
Adds a string with the given style to the end of this paragraph.

### push_link(&mut self, text: impl Into<String>, url: impl Into<String>, style: impl Into<Style>) -> &mut Self
Adds a string with the given style to the end of this paragraph and returns the paragraph.

### styled_string(self, s: impl Into<String>, style: impl Into<Style>) -> Self
Adds a string with the given style to the end of this paragraph and returns the paragraph.
```

--------------------------------

### Signature of from_files

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/fn.from_files.html

The function signature for loading a font family from a directory path.

```rust
pub fn from_files(
    dir: impl AsRef<Path>,
    name: &str,
    builtin: Option<Builtin>,
) -> Result<FontFamily<FontData>, Error>
```

--------------------------------

### Metrics::new

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.Metrics.html?search=u32+-%3E+bool

Creates a new instance of the Metrics struct with specified height values.

```APIDOC
## pub fn new(line_height: Mm, glyph_height: Mm, ascent: Mm, descent: Mm) -> Metrics

### Description
Creates a new metrics instance with the given heights.

### Parameters
- **line_height** (Mm) - The line height of the font.
- **glyph_height** (Mm) - The glyph height of the font.
- **ascent** (Mm) - The ascent of the font.
- **descent** (Mm) - The descent of the font.

### Returns
- **Metrics** - A new instance initialized with the provided values.
```

--------------------------------

### LinearLayout::push<E>

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.LinearLayout.html

Adds a new element to the existing layout.

```APIDOC
### pub fn push<E: IntoBoxedElement>(&mut self, element: E)

Adds the given element to this layout.
```

--------------------------------

### Position::new

Source: https://docs.rs/genpdfi/latest/genpdfi/struct.Position.html

Creates a new Position instance using coordinates measured in millimeters.

```APIDOC
## pub fn new(x: impl Into<Mm>, y: impl Into<Mm>) -> Position

### Description
Creates a new position from the given coordinates. The coordinates are measured from the top left corner of the reference area.

### Parameters
- **x** (impl Into<Mm>) - The x coordinate measured from the left border.
- **y** (impl Into<Mm>) - The y coordinate measured from the top border.

### Returns
- **Position** - A new instance of the Position struct.
```

--------------------------------

### TableLayout::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.TableLayout.html?search=

Creates a new table layout with the specified column weights.

```APIDOC
## pub fn new(column_weights: Vec<usize>) -> TableLayout

### Description
Creates a new table layout with the given column weights. The column weights determine the relative width of the columns, and the number of weights defines the number of columns.

### Parameters
- **column_weights** (Vec<usize>) - Required - A vector of weights determining the relative width of each column.
```

--------------------------------

### UnorderedList::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.UnorderedList.html?search=std%3A%3Avec

Creates a new instance of an UnorderedList with the default bullet point symbol.

```APIDOC
## pub fn new() -> UnorderedList

### Description
Creates a new unordered list with the default bullet point symbol.
```

--------------------------------

### FontData::load

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.FontData.html

Loads a font from a file path.

```APIDOC
## pub fn load(path: impl AsRef<Path>, builtin: Option<BuiltinFont>) -> Result<FontData, Error>

### Description
Loads the font at the given path. The path must point to a file readable by rusttype.
```

--------------------------------

### Text::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Text.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Creates a new instance of the Text element with the provided styled string.

```APIDOC
## pub fn new(text: impl Into<StyledString>) -> Text

### Description
Creates a new instance of the Text element with the given styled string. This element renders a single styled string on a single line without wrapping.

### Parameters
- **text** (impl Into<StyledString>) - Required - The styled string content to be rendered.
```

--------------------------------

### Text::new

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Text.html

Creates a new instance of the Text element with the provided styled string.

```APIDOC
## pub fn new(text: impl Into<StyledString>) -> Text

### Description
Creates a new instance of the Text element with the given styled string.

### Parameters
- **text** (impl Into<StyledString>) - Required - The styled string content to be rendered.
```

--------------------------------

### FontData::load

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.FontData.html?search=std%3A%3Avec

Loads a font from a file path.

```APIDOC
## FontData::load(path: impl AsRef<Path>, builtin: Option<BuiltinFont>) -> Result<FontData, Error>

### Description
Loads the font at the given path. The path must point to a file that can be read by rusttype.
```

--------------------------------

### Page Layer Management Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Page.html?search=

Methods for interacting with layers on a PDF page.

```rust
pub fn add_layer(&mut self, name: impl Into<String>)
```

```rust
pub fn layer_count(&self) -> usize
```

```rust
pub fn get_layer(&self, idx: usize) -> Option<Layer<'_>>
```

```rust
pub fn first_layer(&self) -> Layer<'_>
```

```rust
pub fn last_layer(&self) -> Layer<'_>
```

--------------------------------

### Provided Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/trait.Element.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Helper methods provided by the Element trait to wrap elements with additional layout or styling properties.

```APIDOC
## fn framed(self, line_style: impl Into<LineStyle>) -> FramedElement<Self>
Draws a frame around the element using the specified line style.

## fn padded(self, padding: impl Into<Margins>) -> PaddedElement<Self>
Adds padding around the element.

## fn styled(self, style: impl Into<Style>) -> StyledElement<Self>
Sets the default style for the element and its children.
```

--------------------------------

### Document::new

Source: https://docs.rs/genpdfi/latest/genpdfi/struct.Document.html

Creates a new PDF document instance with a specified font family.

```APIDOC
## Document::new

### Description
Creates a new Document instance initialized with the provided font family.

### Signature
`pub fn new(font_family: FontFamily) -> Document`
```

--------------------------------

### Layer methods

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Layer.html?search=std%3A%3Avec

Methods available for interacting with a Layer instance.

```rust
pub fn layer(&self) -> &PdfLayerReference
```

```rust
pub fn next(&self) -> Layer<'p>
```

```rust
pub fn area(&self) -> Area<'p>
```

```rust
pub fn add_annotation(&mut self, annotation: LinkAnnotation)
```

--------------------------------

### genpdfi::fonts::from_files

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/fn.from_files.html?search=u32+-%3E+bool

Loads a font family from a directory. It expects files named {name}-Regular.ttf, {name}-Bold.ttf, {name}-Italic.ttf, and {name}-BoldItalic.ttf to exist at the provided path.

```APIDOC
## Function: from_files

### Description
Loads the font family at the given path with the given name. This method assumes that at the given path, specific font files exist and are valid.

### Signature
`pub fn from_files(dir: impl AsRef<Path>, name: &str, builtin: Option<Builtin>) -> Result<FontFamily<FontData>, Error>`

### Parameters
- **dir** (impl AsRef<Path>) - The directory path containing the font files.
- **name** (str) - The base name of the font files.
- **builtin** (Option<Builtin>) - Optional built-in PDF fonts to use instead of embedding the files.

### Returns
- **Result<FontFamily<FontData>, Error>** - Returns the loaded FontFamily or an Error if the files are missing or invalid.
```

--------------------------------

### pub fn add_layer(&mut self, name: impl Into<String>)

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Page.html

Adds a new layer with the specified name to the page.

```APIDOC
### add_layer

Adds a new layer with the given name to the page.

#### Parameters
- **name** (impl Into<String>) - Required - The name of the new layer.
```

--------------------------------

### Renderer::add_page

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Renderer.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Adds a new page with the given size to the document.

```APIDOC
## pub fn add_page(&mut self, size: impl Into<Size>)

### Description
Adds a new page with the specified size to the existing PDF document.

### Parameters
- **size** (impl Into<Size>) - Required - The size of the new page.
```

--------------------------------

### Renderer::add_page

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Renderer.html

Adds a new page with the given size to the document.

```APIDOC
## pub fn add_page(&mut self, size: impl Into<Size>)

### Description
Adds a new page with the given size to the document.
```

--------------------------------

### Metrics Constructor

Source: https://docs.rs/genpdfi/latest/genpdfi/fonts/struct.Metrics.html?search=std%3A%3Avec

Creates a new instance of Metrics with specified height values.

```rust
pub fn new( line_height: Mm, glyph_height: Mm, ascent: Mm, descent: Mm, ) -> Metrics
```

--------------------------------

### Image Struct Methods

Source: https://docs.rs/genpdfi/latest/genpdfi/elements/struct.Image.html

Methods for creating and configuring Image instances for PDF embedding.

```APIDOC
## Image Creation

### from_dynamic_image(data: DynamicImage) -> Result<Self, Error>
Creates a new image from an already loaded image.

### from_reader<R>(reader: R) -> Result<Self, Error> where R: BufRead + Read + Seek
Creates a new image from the given reader.

### from_path(path: impl AsRef<Path>) -> Result<Self, Error>
Creates a new image by reading from the given path.

## Configuration Methods

### set_position(position: impl Into<Position>)
Translates the image to the specified position.

### with_position(position: impl Into<Position>) -> Self
Translates the image to the specified position and returns the instance.

### set_scale(scale: impl Into<Scale>)
Sets the scale of the image.

### with_scale(scale: impl Into<Scale>) -> Self
Sets the scale of the image and returns the instance.

### set_alignment(alignment: impl Into<Alignment>)
Sets the alignment for the image.

### with_alignment(alignment: impl Into<Alignment>) -> Self
Sets the alignment for the image and returns the instance.

### set_clockwise_rotation(rotation: impl Into<Rotation>)
Sets the clockwise rotation around the bottom left corner.

### with_clockwise_rotation(rotation: impl Into<Rotation>) -> Self
Sets the clockwise rotation and returns the instance.

### set_dpi(dpi: f32)
Sets the expected DPI of the encoded image.

### with_dpi(dpi: f32) -> Self
Sets the expected DPI and returns the instance.
```

--------------------------------

### pub fn first_layer(&self) -> Layer<'_>

Source: https://docs.rs/genpdfi/latest/genpdfi/render/struct.Page.html

Retrieves the first layer associated with the page.

```APIDOC
### first_layer

Returns the first layer of this page.

#### Returns
- **Layer<'_>** - The first layer.
```
Tokens:
Raw