package
0.7.6
Repository: https://github.com/pulingfu/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 outlines 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 adds keywords to rs's infodict and writes the result to w.
AddKeywordsFile adds keywords to inFile's infodict and writes the result to outFile.
AddPDFWatermarksFile adds PDF stamps/watermarks to inFile and writes the result to outFile.
AddProperties adds properties to rs's infodict and writes the result to w.
AddPropertiesFile adds properties to inFile's infodict 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.
Annotations returns page annotations of rs for selected pages.
Attachments returns rs's attachments.
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.
Bookmarks returns rs's bookmark hierarchy.
Box parses a box definition.
Boxes returns rs's page boundaries for selected pages of rs.
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.
Create renders the PDF structure represented by rs into w.
CreateCheatSheetsUserFonts creates single page PDF cheat sheets for installed user fonts.
CreateFile renders the PDF structure represented by inFileJSON into outFilePDF.
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.
Cut applies cutConf for selected pages of rs and writes results to outDir.
CutFile applies cutConf for selected pages of inFile and writes results to outDir.
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.
DumpObject writes an object from rs to stdout.
DumpObjectFile writes an object from rs to stdout.
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.
ExportBookmarksFile extracts outline data from inFilePDF and writes the result to outFileJSON.
ExportBookmarksJSON extracts outline data from rs (originating from source) and writes the result to w.
ExportForm extracts form data originating from source from rs.
ExportFormFile extracts form data from inFilePDF and writes the result to outFileJSON.
ExportFormJSON extracts form data originating from source from rs and writes the result to w.
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.
FillForm populates the form rs with data from rd and writes the result to w.
FillFormFile populates the form inFilePDF with data from inFileJSON and writes the result to outFilePDF.
FormFields returns all form fields of rs.
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.
Images returns all embedded images of rs.
ImageWatermark returns an image watermark configuration.
ImageWatermarkForReader returns an image watermark configuration for r.
Import parses an Import command string into an internal structure.
ImportBookmarks creates/replaces outlines in rs and writes the result to w.
ImportBookmarks creates/replaces outlines in inFilePDF and writes the result to outFilePDF.
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.
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.
Keywords returns the keywords of rs's info dict.
ListFonts returns a list of supported fonts.
ListPageLayout lists rs's page layout.
ListPageLayoutFile lists inFile's page layout.
ListPageMode lists rs's page mode.
ListPageModeFile lists inFile's page mode.
ListViewerPreferences returns rs's viewer preferences.
ListViewerPreferencesFile lists inFile's viewer preferences.
ListViewerPreferencesFile lists inFile's viewer preferences in JSON.
LoadConfiguration locates and loads the default configuration and also loads installed user fonts.
LockFormFields turns form fields in rs into read-only and writes the result to w.
LockFormFieldsFile turns form fields of inFile into read-only and writes the result to outFile.
Merge concatenates inFiles.
MergeAppendFile appends inFiles to outFile.
MergeCreateFile merges inFiles and writes the result to outFile.
MergeCreateZip zips rs1 and rs2 into w.
MergeCreateZipFile zips inFile1 and inFile2 into outFile.
MergeRaw merges a sequence of PDF streams and writes the result to w.
MultiFillForm populates multiples instances of inFilePDF's form with data from rd and writes the result to outDir.
MultiFillFormFile populates multiples instances of inFilePDFs form with data from inFileData and writes the result to outDir.
NDown applies n & cutConf for selected pages of rs and writes results to outDir.
NDownFile applies n & cutConf for selected pages of inFile and writes results to outDir.
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.
PageLayout returns rs's page layout.
PageLayoutFile returns inFile's page layout.
PageMode returns rs's page mode.
PageModeFile returns inFile's page mode.
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.
PDFInfo returns information about rs.
PDFMultiWatermarkForReadSeeker returns a PDF watermark configuration.
PDFNUpConfig returns an NUp configuration for Nup-ing PDF files.
PDFWatermark returns a PDF watermark configuration.
PDFWatermarkForReadSeeker returns a PDF watermark configuration.
Permissions returns user access permissions for rs.
Poster applies cut for selected pages of rs and generates corresponding poster tiles in outDir.
PosterFile applies cut for selected pages of inFile and generates corresponding poster tiles in outDir.
Properties returns rs's properties as recorded in infoDict.
ReadAndValidate returns a model.Context of rs ready for processing.
ReadContext uses an io.ReadSeeker to build an internal structure holding its cross reference table aka the Context.
ReadContextFile returns inFile's validated context.
ReadValidateAndOptimize returns an optimized model.Context of rs ready for processing.
No description provided by the author
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.
RemoveBookmarks deletes outlines from rs and writes the result to w.
RemoveBookmarksFile deletes outlines 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.
RemoveFormFields deletes form fields in rs and writes the result to w.
RemoveFormFieldsFile deletes form fields in inFile and writes the result to outFile.
RemoveKeywords deletes keywords from rs's infodict and writes the result to w.
RemoveKeywordsFile deletes keywords from inFile's infodict 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 properties from rs's infodict and writes the result to w.
RemovePropertiesFile deletes properties from inFile's infodict 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.
ResetFormFields resets form fields of rs and writes the result to w.
ResetFormFieldsFile resets form fields of inFile and writes the result to outFile.
ResetPageLayout resets rs's page layout and writes the result to w.
ResetPageLayoutFile resets inFile's page layout and writes the result to outFile.
ResetPageMode resets rs's page mode and writes the result to w.
ResetPageModeFile resets inFile's page mode and writes the result to outFile.
ResetViewerPreferences resets rs's viewer preferences and writes the result to w.
ResetViewerPreferencesFile resets inFile's viewer preferences and writes the result to outFile.
Resize applies resizeConf for selected pages of rs and writes result to w.
ResizeFile applies resizeConf for selected pages of inFile and writes 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.
SetPageLayout sets rs's page layout and writes the result to w.
SetPageLayoutFile sets inFile's page layout and writes the result to outFile.
SetPageMode sets rs's page mode and writes the result to w.
SetPageModeFile sets inFile's page mode and writes the result to outFile.
SetPermissions sets user access permissions.
SetPermissionsFile sets inFile's user access permissions.
SetViewerPreferences sets rs's viewer preferences and writes the result to w.
SetViewerPreferencesFile sets inFile's viewer preferences and writes the result to outFile.
SetViewerPreferencesFileFromJSONBytes sets inFile's viewer preferences corresponding to jsonBytes and writes the result to outFile.
SetViewerPreferencesFileFromJSONFile sets inFile's viewer preferences corresponding to inFileJSON and writes the result to outFile.
SetViewerPreferencesFromJSONBytes sets rs's viewer preferences corresponding to jsonBytes and writes the result to w.
SetViewerPreferencesFromJSONReader sets rs's viewer preferences corresponding to rd and writes the result to w.
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 rs splitting along pageNrs.
SplitFile generates a sequence of PDF files in outDir for inFile splitting it along pageNrs.
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.
UnlockFormFields makess form fields in rs writeable and writes the result to w.
UnlockFormFieldsFile makes form fields of inFile writeable 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.
ViewerPreferences returns rs's viewer preferences.
ViewerPreferences returns inFile's viewer preferences.
WatermarkContext applies wm for selected pages to ctx.
No description provided by the author
WriteContext writes ctx to w.
WriteContextFile writes ctx to outFile.
No description provided by the author
WriteIncrement writes a PDF increment for ctx to w.
Zoom applies resizeConf for selected pages of rs and writes result to w.
ZoomFile applies zoomConf for selected pages of inFile and writes result to outFile.

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

No description provided by the author