# Packages
No description provided by the author
No description provided by the author
Package validate implements validation against PDF 32000-1:2008.
# Functions
AddPages adds pages and corresponding resources from otherXRefTable to xRefTable.
No description provided by the author
AppendPageTree appends a pagetree d1 to page tree d2.
AppendStatsFile appends a stats line for this xRefTable to the configured csv file name.
No description provided by the author
No description provided by the author
BookletFromImages creates a booklet version of the image sequence represented by fileNames.
No description provided by the author
No description provided by the author
CIDFontDescriptor returns a font descriptor describing the CIDFont’s default metrics other than its glyph widths.
CIDFontDict returns the descendant font dict for Type0 fonts.
No description provided by the author
CIDWidths returns the value for W in a CIDFontDict.
CollectPages creates a new PDF Context for a custom PDF page sequence of the PDF represented by ctx.
CP1252ToUTF8 converts CP1252 to UTF-8.
CreateAcroFormDemoXRef creates an xRefTable with an AcroForm example.
CreateAnnotationDemoXRef creates a PDF file with examples of annotations and actions.
CreateContext creates a Context for given cross reference table and configuration.
CreateContextWithXRefTable creates a Context with an xRefTable without pages for given configuration.
CreateDemoXRef creates a minimal single page PDF file for demo purposes.
No description provided by the author
No description provided by the author
No description provided by the author
CreateResourceDictInheritanceDemoXRef creates a page tree for testing resource dict inheritance.
CreateTestPageContent draws a test grid.
No description provided by the author
DateString returns a string representation of t.
DateTime decodes s into a time.Time.
DecodeUTF16String decodes a UTF16BE string from a hex string.
No description provided by the author
DefaultBookletConfig returns the default configuration for a booklet.
DefaultImportConfig returns the default configuration.
DefaultNUpConfig returns the default NUp configuration.
DefaultWatermarkConfig returns the default configuration.
DrawGrid draws an x * y grid on r using strokeCol and fillCol.
DrawHairCross draw a haircross with origin x/y.
DrawLine draws the path from P to Q using lineWidth, strokeColor and style.
DrawLineSimple draws the path from P to Q.
DrawRect strokes a rectangular path for r using lineWidth, strokeColor and style.
DrawRectSimple strokes a rectangular path for r.
No description provided by the author
EnsureDefaultConfigAt tries to load the default configuration from path.
No description provided by the author
No description provided by the author
Escape applies all defined escape sequences to s.
FillRect fills a rectangular path for r using lineWidth, strokeCol, fillCol and style.
FillRectNoBorder fills a rectangular path for r using fillCol.
HexLiteralToString returns a possibly UTF16 encoded string for a hex string.
ImageBookletConfig returns an NUp configuration for booklet-ing image files.
ImageFileName returns true for supported image file types.
ImageFileNames returns a slice of image file names contained in dir.
ImageGridConfig returns a grid configuration for Nup-ing image files.
ImageNUpConfig returns an NUp configuration for Nup-ing image files.
No description provided by the author
IntMemberOf returns true if list contains i.
IsStringUTF16BE checks a string for Big Endian byte order BOM.
IsUTF16BE checks for Big Endian byte order mark and valid length.
KeywordsAdd adds keywords to the document info dict.
KeywordsList returns a list of keywords as recorded in the document info dict.
KeywordsRemove deletes keywords from the document info dict.
MemberOf returns true if list contains s.
MergeXRefTables merges Context ctxSource into ctxDest by appending its page tree.
No description provided by the author
NewAESConfiguration returns a default configuration for AES encryption.
NewAnnotation returns a new annotation.
NewAnnotationForRawType returns a new annotation of a specific type.
NewContext initializes a new Context.
NewDefaultConfiguration returns the default pdfcpu configuration.
NewDict returns a new PDFDict object.
NewFreeHeadXRefTableEntry returns the xref table entry for object 0 which is per definition the head of the free list (list of free objects).
NewHexLiteral creates a new HexLiteral for b..
NewIndirectRef returns a new PDFIndirectRef object.
NewIntegerArray returns a PDFArray with Integer entries.
NewLinkAnnotation returns a new link annotation.
NewMarkupAnnotation returns a new markup annotation.
NewNameArray returns a PDFArray with Name entries.
NewNumberArray returns a PDFArray with Float entries.
NewNUpPageForImage creates a new page dict in xRefTable for given image filename and n-up conf.
NewObjectStreamDict creates a new ObjectStreamDict object.
NewPage creates a page for a mediaBox.
NewPageForImage creates a new page dict in xRefTable for given image reader r.
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.
NewSimpleColor returns a SimpleColor for rgb in the form 0x00RRGGBB.
NewStreamDict creates a new PDFStreamDict for given PDFDict, stream offset and length.
NewStringArray returns a PDFArray with StringLiteral entries.
NewStringSet returns a new StringSet for slice.
NewTextAnnotation returns a new text annotation.
NewWriteContext returns a new WriteContext.
NewXRefStreamDict creates a new PDFXRefStreamDict object.
NewXRefTableEntryGen0 returns a cross reference table entry for an object with generation 0.
NormalizeCoord transfers P(x,y) from pdfcpu user space into PDF user space, which uses a coordinate system with origin in the lower left corner of r.
Normalize offset transfers x and y into offsets in the PDF user space.
NUpFromMultipleImages creates pages in NUp-style rendering each image once.
NUpFromOneImage creates one page with instances of one image.
OptimizeXRefTable optimizes an xRefTable by locating and getting rid of redundant embedded fonts and images.
No description provided by the author
ParseBox parses a box definition.
ParseBoxList parses a list of box types.
No description provided by the author
No description provided by the author
No description provided by the author
ParseImageWatermarkDetails parses an image Watermark/Stamp command string into an internal structure.
ParseImportDetails parses an Import command string into an internal structure.
ParseNUpDetails parses a NUp command string into an internal structure.
ParseNUpGridDefinition parses NUp grid dimensions into an internal structure.
ParseNUpValue parses the NUp value into an internal structure.
ParseObject parses an object from file at given offset.
No description provided by the author
ParsePageBoundaries parses a list of box definitions and assignments.
No description provided by the author
ParsePDFWatermarkDetails parses a PDF Watermark/Stamp command string into an internal structure.
No description provided by the author
No description provided by the author
No description provided by the author
ParseTextWatermarkDetails parses a text Watermark/Stamp command string into an internal structure.
PDFBookletConfig returns an NUp configuration for booklet-ing PDF files.
PDFGridConfig returns a grid configuration for Nup-ing PDF files.
PDFNUpConfig returns an NUp configuration for Nup-ing PDF files.
PDFVersion returns the PDFVersion for a version string.
Permissions returns a list of set permissions.
No description provided by the author
Read takes a readSeeker and generates a Context, an in-memory representation containing a cross reference table.
ReadFile reads in a PDF file and builds an internal structure holding its cross reference table aka the Context.
Rect returns a new rectangle for given lower left and upper right corners.
RectForArray returns a new rectangle for given Array.
RectForDim returns a new rectangle for given dimensions.
RectForFormat returns a new rectangle for given format.
RectForWidthAndHeight returns a new rectangle for given dimensions.
RenderImage returns a reader for a decoded image stream.
No description provided by the author
RotatePages rotates all selected pages by a multiple of 90 degrees.
SetFillColor sets the fill color.
SetLineJoinStyle sets the line join style for stroking operations.
SetLineWidth sets line width for stroking operations.
SetStrokeColor sets the stroke color.
No description provided by the author
StringLiteralToString returns the best possible string rep for a string literal.
Text returns a string based representation for String and Hexliterals.
TimingStats prints processing time stats for an operation.
Unescape resolves all escape sequences of s.
UTF8ToCP1252 converts UTF-8 to CP1252.
ValidationTimingStats prints processing time stats for validation.
Write generates a PDF file for the cross reference table contained in Context.
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.
WriteImage writes a PDF image object to disk.
WriteImageToDisk returns a closure for writing img to disk.
WriteIncrement writes a PDF increment..
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.
WriteReader consumes r's content by writing it to a file at path.
# 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.
These are the options for vertical aligned text.
These are the options for vertical aligned text.
These are the options for horizontal aligned text.
These are the options for horizontal aligned text.
These are the options for horizontal aligned text.
These are the options for vertical aligned text.
These are the options for horizontal aligned text.
These are the options for vertical aligned text.
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
The available commands.
These are the defined anchors for relative positioning.
These are the defined anchors for relative positioning.
These are the defined anchors for relative positioning.
PDF defines the following Color Spaces:.
PDF defines the following Color Spaces:.
default.
Options for display unit in effect.
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
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.
Supported line delimiters.
Supported line delimiters.
Supported line delimiters.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
The available commands.
FreeHeadGeneration is the predefined generation number for the head of the free list.
special case, no anchor needed, imageSize = pageSize.
Storage space terms.
No description provided by the author
PDF defines the following Color Spaces:.
The available commands.
Options for display unit in effect.
PDF defines the following Color Spaces:.
The available commands.
The available commands.
The available commands.
The available commands.
Storage space terms.
PDF defines the following Color Spaces:.
These are the defined anchors for relative positioning.
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.
Render mode.
Render mode.
Render mode.
The four corners of a rectangle.
The four corners of a rectangle.
Storage space terms.
The available commands.
The available commands.
Options for display unit in effect.
Rotation along one of 2 diagonals.
The available commands.
ObjectStreamMaxObjects limits the number of objects within an object stream written.
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.
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.
The PDF page object fields.
The PDF page object fields.
PDF defines the following Color Spaces:.
0xFFFF.
0xF0C3.
0xF8C7.
Options for display unit in effect.
No description provided by the author
These are the options for relative label positions.
These are the options for relative label positions.
These are the options for relative label positions.
These are the options for relative label positions.
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.
These are the defined anchors for relative positioning.
Render mode.
Render mode.
Render mode.
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.
StatsFileNameDefault is the standard stats filename.
These are the defined anchors for relative positioning.
These are the defined anchors for relative positioning.
These are the defined anchors for relative positioning.
The available commands.
The four corners of a rectangle.
The four corners of a rectangle.
Constants for all PDF versions up to v1.7.
Constants for all PDF versions up to v1.7.
Constants for all PDF versions up to v1.7.
Constants for all PDF versions up to v1.7.
Constants for all PDF versions up to v1.7.
Constants for all PDF versions up to v1.7.
Constants for all PDF versions up to v1.7.
Constants for all PDF versions up to v1.7.
The available commands.
ValidationNone bypasses validation.
ValidationRelaxed ensures PDF compliance based on frequently encountered validation errors.
ValidationStrict ensures 100% compliance with the spec (PDF 32000-1:2008).
No description provided by the author
Watermark mode.
Watermark mode.
Watermark mode.
# Variables
AnnotTypeStrings manages string representations for annotation types.
Some popular colors.
Some popular colors.
ConfigPath defines the location of pdfcpu's configuration directory.
Some popular colors.
No description provided by the author
ErrInvalidUTF16BE represents an error that gets raised for invalid UTF-16BE byte sequences.
No description provided by the author
Errors to be identified.
No description provided by the author
Some popular colors.
Some popular colors.
Some popular colors.
PaperSize is a map of known paper sizes in user units (=72 dpi pixels).
Some popular colors.
VersionStr is the current pdfcpu version.
Some popular colors.
# Structs
Annotation represents a PDF annnotation.
Attachment is a Reader representing a PDF attachment.
Bookmark represents an outline item tree.
Box is a rectangular region in user space expressed either explicitly via Rect or implicitly via margins applied to the containing parent box.
Configuration of a Context.
Context represents an environment for processing PDF files.
Dim represents the dimensions of a rectangular view medium like a PDF page, a sheet of paper or an image grid in user space, inches, centimetres or millimetres.
Enc wraps around all defined encryption attributes.
Font is a Reader representing an embedded font.
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.
Import represents the command details for the command "ImportImage".
IndirectRef represents a PDF indirect object.
InheritedPageAttrs represents all inherited page attributes.
LinkAnnotation represents a PDF link annotation.
MarkupAnnotation represents a PDF markup annotation.
Metadata is a Reader representing a metadata dict.
Node is an opinionated implementation of the PDF name tree.
NUp represents the command details for the command "NUp".
ObjectStreamDict represents a object stream dictionary.
OptimizationContext represents the context for the optimiziation of a PDF file.
Page represents rendered page content.
PageBoundaries represent the defined PDF page boundaries.
PDFFilter represents a PDF stream filter object.
PDFImage represents a XObject of subtype image.
PDFStats is a container for stats.
Point represents a user space location.
PopupAnnotation represents PDF Popup annotations.
QuadLiteral is a polygon with four edges and four vertices.
ReadContext represents the context for reading a PDF file.
Rectangle represents a rectangular region in userspace.
No description provided by the author
SimpleColor is a simple rgb wrapper.
StreamDict represents a PDF stream dict object.
TextAnnotation represents a PDF text annotation aka "Sticky Note".
TextDescriptor contains all attributes needed for rendering a text column in PDF user space.
Watermark represents the basic structure and command details for the commands "Stamp" and "Watermark".
WriteContext represents the context for writing a PDF file.
XRefStreamDict represents a cross reference stream dictionary.
XRefTable represents a PDF cross reference table plus stats for a PDF file.
XRefTableEntry represents an entry in the PDF cross reference table.
# Interfaces
AnnotationRenderer is the interface for PDF annotations.
Object defines an interface for all Objects.
# Type aliases
No description provided by the author
AnnotationFlags represents the PDF annotation flags.
AnnotationType represents the various PDF annotation types.
AnnotMap represents annotations by object number of the corresponding annotation dict.
Array represents a PDF array object.
Boolean represents a PDF boolean object.
ByteSize represents the various terms for storage space.
CommandMode specifies the operation being executed.
Corner represents one of four rectangle corners.
Dict represents a PDF dict object.
DisplayUnit is the metric unit used to output paper sizes.
Float represents a PDF float object.
FontMap maps font names to font resources.
HAlignment represents the horizontal alignment of text.
HexLiteral represents a PDF hex literal object.
ImageMap maps image filenames to image resources.
Integer represents a PDF integer object.
IntSet is a set of integers.
LineJoinStyle represents the shape to be used at the corners of paths that are stroked (see 8.4.3.4).
No description provided by the author
Name represents a PDF name object.
Refactor because of orientation in nup.go.
PageResourceNames represents the required resource names for a specific page as extracted from its content streams.
PgAnnots represents a map of page annotations by type.
QuadPoints is an array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
RelPosition represents the relative position of a text field's label.
RenderMode represents the text rendering mode (see 9.3.6).
StringLiteral represents a PDF string literal object.
StringSet is a set of strings.
VAlignment represents the vertical alignment of text.
Version is a type for the internal representation of PDF versions.