package
0.0.0-20240228050944-81731f5f387e
Repository: https://github.com/pirogom/pdfcpu.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
AddAnnotations adds annotations for selected pages in rs and writes the result to w.
AddAnnotationsAsIncrement adds annotations for selected pages in rws and writes out a PDF increment.
AddAnnotationsFile adds annotations for selected pages to a PDF context read from inFile and writes the result to outFile.
AddAnnotationsMap adds annotations in m to corresponding pages of rs and writes the result to w.
AddAnnotationsMapAsIncrement adds annotations in m to corresponding pages of rws and writes out a PDF increment.
AddAnnotationsMapFile adds annotations in m to corresponding pages of inFile and writes the result to outFile.
AddAttachments embeds files into a PDF context read from rs and writes the result to w.
AddAttachmentsFile embeds files into a PDF context read from inFile and writes the result to outFile.
AddBookmarks adds a single bookmark outline layer to the PDF context read from rs and writes the result to w.
AddBookmarksFile adds a single bookmark outline layer to the PDF context read from inFile and writes the result to outFile.
AddBoxes adds page boundaries for selected pages of rs and writes result to w.
AddBoxesFile adds page boundaries for selected pages of inFile and writes result to outFile.
AddImageWatermarksFile adds image stamps/watermarks to all selected pages of inFile and writes the result to outFile.
AddImageWatermarksForReaderFile adds image stamps/watermarks to all selected pages of inFile for r and writes the result to outFile.
AddKeywords embeds files into a PDF context read from rs and writes the result to w.
AddKeywordsFile embeds files into a PDF context read from inFile and writes the result to outFile.
AddPDFWatermarksFile adds PDF stamps/watermarks to all selected pages of inFile and writes the result to outFile.
AddProperties embeds files into a PDF context read from rs and writes the result to w.
AddPropertiesFile embeds files into a PDF context read from inFile and writes the result to outFile.
AddTextWatermarksFile adds text stamps/watermarks to all selected pages of inFile and writes the result to outFile.
AddWatermarks adds watermarks to all pages selected in rs and writes the result to w.
AddWatermarksFile adds watermarks to all selected pages of inFile and writes the result to outFile.
AddWatermarksMap adds watermarks in m to corresponding pages in rs and writes the result to w.
AddWatermarksMapFile adds watermarks to corresponding pages in m of inFile and writes the result to outFile.
AddWatermarksSliceMap adds watermarks in m to corresponding pages in rs and writes the result to w.
AddWatermarksSliceMapFile adds watermarks to corresponding pages in m of inFile and writes the result to outFile.
Booklet arranges PDF pages on larger sheets of paper and writes the result to w.
BookletFile rearranges PDF pages or images into a booklet layout and writes the result to outFile.
BookletFromImages creates a booklet from images.
Box parses a box definition.
ChangeOwnerPassword reads a PDF stream from rs, changes the owner password and writes the encrypted PDF stream to w.
ChangeOwnerPasswordFile reads inFile, changes the owner password and writes the result to outFile.
ChangeUserPassword reads a PDF stream from rs, changes the user password and writes the encrypted PDF stream to w.
ChangeUserPasswordFile reads inFile, changes the user password and writes the result to outFile.
Collect creates a custom PDF page sequence for selected pages of rs and writes the result to w.
CollectFile creates a custom PDF page sequence for inFile and writes the result to outFile.
CreateCheatSheetsUserFonts creates single page PDF cheat sheets for installed user fonts.
CreateFromJSONFile renders the PDF structure corresponding to rd to w.
CreateFromJSONFile renders the PDF structure corresponding to jsonFile to outFile.
CreatePDFFile creates a PDF file for an xRefTable and writes it to outFile.
CreateUserFontDemoFiles creates single page PDF for each Unicode plane covered.
Crop adds crop boxes for selected pages of rs and writes result to w.
CropFile adds crop boxes for selected pages of inFile and writes result to outFile.
Decrypt reads a PDF stream from rs and writes the encrypted PDF stream to w.
DecryptFile decrypts inFile and writes the result to outFile.
DisableConfigDir disables the configuration directory.
Encrypt reads a PDF stream from rs and writes the encrypted PDF stream to w.
EncryptFile encrypts inFile and writes the result to outFile.
EnsureDefaultConfigAt switches to the pdfcpu config dir located at path.
ExtractAttachments extracts embedded files from a PDF context read from rs into outDir.
ExtractAttachmentsFile extracts embedded files from a PDF context read from inFile into outDir.
ExtractAttachmentsRaw extracts embedded files from a PDF context read from rs.
ExtractContent dumps "PDF source" files from rs into outDir for selected pages.
ExtractContentFile dumps "PDF source" files from inFile into outDir for selected pages.
ExtractFonts dumps embedded fontfiles from rs into outDir for selected pages.
ExtractFontsFile dumps embedded fontfiles from inFile into outDir for selected pages.
ExtractImages extracts and digests embedded image resources from rs for selected pages.
ExtractImagesFile dumps embedded image resources from inFile into outDir for selected pages.
ExtractImagesRaw returns []pdfcpu.Image containing io.Readers for images contained in selectedPages.
ExtractMetadata dumps all metadata dict entries for rs into outDir.
ExtractMetadataFile dumps all metadata dict entries for inFile into outDir.
ExtractPages generates single page PDF files from rs in outDir for selected pages.
ExtractPagesFile generates single page PDF files from inFile in outDir for selected pages.
Get Bookmark info.
GetPermissions returns the permissions for rs.
GetPermissionsFile returns the permissions for inFile.
HasWatermarks checks rs for watermarks.
HasWatermarksFile checks inFile for watermarks.
ImageBookletConfig returns an NUp configuration for Booklet-ing image files.
ImageGridConfig returns a grid configuration for Grid-ing image files.
ImageNUpConfig returns an NUp configuration for Nup-ing image files.
ImageWatermark returns an image watermark configuration.
ImageWatermarkForReader returns an image watermark configuration for r.
Import parses an Import command string into an internal structure.
ImportImages appends PDF pages containing images to rs and writes the result to w.
ImportImagesFile appends PDF pages containing images to outFile which will be created if necessary.
Info returns information about rs.
InfoFile returns information about inFile.
InsertPages inserts a blank page before or after every page selected of rs and writes the result to w.
InsertPagesFile inserts a blank page before or after every inFile page selected and writes the result to w.
InstallFonts installs true type fonts for embedding.
ListAnnotations returns a list of page annotations of rs.
ListAnnotationsFile returns a list of page annotations of inFile.
ListAttachments returns a list of embedded file attachments of rs with optional description.
ListAttachmentsCompact returns a list of embedded file attachments of rs w/o optional description.
ListAttachmentsCompactFile returns a list of embedded file attachments of inFile w/o optional description.
ListAttachmentsFile returns a list of embedded file attachments of inFile with optional description.
ListBoxes returns a list of page boundaries for selected pages of rs.
ListBoxesFile returns a list of page boundaries for selected pages of inFile.
ListFonts returns a list of supported fonts.
ListImages returns a list of page annotations of rs.
ListImagesFile returns a list of embedded images of inFile.
ListKeywords returns the keyword list of rs.
ListKeywordsFile returns the keyword list of inFile.
ListPermissions returns a list of user access permissions.
ListPermissionsFile returns a list of user access permissions for inFile.
ListProperties returns the property list of rs.
ListPropertiesFile returns the property list of inFile.
LoadConfiguration locates and loads the default configuration and also loads installed user fonts.
Merge merges a sequence of PDF streams and writes the result to w.
MergeAppendFile merges a sequence of inFiles and writes the result to outFile.
MergeCreateFile merges a sequence of inFiles and writes the result to outFile.
NUp rearranges PDF pages or images into page grids and writes the result to w.
NUpFile rearranges PDF pages or images into page grids and writes the result to outFile.
NUpFromImage creates a single page n-up PDF for one image or a sequence of n-up pages for more than one image.
Optimize reads a PDF stream from rs and writes the optimized PDF stream to w.
OptimizeContext optimizes ctx.
OptimizeFile reads inFile and writes the optimized PDF to outFile.
PageBoundaries parses a list of box definitions and assignments.
PageBoundariesFromBoxList parses a list of box types.
PageCount returns rs's page count.
PageCountFile returns inFile's page count.
PageDims returns a sorted slice of mediaBox dimensions for rs.
PageDimsFile returns a sorted slice of mediaBox dimensions for inFile.
PagesForPageCollection returns a slice of page numbers for a page collection.
PagesForPageRange returns a slice of page numbers for a page range.
PagesForPageSelection ensures a set of page numbers for an ascending page sequence where each page number may appear only once.
ParsePageSelection ensures a correct page selection expression.
PDFBookletConfig returns an NUp configuration for Booklet-ing PDF files.
PDFGridConfig returns a grid configuration for Grid-ing PDF files.
PDFNUpConfig returns an NUp configuration for Nup-ing PDF files.
PDFWatermark returns a PDF watermark configuration.
ReadContext uses an io.ReadSeeker to build an internal structure holding its cross reference table aka the Context.
ReadContextFile returns inFile's validated context.
RemoveAnnotations removes annotations for selected pages by id and object number from a PDF context read from rs and writes the result to w.
RemoveAnnotationsAsIncrement removes annotations for selected pages by ids and object number from a PDF context read from rs and writes out a PDF increment.
RemoveAnnotationsFile removes annotations for selected pages by id and object number from a PDF context read from inFile and writes the result to outFile.
RemoveAttachments deletes embedded files from a PDF context read from rs and writes the result to w.
RemoveAttachmentsFile deletes embedded files from a PDF context read from inFile and writes the result to outFile.
RemoveBoxes removes page boundaries as specified in pb for selected pages of rs and writes result to w.
RemoveBoxesFile removes page boundaries as specified in pb for selected pages of inFile and writes result to outFile.
RemoveKeywords deletes embedded files from a PDF context read from rs and writes the result to w.
RemoveKeywordsFile deletes embedded files from a PDF context read from inFile and writes the result to outFile.
RemovePages removes selected pages from rs and writes the result to w.
RemovePagesFile removes selected inFile pages and writes the result to outFile..
RemoveProperties deletes embedded files from a PDF context read from rs and writes the result to w.
RemovePropertiesFile deletes embedded files from a PDF context read from inFile and writes the result to outFile.
RemoveWatermarks removes watermarks from all pages selected in rs and writes the result to w.
RemoveWatermarksFile removes watermarks from all selected pages of inFile and writes the result to outFile.
Rotate rotates selected pages of rs clockwise by rotation degrees and writes the result to w.
RotateFile rotates selected pages of inFile clockwise by rotation degrees and writes the result to outFile.
SetPermissions sets user access permissions.
SetPermissionsFile sets inFile's user access permissions.
Split generates a sequence of PDF files in outDir for the PDF stream read from rs obeying given split span.
SplitFile generates a sequence of PDF files in outDir for inFile obeying given split span.
SplitRaw returns page spans for the PDF stream read from rs obeying given split span.
TextWatermark returns a text watermark configuration.
Trim generates a trimmed version of rs containing all selected pages and writes the result to w.
TrimFile generates a trimmed version of inFile containing all selected pages and writes the result to outFile.
UpdateImageWatermarksFile adds image stamps/watermarks to all selected pages of inFile and writes the result to outFile.
UpdatePDFWatermarksFile adds PDF stamps/watermarks to all selected pages of inFile and writes the result to outFile.
UpdateTextWatermarksFile adds text stamps/watermarks to all selected pages of inFile and writes the result to outFile.
Validate validates a PDF stream read from rs.
ValidateContext validates ctx.
ValidateFile validates inFile.
ValidateFiles validates inFiles.
WatermarkContext applies wm for selected pages to ctx.
WriteContext writes ctx to w.
WriteContextFile writes ctx to outFile.
WriteIncrement writes a PDF increment for ctx to w.
# Interfaces
ReadSeekerCloser combines io.ReadSeeker and io.Closer.