pdf_file library
PDF-as-a-file API (ISO 32000). Parallel to the OOXML writer.
Classes
- PdfAcroForm
- Class PdfAcroForm.
- PdfAnnot
- Markup or navigation annotation (ISO 32000-1 §12.5).
- PdfBox
- Axis-aligned PDF rectangle in user space.
- PdfClipPath
-
W/W*clip (already mapped to page space). - PdfCos
- Closed COS value union (ISO 32000-1 §7.3).
- PdfCosArray
- Class PdfCosArray.
- PdfCosBool
- Class PdfCosBool.
- PdfCosDict
- Class PdfCosDict.
- PdfCosInt
- Class PdfCosInt.
- PdfCosName
- Class PdfCosName.
- PdfCosNull
- Class PdfCosNull.
- PdfCosReal
- Class PdfCosReal.
- PdfCosRef
-
Indirect reference
id gen R. - PdfCosStream
- Stream object: dictionary plus undecoded bytes.
- PdfCosString
- Literal or hexadecimal PDF string.
- PdfDisplayList
- Device-independent page paint ops (ISO 32000 content stream result).
- PdfDocInfo
- Document Info dictionary (ISO 32000-1 §14.3.3).
- PdfDrawImage
- Class PdfDrawImage.
- PdfDrawText
- Class PdfDrawText.
- PdfEmbeddedFile
-
Embedded file from the
/EmbeddedFilesname tree. - PdfExtract
- Text helpers for an opened PdfFile.
- PdfExtractedPage
- One page ready to be written as a new file.
- PdfFile
- Opened PDF file (ISO 32000). Parallel to OOXML models — not the writer.
- PdfFillPath
- Class PdfFillPath.
- PdfFormField
- AcroForm field (ISO 32000-1 §12.7).
- PdfHotspot
- Clickable annotation hotspot in top-left page space.
- PdfIncrementalSave
- Appends annotation / form / page-tree updates (ISO 32000-1 §7.5.6).
- PdfLayer
- Optional content group (ISO 32000-1 §8.11).
- PdfLinkAction
- Resolved navigation action the host may follow.
- PdfOfficeChart
- A chart whose geometry was a set of bars, wedges, or a polyline.
- PdfOfficeChartPoint
- One category on a PdfOfficeChart.
- PdfOfficeExportJob
- Message for pdfOfficeExportJob.
- PdfOfficeExportNote
- A limit hit while exporting, safe to send out of the worker isolate.
- PdfOfficeExportProgress
-
Progress of pdfOfficeExportJob. stage is
open,page, orwrite. - PdfOfficeExportResult
-
Office bytes, or error as a PdfOpenError name or
cancelled. - PdfOfficeExportRun
- A running export. cancel stops the worker isolate.
- PdfOfficeImage
- An image on the page. bytes is null when it cannot be stored.
- PdfOfficeLine
- One visual line rebuilt from glyphs or from a single text run.
- PdfOfficeNotice
- One limit hit while reading a PDF page for Office export.
- PdfOfficePage
- One PDF page after line, table, and image recovery.
- PdfOfficeRecovery
- The pages and the limits hit while reading them.
- PdfOfficeTable
- A table whose cells are the rectangles of a ruled grid.
- PdfOfficeTocEntry
- One row of a table of contents, from the PDF outline or a dot-leader line.
- PdfOpenPayload
- Isolate (or sync) result of opening a PDF.
- PdfOutlineNode
- Outline node (ISO 32000-1 §12.3.3).
- PdfPageInfo
- Page boxes and rotation after inheritance (ISO 32000-1 §7.7.3 / §14.11.2).
- PdfPageIo
- Builds a new 1.7 file from selected pages (extract / blank).
- PdfPageRec
- Internal page record.
- PdfPageSource
- One input file and the ranges to take from it.
- PdfPageView
-
Maps unrotated crop-space points into the clockwise
/Rotateview. - PdfPaintOp
- One paint command.
- PdfPathVerb
- Class PdfPathVerb.
- PdfPoint
- Class PdfPoint.
- PdfQuad
- Class PdfQuad.
- PdfRect
- Class PdfRect.
- PdfRedactRect
- One redaction rectangle recorded on a page.
- PdfRestoreGState
-
Q— pop graphics state. - PdfSaveGState
-
q— push graphics state (clip + transform) for the painter. - PdfSecurity
- ISO 32000-1 §7.6 Standard security handler (Rev 2–4, plus Rev 5/6 AES-256).
- PdfSignatureInfo
- Signature field snapshot. Creation of new signatures is out of Phase 6.
- PdfSplitSpec
- Split rule.
- PdfStrokePath
- Class PdfStrokePath.
- PdfStructNode
-
Tagged-PDF node from
/StructTreeRoot(ISO 32000-1 §14.7). Read-only. - PdfTextRun
- Selectable text run with a box in top-left page space.
- PdfToOffice
- Reads a PDF file into DOCX, XLSX, or a freeform PPTX.
- PdfToolbox
- Page assembly: merge, split, extract, reorder, rotate.
- PdfViewerPrefs
-
Catalog
/ViewerPreferences(ISO 32000-1 §12.2). - PdfXfdf
- XFDF import/export (ISO 32000-1 §12.7.8 / XFDF spec subset).
Enums
- PdfBlendMode
-
ExtGState
/BMsubset (ISO 32000-1 §8.4.5). - PdfExtractMode
- How PdfToolbox.extract writes several ranges.
- PdfLinkKind
- Class PdfLinkKind.
- PdfOfficeChartKind
- A column, bar, pie, or line chart rebuilt from vector marks.
- PdfOfficeListKind
- How a recovered line participates in a Word list.
- PdfOfficeNoticeKind
- Why a piece of a PDF page was not copied into Office.
- PdfOpenError
- Typed failure while opening or decoding a PDF file (ISO 32000).
- PdfPathKind
- Class PdfPathKind.
- PdfRedactMode
- Visual markup vs content-removal redaction (ISO 32000-1 §12.5.6).
- PdfSignatureStatus
- How a signature field is treated (P6.6).
- PdfSplitKind
- How PdfToolbox.split cuts one file.
Constants
- pdfOfficeNoTextMessage → const String
- Sentence written into an Office file when a page has no text layer.
Functions
-
pdfCosInt(
PdfCos? value) → int? - Integer helper.
-
pdfCosName(
PdfCos? value) → String? - Name helper.
-
pdfCosNumber(
PdfCos? value) → double? - Numeric helper for mixed int/real COS.
-
pdfCosRect(
PdfCos? value) → ({double llx, double lly, double urx, double ury})? -
Rectangle
[llx lly urx ury]. -
pdfCosText(
PdfCos? value) → String? - Literal text helper.
-
pdfOfficeExportJob(
PdfOfficeExportJob job) → void -
Reads
jobon this isolate and sends progress, then one result. -
pdfOfficeIsRtl(
String text) → bool - True when Arabic or Hebrew letters outnumber Latin letters.
-
startPdfOfficeExport(
{required Uint8List bytes, required String extension, String? password, required void onProgress(PdfOfficeExportProgress progress)}) → Future< PdfOfficeExportRun> -
Starts pdfOfficeExportJob and forwards its progress to
onProgress.
Exceptions / Errors
- PdfFilterUnsupported
- Stream filter that the interpreter must skip rather than crash.
- PdfOpenException
- Exception carrying a PdfOpenError.