Skip to content
PDF Oxide

API Fluente PdfBuilder

O PdfBuilder oferece uma API de configuração fluente para a criação de PDF. Encadeie métodos para definir o tamanho da página, margens, tamanho da fonte, metadados e muito mais, e então chame um método from_* para gerar o PDF.

Cobertura por binding. O PdfBuilder / WasmPdfBuilder fluente está disponível em Python, Rust e WASM. Os bindings de Go e C# expõem os pontos de entrada de atalho (FromMarkdown, FromHtml, FromImage / Pdf.FromMarkdown, Pdf.FromHtml, Pdf.FromText), mas não a superfície de configuração do builder. Para margens personalizadas ou tamanhos de página a partir de Go ou C#, chame a CLI Rust com flags ou crie um wrapper de um helper Rust que exponha o builder via FFI.

Exemplo Rápido

Python

from pdf_oxide import Pdf

# Python uses optional keyword arguments on Pdf static methods
pdf = Pdf.from_markdown(
    "# Report\n\nContent here.",
    title="Quarterly Report",
    author="Finance Team"
)
pdf.save("report.pdf")

WASM

import { WasmPdf } from "pdf-oxide-wasm";

// JavaScript uses optional title and author parameters
const pdf = WasmPdf.fromMarkdown(
  "# Report\n\nContent here.",
  "Quarterly Report",
  "Finance Team"
);
writeFileSync("report.pdf", pdf.toBytes());

Rust

use pdf_oxide::api::PdfBuilder;
use pdf_oxide::writer::PageSize;

let pdf = PdfBuilder::new()
    .title("Quarterly Report")
    .author("Finance Team")
    .page_size(PageSize::A4)
    .margin(54.0)
    .font_size(11.0)
    .line_height(1.5)
    .from_markdown("# Report\n\nContent here.")?;

pdf.save("report.pdf")?;

Referência Completa da API

Construtor

PdfBuilder::new() -> PdfBuilder

Cria um novo builder com a configuração padrão:

Configuração Padrão
Tamanho da página Letter (8.5" x 11")
Todas as margens 72pt (1 polegada)
Tamanho da fonte 12pt
Altura da linha 1.5

Métodos de Metadados

.title(title) – Define o Título do Documento

PdfBuilder::new().title("My Document")

.author(author) – Define o Autor do Documento

PdfBuilder::new().author("Jane Smith")

.subject(subject) – Define o Assunto do Documento

PdfBuilder::new().subject("Annual Performance Review")

.keywords(keywords) – Define as Palavras-chave do Documento

PdfBuilder::new().keywords("report, annual, 2025")

Métodos de Layout

.page_size(size) – Define o Tamanho da Página

use pdf_oxide::writer::PageSize;

PdfBuilder::new().page_size(PageSize::A4)

Enum PageSize:

Variante Dimensões
PageSize::Letter 612 x 792 pt (8.5" x 11")
PageSize::A4 595 x 842 pt (210 x 297 mm)
PageSize::Legal 612 x 1008 pt (8.5" x 14")
PageSize::A3 842 x 1190 pt (297 x 420 mm)
PageSize::Custom(w, h) Largura x altura personalizadas em pontos

.margin(margin) – Define Margens Uniformes

Define as quatro margens (esquerda, direita, superior, inferior) com o mesmo valor em pontos.

PdfBuilder::new().margin(54.0)  // 0.75 inch margins

.margins(left, right, top, bottom) – Define Margens Individuais

PdfBuilder::new().margins(72.0, 72.0, 54.0, 54.0)

Métodos de Tipografia

.font_size(size) – Define o Tamanho de Fonte Padrão

PdfBuilder::new().font_size(11.0)

.line_height(height) – Define o Multiplicador de Altura da Linha

Controla o espaçamento entre linhas. Um valor de 1.5 significa 1.5 vez o tamanho da fonte.

PdfBuilder::new().line_height(1.6)

Métodos de Geração

Cada método de geração consome o builder e retorna um objeto Pdf.

.from_markdown(content) – Gera a partir de Markdown

let pdf = PdfBuilder::new()
    .title("Notes")
    .from_markdown("# Notes\n\n- Item one\n- Item two")?;

.from_html(content) – Gera a partir de HTML

let pdf = PdfBuilder::new()
    .title("Report")
    .from_html("<h1>Report</h1><p>Summary of findings.</p>")?;

.from_text(content) – Gera a partir de Texto Simples

let pdf = PdfBuilder::new()
    .font_size(10.0)
    .from_text("Line 1\nLine 2\nLine 3")?;

.from_image(path) – Gera a partir de uma Única Imagem

let pdf = PdfBuilder::new()
    .page_size(PageSize::A4)
    .from_image("photo.jpg")?;

.from_image_bytes(data) – Gera a partir de Bytes de Imagem

let data = std::fs::read("chart.png")?;
let pdf = PdfBuilder::new().from_image_bytes(&data)?;

.from_images(paths) – Gera a partir de Múltiplas Imagens

let pdf = PdfBuilder::new()
    .title("Photo Album")
    .from_images(&["img1.jpg", "img2.jpg", "img3.jpg"])?;

.from_qrcode(data) – Gera um PDF com QR Code

Requer a feature barcodes.

let pdf = PdfBuilder::new()
    .title("QR Code")
    .from_qrcode("https://example.com")?;

.from_barcode(barcode_type, data) – Gera um PDF com Código de Barras

Requer a feature barcodes.

use pdf_oxide::writer::barcode::BarcodeType;

let pdf = PdfBuilder::new()
    .from_barcode(BarcodeType::Code128, "ABC-12345")?;

Exemplos Avançados

Cadeia de Configuração Completa

use pdf_oxide::api::PdfBuilder;
use pdf_oxide::writer::PageSize;

let content = r#"
# Technical Specification

## Overview

This document defines the interface contract for the v2 API.

## Endpoints

- `GET /api/v2/users` - List users
- `POST /api/v2/users` - Create user
- `GET /api/v2/users/:id` - Get user by ID

## Authentication

All endpoints require a Bearer token in the Authorization header.
"#;

let pdf = PdfBuilder::new()
    .title("API Specification v2")
    .author("Platform Team")
    .subject("REST API Technical Specification")
    .keywords("api, rest, specification, v2")
    .page_size(PageSize::A4)
    .margins(72.0, 72.0, 54.0, 72.0)
    .font_size(11.0)
    .line_height(1.5)
    .from_markdown(content)?;

pdf.save("api_spec.pdf")?;

Tamanho de Página Personalizado

use pdf_oxide::api::PdfBuilder;
use pdf_oxide::writer::PageSize;

// Create a half-letter page (5.5" x 8.5")
let pdf = PdfBuilder::new()
    .page_size(PageSize::Custom(396.0, 612.0))
    .margin(36.0)
    .font_size(10.0)
    .from_markdown("# Pocket Guide\n\nCompact reference card.")?;

pdf.save("pocket_guide.pdf")?;

Equivalente em JavaScript

No JavaScript/WASM, os métodos estáticos do WasmPdf aceitam parâmetros opcionais title e author, oferecendo a mesma funcionalidade que os metadados do PdfBuilder:

import { WasmPdf } from "pdf-oxide-wasm";

const pdf = WasmPdf.fromMarkdown("# Notes\n\n- Item one\n- Item two", "Notes");
const html = WasmPdf.fromHtml("<h1>Report</h1><p>Summary.</p>", "Report", "Author");
const text = WasmPdf.fromText("Line 1\nLine 2", "Plain Text Doc");
const img = WasmPdf.fromImageBytes(imageData);

A configuração de tamanho de página, margens, tamanho de fonte e altura de linha não está disponível na API WASM — use as configurações de layout padrão.

Métodos de Saída

Depois de ter um objeto Pdf / WasmPdf, use estes métodos para gerá-lo:

Método Linguagem Descrição
.save(path) Python, Rust Escreve o PDF em um arquivo
.to_bytes() (Python) Python Obtém os bytes brutos do PDF
.into_bytes() (Rust) Rust Consome o Pdf e retorna Vec<u8>
.toBytes() (JS) JavaScript Obtém o PDF como Uint8Array

Páginas Relacionadas