package
0.8.3-mateyai
Repository: https://github.com/mateyai/pdfcpu.git
Documentation: pkg.go.dev

# Functions

AnchorPosAndAlign calculates position and alignment for an anchored rectangle r.
AppendPageTree appends a pagetree d1 to page tree d2.
No description provided by the author
No description provided by the author
No description provided by the author
ContentBytesForPageRotation returns content bytes compensating for rot.
CreateDCTImageObject returns a DCT encoded stream dict.
CreateImageResource creates a new XObject for given image data represented by r and applies optional filters.
CreateImageStreamDict returns a stream dict for image data represented by r and applies optional filters.
No description provided by the author
No description provided by the author
DefaultNUpConfig returns the default NUp configuration.
No description provided by the author
DefaultWatermarkConfig returns the default configuration.
No description provided by the author
No description provided by the author
DrawBookletGuides draws guides according to corresponding nup value.
No description provided by the author
EnsureDefaultConfigAt tries to load the default configuration from path.
EqualFontDicts returns true, if two font dicts are equal.
EqualObjects returns true if two objects are equal in the context of given xrefTable.
EqualStreamDicts returns true if two stream dicts are equal and contain the same bytes.
ImageFileName returns true for supported image file types.
ImageFileNames returns a slice of image file names contained in dir constrained by maxFileSize.
LowerLeftCorner returns the lower left corner for a bounding box anchored onto vp.
NewAESConfiguration returns a default configuration for AES encryption.
NewAnnotation returns a new annotation.
NewAnnotationForRawType returns a new annotation of a specific type.
NewCircleAnnotation returns a new circle annotation.
NewContext initializes a new Context.
NewDefaultConfiguration returns the default pdfcpu configuration.
NewFreeHeadXRefTableEntry returns the xref table entry for object 0 which is per definition the head of the free list (list of free objects).
NewInkAnnotation returns a new ink annotation.
NewLinkAnnotation returns a new link annotation.
NewMarkupAnnotation returns a new markup annotation.
NewPage creates a page for given mediaBox and cropBox.
NewPageResourceNames returns initialized pageResourceNames.
NewPageWithBg creates a page for a mediaBox.
NewPDFStats returns a new PDFStats object.
NewPopupAnnotation returns a new popup annotation.
NewRC4Configuration returns a default configuration for RC4 encryption.
NewSquareAnnotation returns a new square annotation.
NewTextAnnotation returns a new text annotation.
NewWriteContext returns a new WriteContext.
NewXRefTableEntryGen0 returns a cross reference table entry for an object with generation 0.
NUpTilePDFBytesForPDF applies nup tiles to content bytes.
ObjectStreamDict creates a ObjectStreamDict out of a StreamDict.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ParseBox parses a box definition.
ParseBoxList parses a list of box.
ParseObject parses next Object from string buffer and returns the updated (left clipped) buffer.
ParseObjectAttributes parses object number and generation of the next object for given string buffer.
ParseObjectContext parses next Object from string buffer and returns the updated (left clipped) buffer.
ParsePageBoundaries parses a list of box definitions and assignments.
ParseXRefStreamDict creates a XRefStreamDict out of a StreamDict.
PDFVersion returns the PDFVersion for a version string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Text returns a string based representation for String and Hexliterals.
TimingStats prints processing time stats for an operation.
ValidationTimingStats prints processing time stats for validation.
No description provided by the author
WriteColumn writes a text column using s at position x/y using a certain font, fontsize and a desired horizontal and vertical alignment.
WriteColumnAnchored writes a justified text column with anchored position and returns its bounding box.
WriteMultiLine writes s at position x/y using a certain font, fontsize and a desired horizontal and vertical alignment.
WriteMultiLineAnchored writes multiple lines with anchored position and returns its bounding box.

# Constants

The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
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
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
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
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
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
No description provided by the author
No description provided by the author
No description provided by the author
These are the types of booklet layouts.
The available commands.
These are the types of booklet layouts.
These are the types of booklet layouts.
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
PDF defines the following Color Spaces:.
PDF defines the following Color Spaces:.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
No description provided by the author
The available commands.
The available commands.
No description provided by the author
[page /Fit].
[page /FitB].
[page /FitBH top].
[page /FitBV left].
[page /FitH top].
[page /FitR left bottom right top].
[page /FitV left].
[page /XYZ left top zoom].
PDF defines the following Color Spaces:.
PDF defines the following Color Spaces:.
PDF defines the following Color Spaces:.
PDF defines the following Color Spaces:.
Rotation along one of 2 diagonals.
Rotation along one of 2 diagonals.
These are the defined anchors for relative positioning.
These are the defined anchors for relative positioning.
The available commands.
No description provided by the author
No description provided by the author
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
PDF defines the following Color Spaces:.
The available commands.
The available commands.
PDF defines the following Color Spaces:.
The available commands.
The available commands.
The available commands.
No description provided by the author
PDF defines the following Color Spaces:.
These are the defined anchors for relative positioning.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
No description provided by the author
No description provided by the author
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Rotation along one of 2 diagonals.
The available commands.
The available commands.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
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
The PDF page object fields.
The PDF page object fields.
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
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
The PDF page object fields.
PDF defines the following Color Spaces:.
Bit 11: Assemble document (security handlers >= rev.3).
Bit 5: Copy, extract text & graphics.
Bit 10: Copy, extract text & graphics (security handlers >= rev.3) (unused since PDF 2.0).
Bit 9: Fill form fields (security handlers >= rev.3).
Bit 6: Add or modify annotations, fill form fields, in conjunction with bit 4 create/mod form fields.
Bit 4: Modify contents by operations other than controlled by bits 6, 9, 11.
Bit 3: Print (security handlers rev.2), draft print (security handlers >= rev.3).
Bit 12: Print (security handlers >= rev.3).
No description provided by the author
No description provided by the author
No description provided by the author
The available commands.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
These are the defined anchors for relative positioning.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The PDF root object fields.
The available commands.
PDF defines the following Color Spaces:.
The available commands.
The available commands.
The available commands.
The available commands.
No description provided by the author
No description provided by the author
The available commands.
The available commands.
StatsFileNameDefault is the standard stats filename.
The available commands.
No description provided by the author
The available commands.
Bit 1: unused.
Bit 2: unused.
Bit 7: unused.
Bit 8: unused.
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
No description provided by the author
No description provided by the author
The available commands.
ValidationRelaxed ensures PDF compliance based on frequently encountered validation errors.
ValidationStrict ensures 100% compliance with the spec (PDF 32000-1:2008).
Watermark mode.
Watermark mode.
Watermark mode.
The available commands.

# Variables

No description provided by the author
AnnotTypeStrings manages string representations for annotation types.
ConfigPath defines the location of pdfcpu's configuration directory.
No description provided by the author
DestinationTypeStrings manages string representations for destination types.
No description provided by the author
No description provided by the author
VersionStr is the current pdfcpu version.
No description provided by the author

# Structs

No description provided by the author
Annotation represents a PDF annnotation.
Attachment is a Reader representing a PDF attachment.
No description provided by the author
No description provided by the author
Box is a rectangular region in user space expressed either explicitly via Rect or implicitly via margins applied to the containing parent box.
CircleAnnotation represents a square annotation.
Configuration of a Context.
Context represents an environment for processing PDF files.
No description provided by the author
Destination represents a PDF destination.
Enc wraps around all defined encryption attributes.
No description provided by the author
FontObject represents a font used in a PDF file.
FontResource represents an existing PDF font resource.
Image is a Reader representing an image resource.
ImageObject represents an image used in a PDF file.
ImageResource represents an existing PDF image resource.
InheritedPageAttrs represents all inherited page attributes.
No description provided by the author
LinkAnnotation represents a PDF link annotation.
MarkupAnnotation represents a PDF markup annotation.
Node is an opinionated implementation of the PDF name tree.
NUp represents the command details for the command "NUp".
OptimizationContext represents the context for the optimiziation of a PDF file.
Page represents rendered page content.
PageBoundaries represent the defined PDF page boundaries.
No description provided by the author
PDFStats is a container for stats.
PopupAnnotation represents PDF Popup annotations.
ReadContext represents the context for reading a PDF file.
No description provided by the author
No description provided by the author
SquareAnnotation represents a square annotation.
TextAnnotation represents a PDF text annotation aka "Sticky Note".
TextDescriptor contains all attributes needed for rendering a text column in PDF user space.
ViewerPreferences see 12.2 Table 147.
No description provided by the author
Watermark represents the basic structure and command details for the commands "Stamp" and "Watermark".
WriteContext represents the context for writing a PDF file.
XRefTable represents a PDF cross reference table plus stats for a PDF file.
XRefTableEntry represents an entry in the PDF cross reference table.
No description provided by the author

# Interfaces

AnnotationRenderer is the interface for PDF annotations.

# Type aliases

AnnotationFlags represents the PDF annotation flags.
AnnotationType represents the various PDF annotation types.
AnnotMap represents annotations by object number of the corresponding annotation dict.
No description provided by the author
No description provided by the author
BorderStyle (see table 168).
CommandMode specifies the operation being executed.
DestinationType represents the various PDF destination types.
No description provided by the author
FontMap maps font names to font resources.
ImageMap maps image filenames to image resources.
A series of alternating x and y coordinates in PDF user space, specifying points along the path.
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
PageResourceNames represents the required resource names for a specific page as extracted from its content streams.
No description provided by the author
See table 22 - User access permissions.
PgAnnots represents a map of page annotations by type.
No description provided by the author
Version is a type for the internal representation of PDF versions.