Struct Area 

pub struct Area<'p> {
    layer: Layer<'p>,
    origin: Position,
    size: Size,
}

A view on an area of a PDF layer that can be drawn on.

This struct provides access to the drawing methods of a printpdf::PdfLayerReference. It is defined by the layer that is drawn on and the origin and the size of the area.

Fields

layer: Layer<'p>

origin: Position

size: Size

Implementations

impl<'p> Area<'p>

fn new(layer: Layer<'p>, origin: Position, size: Size) -> Area<'p>

pub fn next_layer(&self) -> Self

Returns a copy of this area on the next layer of the page.

If this area is not on the last layer, the existing next layer is used. If it is on the last layer, a new layer is created and added to the page.

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

Reduces the size of the drawable area by the given margins.

pub fn size(&self) -> Size

Returns the size of this area.

pub fn add_offset(&mut self, offset: impl Into<Position>)

Adds the given offset to the area, reducing the drawable area.

pub fn set_size(&mut self, size: impl Into<Size>)

Sets the size of this area.

pub fn set_width(&mut self, width: Mm)

Sets the width of this area.

pub fn set_height(&mut self, height: Mm)

Sets the height of this area.

pub fn split_horizontally(&self, weights: &[usize]) -> Vec<Area<'p>>

Splits this area horizontally using the given weights.

The returned vector has the same number of elements as the provided slice. The width of the i-th area is width * weights[i] / total_weight, where width is the width of this area, and total_weight is the sum of all given weights.

Examples

use genpdfi_extended::render::Renderer;
use genpdfi_extended::Size;

let r = Renderer::new(Size::new(210.0, 297.0), "ex").expect("renderer");
let area = r.get_page(0).unwrap().first_layer().area();
let parts = area.split_horizontally(&[1usize, 2usize]);
assert_eq!(parts.len(), 2);

pub fn add_image( &self, image: &DynamicImage, position: Position, scale: Scale, rotation: Rotation, dpi: Option<f32>, )

Example (images)

use genpdfi_extended::render::Renderer;
use genpdfi_extended::{Size, Mm, Position, Rotation, Scale};
use image::{DynamicImage, RgbImage, Rgb};
let mut r = Renderer::new(Size::new(210.0, 297.0), "img").expect("renderer");
let area = r.first_page().first_layer().area();
let img = DynamicImage::ImageRgb8(RgbImage::from_pixel(5, 5, Rgb([128,128,128])));
area.add_image(&img, Position::new(Mm::from(10.0), Mm::from(10.0)), Scale::new(1.0, 1.0), Rotation::from_degrees(0.0), None);
let mut buf = Vec::new();
r.write(&mut buf).expect("write");
assert!(!buf.is_empty());

Inserts an image into the document.

Only available if the images feature is enabled.

The position is assumed to be relative to the upper left hand corner of the area. Your position will need to compensate for rotation/scale/dpi. Using Image’s render functionality will do this for you and is the recommended way to insert an image into an Area.

pub fn add_svg( &self, svg: &ExternalXObject, position: Position, scale: Scale, rotation: Rotation, )

Inserts an SVG image into the document.

Only available if the images feature is enabled.

SVG images are embedded as vector graphics without rasterization. This method leverages printpdf’s native SVG support for optimal rendering quality.

The position is assumed to be relative to the upper left hand corner of the area. Your position will need to compensate for rotation/scale. Using Image’s render functionality will do this for you and is the recommended way to insert an SVG into an Area.

Arguments

• svg - A parsed SVG ExternalXObject from printpdf
• position - The position in the area, relative to upper left corner
• scale - Scaling factors for width and height
• rotation - Clockwise rotation in degrees

pub fn add_image_link( &self, position: Position, size: Size, _rotation: Rotation, uri: &str, )

Adds a clickable link annotation for an image area.

Arguments

• position - Position of the image (upper-left corner)
• size - Size of the image in millimeters
• rotation - Rotation of the image
• uri - The URL to open when the image is clicked

pub fn draw_line<I>(&self, points: I, line_style: LineStyle)

where I: IntoIterator<Item = Position>,

Draws a line with the given points and the given line style.

The points are relative to the upper left corner of the area.

pub fn print_str<S: AsRef<str>>( &self, font_cache: &FontCache, position: Position, style: Style, s: S, ) -> Result<bool, Error>

Tries to draw the given string at the given position and returns true if the area was large enough to draw the string.

The font cache must contain the PDF font for the font set in the style. The position is relative to the upper left corner of the area.

pub fn text_section<'f>( &self, font_cache: &'f FontCache, position: Position, metrics: Metrics, ) -> Option<TextSection<'f, 'p>>

Creates a new text section at the given position if the text section fits in this area.

The given style is only used to calculate the line height of the section. The position is relative to the upper left corner of the area. The font cache must contain the PDF font for all fonts printed with the text section.

Examples

use genpdfi_extended::render::Renderer;
use genpdfi_extended::Size;
use genpdfi_extended::fonts::{FontCache, FontData, FontFamily};
use genpdfi_extended::style::Style;

// Use the bundled TTF to create a FontCache for the example
let data = include_bytes!(concat!(env!("CARGO_MANIFEST_DIR"), "/fonts/NotoSans-Regular.ttf")).to_vec();
let fd = FontData::new(data.clone(), None).expect("font data");
let family = FontFamily { regular: fd.clone(), bold: fd.clone(), italic: fd.clone(), bold_italic: fd.clone() };
let cache = FontCache::new(family);
let mut r = Renderer::new(Size::new(210.0, 297.0), "ex").expect("renderer");
// metrics from style
use genpdfi_extended::Position;
let style = Style::new().with_font_family(cache.default_font_family());
let metrics = style.metrics(&cache);
let area = r.get_page(0).unwrap().first_layer().area();
let sec = area.text_section(&cache, Position::default(), metrics);
assert!(sec.is_some());

fn position(&self, position: Position) -> LayerPosition

Returns a position relative to the top left corner of this area.

pub fn add_link<S: AsRef<str>>( &self, font_cache: &FontCache, position: Position, style: Style, text: S, uri: S, ) -> Result<bool, Error>

Adds a clickable link to the document.

The font cache must contain the PDF font for the font set in the style. The position is relative to the upper left corner of the area.

Trait Implementations

impl<'p> Clone for Area<'p>

fn clone(&self) -> Area<'p>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.