Skip to content
PDF Oxide

Constructor de PDF

PdfBuilder proporciona una API de configuración fluida para la creación de PDF. Encadene métodos para establecer tamaño de página, márgenes, tamaño de fuente, metadatos y más, luego llame a un método from_* para generar el PDF.

Ejemplo 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")?;

Referencia completa de la API

Constructor

PdfBuilder::new() -> PdfBuilder

Crea un nuevo builder con configuración predeterminada:

Setting Default
Page size Letter (8.5" x 11")
All margins 72pt (1 inch)
Font size 12pt
Line height 1.5

Métodos de metadatos

.title(title) – Establecer título del documento

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

.author(author) – Establecer autor del documento

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

.subject(subject) – Establecer asunto del documento

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

.keywords(keywords) – Establecer palabras clave del documento

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

Métodos de diseño

.page_size(size) – Establecer tamaño de página

use pdf_oxide::writer::PageSize;

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

PageSize enum:

Variant Dimensions
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) Custom width x height in points

.margin(margin) – Establecer márgenes uniformes

Establece los cuatro márgenes (izquierdo, derecho, superior, inferior) al mismo valor en puntos.

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

.margins(left, right, top, bottom) – Establecer márgenes individuales

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

Métodos de tipografía

.font_size(size) – Establecer tamaño de fuente predeterminado

PdfBuilder::new().font_size(11.0)

.line_height(height) – Establecer multiplicador de altura de línea

Controla el espaciado entre líneas. Un valor de 1.5 significa 1.5 veces el tamaño de fuente.

PdfBuilder::new().line_height(1.6)

Métodos de generación

Cada método de generación consume el builder y retorna un objeto Pdf.

.from_markdown(content) – Generar desde Markdown

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

.from_html(content) – Generar desde HTML

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

.from_text(content) – Generar desde texto plano

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

.from_image(path) – Generar desde una sola imagen

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

.from_image_bytes(data) – Generar desde bytes de imagen

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

.from_images(paths) – Generar desde múltiples imágenes

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

.from_qrcode(data) – Generar PDF de código QR

Requiere la característica barcodes.

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

.from_barcode(barcode_type, data) – Generar PDF de código de barras

Requiere la característica barcodes.

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

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

Ejemplos avanzados

Cadena de configuración 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")?;

Tamaño 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 en JavaScript

En JavaScript/WASM, los métodos estáticos de WasmPdf aceptan parámetros opcionales de title y author, proporcionando la misma funcionalidad que los metadatos de 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);

La configuración de tamaño de página, márgenes, tamaño de fuente y altura de línea no está disponible en la API WASM — use la configuración de diseño predeterminada.

Métodos de salida

Una vez que tenga un objeto Pdf / WasmPdf, use estos métodos para generarlo:

Method Language Description
.save(path) Python, Rust Write the PDF to a file
.to_bytes() (Python) Python Get the raw PDF bytes
.into_bytes() (Rust) Rust Consume the Pdf and return Vec<u8>
.toBytes() (JS) JavaScript Get the PDF as Uint8Array

Páginas relacionadas