PDF Export Service

@slickgrid-universal/pdf-export

Export your SlickGrid data to PDF format using jsPDF - a popular, well-supported PDF library for JavaScript.

External Dependencies

• jsPDF to build and export to PDF.
• jspdf-autotable (optional) – renders a proper HTML-style table with borders, padding, and per-column styles. When detected at runtime the service automatically uses it; otherwise it falls back to a simple text-based layout.

Installation

npm install @slickgrid-universal/pdf-export

# optional – for enhanced table rendering with borders, per-column styles and more
npm install jspdf-autotable

Usage

import { PdfExportService } from '@slickgrid-universal/pdf-export';
import { jsPDF } from 'jspdf';
import { applyPlugin } from 'jspdf-autotable';

applyPlugin(jsPDF); // register AutoTable once at startup (if installed)

// Register the service
const pdfExportService = new PdfExportService();

// Initialize in grid options
const gridOptions = {
  enablePdfExport: true,
  pdfExportOptions: {
    filename: 'my-grid-export',
    pageOrientation: 'landscape',
    pageSize: 'a4',
    documentTitle: 'My Grid Data'
  },
  externalResources: [pdfExportService]
};

// Export to PDF
await pdfExportService.exportToPdf({
  filename: 'custom-export',
  pageOrientation: 'portrait'
});

Options

See PdfExportOption for all available options.

Features

• Export grid data to PDF
• Support for grouped data
• Configurable page size and orientation (A4, Letter, Legal)
• Portrait and landscape orientations
• Custom font sizes
• Support for formatters
• HTML entity decoding
• Data sanitization
• Per-column text alignment
• Grouped column headers (pre-header row)
• Customizable header, pre-header, and alternate row colors
• PDF document properties (metadata)
• Powered by jsPDF (widely used, extensible, and feature-rich)
• Optional enhanced table rendering via jspdf-autotable

License

MIT