Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pdfcpu

package

Go to main page

Versions in this module

v1

v1.0.27

Jan 3, 2024

v1.0.26

Jun 13, 2023

v1.0.25

Feb 3, 2023

v1.0.24

Nov 28, 2022

v1.0.23

Nov 23, 2022

v1.0.22

Nov 15, 2022

v1.0.21

Oct 26, 2022

v1.0.20

Oct 21, 2022

v1.0.19

Oct 5, 2022

v1.0.18

Sep 27, 2022

v1.0.17

Sep 23, 2022

v1.0.16

Aug 24, 2022

v1.0.15

Aug 11, 2022

v1.0.14

Aug 8, 2022

v1.0.13

Jul 25, 2022

v1.0.12

Jun 14, 2022

v1.0.11

Jun 6, 2022

v1.0.10

Apr 12, 2022

v1.0.9

Apr 12, 2022

v1.0.8

Feb 28, 2022

v1.0.7

Feb 17, 2022

v1.0.6

Jan 25, 2022

v1.0.5

Jan 17, 2022

v1.0.4

Nov 26, 2021

v1.0.3

Aug 30, 2021

Changes in this version

+ const BottomCenter

+ const BottomLeft

+ const BottomRight

+ const CalGrayCS

+ const CalRGBCS

+ const Center

+ const DeviceCMYKCS

+ const DeviceGrayCS

+ const DeviceNCS

+ const DeviceRGBCS

+ const DiagonalLLToUR

+ const DiagonalULToLR

+ const DownLeft

+ const DownRight

+ const EolCR

+ const EolCRLF

+ const EolLF

+ const FreeHeadGeneration

+ const Full

+ const ICCBasedCS

+ const IndexedCS

+ const LabCS

+ const Left

+ const LeftDown

+ const NoDiagonal

+ const ObjectStreamMaxObjects

+ const PageAA

+ const PageAnnots

+ const PageArtBox

+ const PageB

+ const PageBleedBox

+ const PageBoxColorInfo

+ const PageContents

+ const PageCropBox

+ const PageDur

+ const PageGroup

+ const PageID

+ const PageLastModified

+ const PageMediaBox

+ const PageMetadata

+ const PagePZ

+ const PagePieceInfo

+ const PagePresSteps

+ const PageResources

+ const PageRotate

+ const PageSeparationInfo

+ const PageStructParents

+ const PageTabs

+ const PageTemplateInstantiated

+ const PageThumb

+ const PageTrans

+ const PageTrimBox

+ const PageUserUnit

+ const PageVP

+ const PatternCS

+ const PermissionsAll

+ const PermissionsNone

+ const Right

+ const RightDown

+ const RootAA

+ const RootAcroForm

+ const RootCollection

+ const RootDests

+ const RootExtensions

+ const RootLang

+ const RootLegal

+ const RootMarkInfo

+ const RootMetadata

+ const RootNames

+ const RootNeedsRendering

+ const RootOCProperties

+ const RootOpenAction

+ const RootOutlines

+ const RootOutputIntents

+ const RootPageLabels

+ const RootPageLayout

+ const RootPageMode

+ const RootPerms

+ const RootPieceInfo

+ const RootRequirements

+ const RootSpiderInfo

+ const RootStructTreeRoot

+ const RootThreads

+ const RootURI

+ const RootVersion

+ const RootViewerPrefs

+ const SeparationCS

+ const StatsFileNameDefault

+ const TopCenter

+ const TopLeft

+ const TopRight

+ const ValidationNone

+ const ValidationRelaxed

+ const ValidationStrict

+ const WMImage

+ const WMPDF

+ const WMText

+ var AnnotTypeStrings = map[AnnotationType]string

+ var Black = SimpleColor

+ var Blue = SimpleColor

+ var ConfigPath string = "default"

+ var ErrInvalidUTF16BE = errors.New("pdfcpu: invalid UTF-16BE detected")

+ var ErrUnsupported16BPC = errors.New("unsupported 16 bits per component")

+ var Gray = SimpleColor

+ var Green = SimpleColor

+ var LightGray = SimpleColor

+ var PaperSize = map[string]*Dim

+ var Red = SimpleColor

+ var VersionStr = "v0.3.12 dev"

+ var White = SimpleColor

+ func AddPages(ctx, ctxDest *Context, pages []int, usePgCache bool) error

+ func AppendPageTree(d1 *IndirectRef, countd1 int, d2 Dict) error

+ func AppendStatsFile(ctx *Context) error

+ func BookletFromImages(ctx *Context, fileNames []string, nup *NUp, pagesDict Dict, ...) error

+ func CP1252ToUTF8(s string) string

+ func CreateTestPageContent(p Page)

+ func DateString(t time.Time) string

+ func DateTime(s string, relaxed bool) (time.Time, bool)

+ func DecodeUTF16String(s string) (string, error)

+ func DrawAndFillRect(w io.Writer, r *Rectangle)

+ func DrawGrid(w io.Writer, x, y int, r *Rectangle, strokeCol SimpleColor, ...)

+ func DrawHairCross(w io.Writer, x, y float64, r *Rectangle)

+ func DrawLine(w io.Writer, xp, yp, xq, yq float64)

+ func DrawRect(w io.Writer, r *Rectangle)

+ func EnsureDefaultConfigAt(path string) error

+ func Escape(s string) (*string, error)

+ func FillRect(w io.Writer, rect *Rectangle, c SimpleColor)

+ func FillRectStacked(w io.Writer, r *Rectangle, c SimpleColor)

+ func HexLiteralToString(hl HexLiteral) (string, error)

+ func ImageFileName(fileName string) bool

+ func ImageFileNames(dir string) ([]string, error)

+ func IntMemberOf(i int, list []int) bool

+ func IsStringUTF16BE(s string) bool

+ func IsUTF16BE(b []byte) bool

+ func KeywordsAdd(xRefTable *XRefTable, keywords []string) error

+ func KeywordsList(xRefTable *XRefTable) ([]string, error)

+ func KeywordsRemove(xRefTable *XRefTable, keywords []string) (bool, error)

+ func MemberOf(s string, list []string) bool

+ func MergeXRefTables(ctxSource, ctxDest *Context) (err error)

+ func NUpFromMultipleImages(ctx *Context, fileNames []string, nup *NUp, pagesDict Dict, ...) error

+ func NUpFromOneImage(ctx *Context, fileName string, nup *NUp, pagesDict Dict, ...) error

+ func OptimizeXRefTable(ctx *Context) error

+ func ParseNUpDetails(s string, nup *NUp) error

+ func ParseNUpGridDefinition(rows, cols int, nUp *NUp) error

+ func ParseNUpValue(n int, nUp *NUp) error

+ func Permissions(ctx *Context) (list []string)

+ func PropertiesAdd(xRefTable *XRefTable, properties map[string]string) error

+ func PropertiesList(xRefTable *XRefTable) ([]string, error)

+ func PropertiesRemove(xRefTable *XRefTable, properties []string) (bool, error)

+ func RenderImage(xRefTable *XRefTable, sd *StreamDict, thumb bool, resourceName string, ...) (io.Reader, string, error)

+ func RotatePages(ctx *Context, selectedPages IntSet, rotation int) error

+ func SetFillColor(w io.Writer, c SimpleColor)

+ func SetLineJoinStyle(w io.Writer, s LineJoinStyle)

+ func SetLineWidth(w io.Writer, width float64)

+ func SetStrokeColor(w io.Writer, c SimpleColor)

+ func StringLiteralToString(sl StringLiteral) (string, error)

+ func Text(o Object) (string, error)

+ func TimingStats(op string, durRead, durVal, durOpt, durWrite, durTotal float64)

+ func UTF8ToCP1252(s string) string

+ func Unescape(s string) ([]byte, error)

+ func ValidationTimingStats(dur1, dur2, dur float64)

+ func Write(ctx *Context) (err error)

+ func WriteImage(xRefTable *XRefTable, fileName string, sd *StreamDict, thumb bool, objNr int) (string, error)

+ func WriteImageToDisk(outDir, fileName string) func(Image, bool, int) error

+ func WriteIncrement(ctx *Context) error

+ func WriteReader(path string, r io.Reader) error

+ type AnnotMap map[string]AnnotationRenderer

+ type Annotation struct

+ C *SimpleColor

+ Contents string

+ F AnnotationFlags

+ ModDate string

+ NM string

+ P *IndirectRef

+ Rect Rectangle

+ SubType AnnotationType

+ func NewAnnotation(typ AnnotationType, rect Rectangle, contents string, pageIndRef *IndirectRef, ...) Annotation

+ func NewAnnotationForRawType(typ string, rect Rectangle, contents string, pageIndRef *IndirectRef, ...) Annotation

+ func (ann Annotation) ContentString() string

+ func (ann Annotation) ID() string

+ func (ann Annotation) RectString() string

+ func (ann Annotation) RenderDict(pageIndRef IndirectRef) Dict

+ func (ann Annotation) Type() AnnotationType

+ func (ann Annotation) TypeString() string

+ type AnnotationFlags int

+ const AnnHidden

+ const AnnInvisible

+ const AnnLocked

+ const AnnLockedContents

+ const AnnNoRotate

+ const AnnNoView

+ const AnnNoZoom

+ const AnnPrint

+ const AnnReadOnly

+ const AnnToggleNoView

+ type AnnotationRenderer interface

+ ContentString func() string

+ ID func() string

+ RectString func() string

+ RenderDict func(pageIndRef IndirectRef) Dict

+ Type func() AnnotationType

+ type AnnotationType int

+ const Ann3D

+ const AnnCaret

+ const AnnCircle

+ const AnnFileAttachment

+ const AnnFreeText

+ const AnnHighLight

+ const AnnInk

+ const AnnLine

+ const AnnLink

+ const AnnMovie

+ const AnnPolyLine

+ const AnnPolygon

+ const AnnPopup

+ const AnnPrinterMark

+ const AnnRedact

+ const AnnScreen

+ const AnnSound

+ const AnnSquare

+ const AnnSquiggly

+ const AnnStamp

+ const AnnStrikeOut

+ const AnnText

+ const AnnTrapNet

+ const AnnUnderline

+ const AnnWatermark

+ const AnnWidget

+ type Array []Object

+ func CIDWidths(ttf font.TTFLight) Array

+ func NewIntegerArray(fVars ...int) Array

+ func NewNameArray(sVars ...string) Array

+ func NewNumberArray(fVars ...float64) Array

+ func NewStringArray(sVars ...string) Array

+ func (a Array) Clone() Object

+ func (a Array) FloatNumber(ind int) (float64, error)

+ func (a Array) PDFString() string

+ func (a Array) String() string

+ type Attachment struct

+ Desc string

+ FileName string

+ ID string

+ ModTime *time.Time

+ func (a Attachment) String() string

+ type Bookmark struct

+ Bold bool

+ Children []Bookmark

+ Color *SimpleColor

+ Italic bool

+ PageFrom int

+ PageThru int

+ Parent *Bookmark

+ Title string

+ func (bm Bookmark) Style() int

+ type Boolean bool

+ func (boolean Boolean) Clone() Object

+ func (boolean Boolean) PDFString() string

+ func (boolean Boolean) String() string

+ func (boolean Boolean) Value() bool

+ type Box struct

+ Dim *Dim

+ Dx int

+ Dy int

+ Inherited bool

+ MBot float64

+ MLeft float64

+ MRight float64

+ MTop float64

+ Pos anchor

+ Rect *Rectangle

+ RefBox string

+ func ParseBox(s string, u DisplayUnit) (*Box, error)

+ type ByteSize float64

+ const GB

+ const KB

+ const MB

+ func (b ByteSize) String() string

+ type CommandMode int

+ const ADDANNOTATIONS

+ const ADDATTACHMENTS

+ const ADDATTACHMENTSPORTFOLIO

+ const ADDBOOKMARKS

+ const ADDBOXES

+ const ADDKEYWORDS

+ const ADDPROPERTIES

+ const ADDWATERMARKS

+ const BOOKLET

+ const CHANGEOPW

+ const CHANGEUPW

+ const CHEATSHEETSFONTS

+ const COLLECT

+ const CROP

+ const DECRYPT

+ const ENCRYPT

+ const EXTRACTATTACHMENTS

+ const EXTRACTCONTENT

+ const EXTRACTFONTS

+ const EXTRACTIMAGES

+ const EXTRACTMETADATA

+ const EXTRACTPAGES

+ const IMPORTIMAGES

+ const INFO

+ const INSERTPAGESAFTER

+ const INSERTPAGESBEFORE

+ const INSTALLFONTS

+ const LISTANNOTATIONS

+ const LISTATTACHMENTS

+ const LISTBOXES

+ const LISTFONTS

+ const LISTIMAGES

+ const LISTKEYWORDS

+ const LISTPERMISSIONS

+ const LISTPROPERTIES

+ const MERGEAPPEND

+ const MERGECREATE

+ const NUP

+ const OPTIMIZE

+ const REMOVEANNOTATIONS

+ const REMOVEATTACHMENTS

+ const REMOVEBOXES

+ const REMOVEKEYWORDS

+ const REMOVEPAGES

+ const REMOVEPROPERTIES

+ const REMOVEWATERMARKS

+ const ROTATE

+ const SETPERMISSIONS

+ const SPLIT

+ const TRIM

+ const VALIDATE

+ type Configuration struct

+ Cmd CommandMode

+ CollectStats bool

+ DecodeAllStreams bool

+ EncryptKeyLength int

+ EncryptUsingAES bool

+ Eol string

+ OwnerPW string

+ OwnerPWNew *string

+ Path string

+ Permissions int16

+ Reader15 bool

+ StatsFileName string

+ Unit DisplayUnit

+ UserPW string

+ UserPWNew *string

+ ValidateLinks bool

+ ValidationMode int

+ WriteObjectStream bool

+ WriteXRefStream bool

+ func NewAESConfiguration(userPW, ownerPW string, keyLength int) *Configuration

+ func NewDefaultConfiguration() *Configuration

+ func NewRC4Configuration(userPW, ownerPW string, keyLength int) *Configuration

+ func (c *Configuration) ApplyReducedFeatureSet() bool

+ func (c *Configuration) EolString() string

+ func (c *Configuration) UnitString() string

+ func (c *Configuration) ValidationModeString() string

+ func (c Configuration) String() string

+ type Context struct

+ Optimize *OptimizationContext

+ Read *ReadContext

+ Write *WriteContext

+ func CollectPages(ctx *Context, collectedPages []int) (*Context, error)

+ func CreateContext(xRefTable *XRefTable, conf *Configuration) *Context

+ func CreateContextWithXRefTable(conf *Configuration, pageDim *Dim) (*Context, error)

+ func NewContext(rs io.ReadSeeker, conf *Configuration) (*Context, error)

+ func Read(rs io.ReadSeeker, conf *Configuration) (*Context, error)

+ func ReadFile(inFile string, conf *Configuration) (*Context, error)

+ func (ctx *Context) AddAnnotation(pageDictIndRef *IndirectRef, pageDict Dict, pageNr int, ar AnnotationRenderer, ...) (bool, error)

+ func (ctx *Context) AddAnnotations(selectedPages IntSet, ar AnnotationRenderer, incr bool) (bool, error)

+ func (ctx *Context) AddAnnotationsMap(m map[int][]AnnotationRenderer, incr bool) (bool, error)

+ func (ctx *Context) AddAttachment(a Attachment, useCollection bool) error

+ func (ctx *Context) AddBookmarks(bms []Bookmark) error

+ func (ctx *Context) AddPageBoundaries(selectedPages IntSet, pb *PageBoundaries) error

+ func (ctx *Context) AddWatermarks(selectedPages IntSet, wm *Watermark) error

+ func (ctx *Context) AddWatermarksMap(m map[int]*Watermark) error

+ func (ctx *Context) AddWatermarksSliceMap(m map[int][]*Watermark) error

+ func (ctx *Context) AnnotationObjNrs() ([]int, error)

+ func (ctx *Context) BookletFromPDF(selectedPages IntSet, nup *NUp) error

+ func (ctx *Context) BookmarksForOutline() ([]Bookmark, error)

+ func (ctx *Context) BookmarksForOutlineItem(item *IndirectRef, parent *Bookmark) ([]Bookmark, error)

+ func (ctx *Context) ColorSpaceString(sd *StreamDict) (string, error)

+ func (ctx *Context) Crop(selectedPages IntSet, b *Box) error

+ func (ctx *Context) DetectPageTreeWatermarks() error

+ func (ctx *Context) DetectWatermarks() error

+ func (ctx *Context) ExtractAttachment(a Attachment) (*Attachment, error)

+ func (ctx *Context) ExtractAttachments(ids []string) ([]Attachment, error)

+ func (ctx *Context) ExtractFont(objNr int) (*Font, error)

+ func (ctx *Context) ExtractImage(sd *StreamDict, thumb bool, resourceId string, objNr int, stub bool) (*Image, error)

+ func (ctx *Context) ExtractMetadata() ([]Metadata, error)

+ func (ctx *Context) ExtractPage(pageNr int) (*Context, error)

+ func (ctx *Context) ExtractPageContent(pageNr int) (io.Reader, error)

+ func (ctx *Context) ExtractPageFonts(pageNr int) ([]Font, error)

+ func (ctx *Context) ExtractPageImages(pageNr int, stub bool) ([]Image, error)

+ func (ctx *Context) ExtractPages(pageNrs []int, usePgCache bool) (*Context, error)

+ func (ctx *Context) FontObjNrs(pageNr int) []int

+ func (ctx *Context) ImageObjNrs(pageNr int) []int

+ func (ctx *Context) InfoDigest(selectedPages IntSet) ([]string, error)

+ func (ctx *Context) ListAttachments() ([]Attachment, error)

+ func (ctx *Context) ListImages(selectedPages IntSet) ([]string, error)

+ func (ctx *Context) ListPageBoundaries(selectedPages IntSet, wantPB *PageBoundaries) ([]string, error)

+ func (ctx *Context) NUpFromPDF(selectedPages IntSet, nup *NUp) error

+ func (ctx *Context) PageObjFromDestinationArray(dest Object) (*IndirectRef, error)

+ func (ctx *Context) RemoveAnnotations(selectedPages IntSet, ids []string, objNrs []int, incr bool) (bool, error)

+ func (ctx *Context) RemoveAnnotationsFromPageDict(ids []string, objNrSet IntSet, pageDict Dict, pageDictObjNr, pageNr int, ...) (bool, error)

+ func (ctx *Context) RemoveAttachment(a Attachment) (bool, error)

+ func (ctx *Context) RemoveAttachments(ids []string) (bool, error)

+ func (ctx *Context) RemovePageBoundaries(selectedPages IntSet, pb *PageBoundaries) error

+ func (ctx *Context) RemoveWatermarks(selectedPages IntSet) error

+ func (ctx *Context) ResetWriteContext()

+ func (ctx *Context) SearchEmbeddedFilesNameTreeNodeByContent(s string) (*string, Object, error)

+ func (ctx *Context) StreamLength(sd *StreamDict) (int64, error)

+ func (ctx *Context) String() string

+ type Dict map[string]Object

+ func NewDict() Dict

+ func (d *Dict) Increment(key string) error

+ func (d *Dict) IncrementBy(key string, i int) error

+ func (d Dict) ArrayEntry(key string) Array

+ func (d Dict) BooleanEntry(key string) *bool

+ func (d Dict) Clone() Object

+ func (d Dict) Delete(key string) (value Object)

+ func (d Dict) DictEntry(key string) Dict

+ func (d Dict) Entry(dictName, key string, required bool) (Object, error)

+ func (d Dict) Find(key string) (value Object, found bool)

+ func (d Dict) First() *int

+ func (d Dict) HexLiteralEntry(key string) *HexLiteral

+ func (d Dict) Index() Array

+ func (d Dict) IndirectRefEntry(key string) *IndirectRef

+ func (d Dict) Insert(key string, value Object) (ok bool)

+ func (d Dict) InsertFloat(key string, value float32)

+ func (d Dict) InsertInt(key string, value int)

+ func (d Dict) InsertName(key, value string)

+ func (d Dict) InsertString(key, value string)

+ func (d Dict) Int64Entry(key string) *int64

+ func (d Dict) IntEntry(key string) *int

+ func (d Dict) IsLinearizationParmDict() bool

+ func (d Dict) IsObjStm() bool

+ func (d Dict) Len() int

+ func (d Dict) Length() (*int64, *int)

+ func (d Dict) N() *int

+ func (d Dict) NameEntry(key string) *string

+ func (d Dict) PDFString() string

+ func (d Dict) Prev() *int64

+ func (d Dict) Size() *int

+ func (d Dict) StreamDictEntry(key string) *StreamDict

+ func (d Dict) String() string

+ func (d Dict) StringEntry(key string) *string

+ func (d Dict) StringEntryBytes(key string) ([]byte, error)

+ func (d Dict) StringLiteralEntry(key string) *StringLiteral

+ func (d Dict) Subtype() *string

+ func (d Dict) Type() *string

+ func (d Dict) Update(key string, value Object)

+ func (d Dict) W() Array

+ type Dim struct

+ Height float64

+ Width float64

+ func (d Dim) AspectRatio() float64

+ func (d Dim) Landscape() bool

+ func (d Dim) Portrait() bool

+ func (d Dim) String() string

+ func (d Dim) ToCentimetres() Dim

+ func (d Dim) ToInches() Dim

+ func (d Dim) ToMillimetres() Dim

+ type DisplayUnit int

+ const CENTIMETRES

+ const INCHES

+ const MILLIMETRES

+ const POINTS

+ type Enc struct

+ Emd bool

+ ID []byte

+ L int

+ O []byte

+ OE []byte

+ P int

+ Perms []byte

+ R int

+ U []byte

+ UE []byte

+ V int

+ type Float float64

+ func (f Float) Clone() Object

+ func (f Float) PDFString() string

+ func (f Float) String() string

+ func (f Float) Value() float64

+ type Font struct

+ Name string

+ Type string

+ type FontMap map[string]string

+ func (fm FontMap) EnsureKey(fontName string) string

+ type FontObject struct

+ Data []byte

+ Extension string

+ FontDict Dict

+ FontName string

+ Prefix string

+ ResourceNames []string

+ func (fo *FontObject) AddResourceName(resourceName string)

+ func (fo FontObject) Embedded() (embedded bool)

+ func (fo FontObject) Encoding() string

+ func (fo FontObject) ResourceNamesString() string

+ func (fo FontObject) String() string

+ func (fo FontObject) SubType() string

+ type HAlignment int

+ const AlignCenter

+ const AlignJustify

+ const AlignLeft

+ const AlignRight

+ type HexLiteral string

+ func NewHexLiteral(b []byte) HexLiteral

+ func (hexliteral HexLiteral) Bytes() ([]byte, error)

+ func (hexliteral HexLiteral) Clone() Object

+ func (hexliteral HexLiteral) PDFString() string

+ func (hexliteral HexLiteral) String() string

+ func (hexliteral HexLiteral) Value() string

+ type Image struct

+ FileType string

+ Name string

+ type ImageObject struct

+ ImageDict *StreamDict

+ ResourceNames []string

+ func (io *ImageObject) AddResourceName(resourceName string)

+ func (io ImageObject) ResourceNamesString() string

+ type Import struct

+ BgColor *SimpleColor

+ DPI int

+ Dx int

+ Dy int

+ Gray bool

+ InpUnit DisplayUnit

+ PageDim *Dim

+ PageSize string

+ Pos anchor

+ Scale float64

+ ScaleAbs bool

+ Sepia bool

+ UserDim bool

+ func DefaultImportConfig() *Import

+ func ParseImportDetails(s string, u DisplayUnit) (*Import, error)

+ func (imp Import) String() string

+ type IndirectRef struct

+ GenerationNumber Integer

+ ObjectNumber Integer

+ func CIDFontDescriptor(xRefTable *XRefTable, ttf font.TTFLight, fontName, baseFontName string) (*IndirectRef, error)

+ func CIDFontDict(xRefTable *XRefTable, ttf font.TTFLight, fontName, baseFontName string) (*IndirectRef, error)

+ func NewIndirectRef(objectNumber, generationNumber int) *IndirectRef

+ func NewNUpPageForImage(xRefTable *XRefTable, fileName string, parentIndRef *IndirectRef, nup *NUp) (*IndirectRef, error)

+ func NewPageForImage(xRefTable *XRefTable, r io.Reader, parentIndRef *IndirectRef, imp *Import) (*IndirectRef, error)

+ func (ir IndirectRef) Clone() Object

+ func (ir IndirectRef) Equals(indRef IndirectRef) bool

+ func (ir IndirectRef) PDFString() string

+ func (ir IndirectRef) String() string

+ type InheritedPageAttrs struct

+ type IntSet map[int]bool

+ type Integer int

+ func (i Integer) Clone() Object

+ func (i Integer) PDFString() string

+ func (i Integer) String() string

+ func (i Integer) Value() int

+ type LineJoinStyle int

+ const LJBevel

+ const LJMiter

+ const LJRound

+ type LinkAnnotation struct

+ Quad QuadPoints

+ URI string

+ func NewLinkAnnotation(rect Rectangle, quad QuadPoints, uri, id string, f AnnotationFlags, ...) LinkAnnotation

+ func (ann LinkAnnotation) ContentString() string

+ func (ann LinkAnnotation) RenderDict(pageIndRef IndirectRef) Dict

+ type MarkupAnnotation struct

+ CA *float64

+ CreationDate string

+ PopupIndRef *IndirectRef

+ RC string

+ Subj string

+ T string

+ func NewMarkupAnnotation(subType AnnotationType, rect Rectangle, pageIndRef *IndirectRef, ...) MarkupAnnotation

+ type Metadata struct

+ ObjNr int

+ ParentObjNr int

+ ParentType string

+ type NUp struct

+ BgColor *SimpleColor

+ BookletGuides bool

+ Border bool

+ FolioSize int

+ Grid *Dim

+ ImgInputFile bool

+ InpUnit DisplayUnit

+ Margin int

+ MultiFolio bool

+ Orient orientation

+ PageDim *Dim

+ PageGrid bool

+ PageSize string

+ UserDim bool

+ func DefaultBookletConfig() *NUp

+ func DefaultNUpConfig() *NUp

+ func ImageBookletConfig(val int, desc string) (*NUp, error)

+ func ImageGridConfig(rows, cols int, desc string) (*NUp, error)

+ func ImageNUpConfig(val int, desc string) (*NUp, error)

+ func PDFBookletConfig(val int, desc string) (*NUp, error)

+ func PDFGridConfig(rows, cols int, desc string) (*NUp, error)

+ func PDFNUpConfig(val int, desc string) (*NUp, error)

+ func (nup NUp) N() int

+ func (nup NUp) String() string

+ type Name string

+ func (nameObject Name) Clone() Object

+ func (nameObject Name) PDFString() string

+ func (nameObject Name) String() string

+ func (nameObject Name) Value() string

+ type Node struct

+ D Dict

+ Kids []*Node

+ Kmax string

+ Kmin string

+ Names []entry

+ func (n *Node) Add(xRefTable *XRefTable, k string, v Object) error

+ func (n *Node) AddToLeaf(k string, v Object)

+ func (n *Node) HandleLeaf(xRefTable *XRefTable, k string, v Object) error

+ func (n *Node) Remove(xRefTable *XRefTable, k string) (empty, ok bool, err error)

+ func (n Node) KeyList() ([]string, error)

+ func (n Node) Process(xRefTable *XRefTable, handler func(*XRefTable, string, Object) error) error

+ func (n Node) String() string

+ func (n Node) Value(k string) (Object, bool)

+ type Object interface

+ Clone func() Object

+ PDFString func() string

+ func ParseObject(ctx *Context, offset int64, objNr, genNr int) (Object, error)

+ type ObjectStreamDict struct

+ FirstObjOffset int

+ ObjArray Array

+ ObjCount int

+ Prolog []byte

+ func NewObjectStreamDict() *ObjectStreamDict

+ func (osd *ObjectStreamDict) AddObject(objNumber int, entry *XRefTableEntry) error

+ func (osd *ObjectStreamDict) Finalize()

+ func (osd *ObjectStreamDict) IndexedObject(index int) (Object, error)

+ type OptimizationContext struct

+ Cache map[int]bool

+ DuplicateFontObjs IntSet

+ DuplicateFonts map[int]Dict

+ DuplicateImageObjs IntSet

+ DuplicateImages map[int]*StreamDict

+ DuplicateInfoObjects IntSet

+ FontObjects map[int]*FontObject

+ Fonts map[string][]int

+ ImageObjects map[int]*ImageObject

+ NonReferencedObjs []int

+ NullObjNr *int

+ PageFonts []IntSet

+ PageImages []IntSet

+ func (oc *OptimizationContext) DuplicateFontObjectsString() (int, string)

+ func (oc *OptimizationContext) DuplicateImageObjectsString() (int, string)

+ func (oc *OptimizationContext) DuplicateInfoObjectsString() (int, string)

+ func (oc *OptimizationContext) IsDuplicateFontObject(i int) bool

+ func (oc *OptimizationContext) IsDuplicateImageObject(i int) bool

+ func (oc *OptimizationContext) IsDuplicateInfoObject(i int) bool

+ func (oc *OptimizationContext) NonReferencedObjsString() (int, string)

+ type PDFFilter struct

+ DecodeParms Dict

+ Name string

+ type PDFImage struct

+ type PDFStats struct

+ func NewPDFStats() PDFStats

+ func (stats PDFStats) AddPageAttr(name int)

+ func (stats PDFStats) AddRootAttr(name int)

+ func (stats PDFStats) UsesPageAttr(name int) bool

+ func (stats PDFStats) UsesRootAttr(name int) bool

+ type Page struct

+ Buf *bytes.Buffer

+ Fm FontMap

+ MediaBox *Rectangle

+ func NewPage(mediaBox *Rectangle) Page

+ func NewPageWithBg(mediaBox *Rectangle, c SimpleColor) Page

+ type PageBoundaries struct

+ Art *Box

+ Bleed *Box

+ Crop *Box

+ Media *Box

+ Rot int

+ Trim *Box

+ func ParseBoxList(s string) (*PageBoundaries, error)

+ func ParsePageBoundaries(s string, unit DisplayUnit) (*PageBoundaries, error)

+ func (pb *PageBoundaries) ResolveBox(s string) error

+ func (pb *PageBoundaries) SelectAll()

+ func (pb PageBoundaries) ArtBox() *Rectangle

+ func (pb PageBoundaries) BleedBox() *Rectangle

+ func (pb PageBoundaries) CropBox() *Rectangle

+ func (pb PageBoundaries) MediaBox() *Rectangle

+ func (pb PageBoundaries) String() string

+ func (pb PageBoundaries) TrimBox() *Rectangle

+ type PageResourceNames map[string]StringSet

+ func NewPageResourceNames() PageResourceNames

+ func (prn PageResourceNames) HasContent() bool

+ func (prn PageResourceNames) HasResources(s string) bool

+ func (prn PageResourceNames) Resources(s string) StringSet

+ func (prn PageResourceNames) String() string

+ type PgAnnots map[AnnotationType]AnnotMap

+ type Point struct

+ X float64

+ Y float64

+ type PopupAnnotation struct

+ Open bool

+ ParentIndRef *IndirectRef

+ func NewPopupAnnotation(rect Rectangle, pageIndRef *IndirectRef, contents, id string, ...) PopupAnnotation

+ func (ann PopupAnnotation) ContentString() string

+ type QuadLiteral struct

+ P1 Point

+ P2 Point

+ P3 Point

+ P4 Point

+ func (ql QuadLiteral) Array() Array

+ func (ql QuadLiteral) EnclosingRectangle(f float64) *Rectangle

+ type QuadPoints []QuadLiteral

+ func (qp *QuadPoints) AddQuadLiteral(ql QuadLiteral)

+ func (qp *QuadPoints) Array() Array

+ type ReadContext struct

+ BinaryFontDuplSize int64

+ BinaryFontSize int64

+ BinaryImageDuplSize int64

+ BinaryImageSize int64

+ BinaryTotalSize int64

+ EolCount int

+ FileName string

+ FileSize int64

+ Hybrid bool

+ Linearized bool

+ ObjectStreams IntSet

+ UsingObjectStreams bool

+ UsingXRefStreams bool

+ XRefStreams IntSet

+ func (rc *ReadContext) IsObjectStreamObject(i int) bool

+ func (rc *ReadContext) IsXRefStreamObject(i int) bool

+ func (rc *ReadContext) LogStats(optimized bool)

+ func (rc *ReadContext) ObjectStreamsString() (int, string)

+ func (rc *ReadContext) ReadFileSize() int

+ func (rc *ReadContext) XRefStreamsString() (int, string)

+ type Rectangle struct

+ func Rect(llx, lly, urx, ury float64) *Rectangle

+ func RectForArray(a Array) (*Rectangle, error)

+ func RectForDim(width, height float64) *Rectangle

+ func RectForFormat(f string) *Rectangle

+ func RectForWidthAndHeight(llx, lly, width, height float64) *Rectangle

+ func WriteColumn(w io.Writer, mediaBox, region *Rectangle, td TextDescriptor, width float64) *Rectangle

+ func WriteColumnAnchored(w io.Writer, mediaBox, region *Rectangle, td TextDescriptor, a anchor, ...) *Rectangle

+ func WriteMultiLine(w io.Writer, mediaBox, region *Rectangle, td TextDescriptor) *Rectangle

+ func WriteMultiLineAnchored(w io.Writer, mediaBox, region *Rectangle, td TextDescriptor, a anchor) *Rectangle

+ func (r *Rectangle) Translate(dx, dy float64)

+ func (r Rectangle) Array() Array

+ func (r Rectangle) CroppedCopy(margin float64) *Rectangle

+ func (r Rectangle) Dimensions() Dim

+ func (r Rectangle) FitsWithin(r2 *Rectangle) bool

+ func (r Rectangle) Format(unit DisplayUnit) string

+ func (r Rectangle) ScaledHeight(w float64) float64

+ func (r Rectangle) ScaledWidth(h float64) float64

+ type RenderMode int

+ const RMFill

+ const RMFillAndStroke

+ const RMStroke

+ type SimpleColor struct

+ B float32

+ G float32

+ R float32

+ func NewSimpleColor(rgb uint32) SimpleColor

+ func (sc SimpleColor) String() string

+ type StreamDict struct

+ Content []byte

+ FilterPipeline []PDFFilter

+ IsPageContent bool

+ Raw []byte

+ StreamLength *int64

+ StreamLengthObjNr *int

+ StreamOffset int64

+ func NewStreamDict(d Dict, streamOffset int64, streamLength *int64, streamLengthObjNr *int, ...) StreamDict

+ func (sd *StreamDict) Decode() error

+ func (sd *StreamDict) Encode() error

+ func (sd StreamDict) Clone() Object

+ func (sd StreamDict) HasSoleFilterNamed(filterName string) bool

+ func (sd StreamDict) Image() bool

+ type StringLiteral string

+ func (stringliteral StringLiteral) Clone() Object

+ func (stringliteral StringLiteral) PDFString() string

+ func (stringliteral StringLiteral) String() string

+ func (stringliteral StringLiteral) Value() string

+ type StringSet map[string]bool

+ func NewStringSet(slice []string) StringSet

+ type TextAnnotation struct

+ Name string

+ Open bool

+ func NewTextAnnotation(rect Rectangle, contents, id, title string, f AnnotationFlags, ...) TextAnnotation

+ func (ann TextAnnotation) RenderDict(pageIndRef IndirectRef) Dict

+ type TextDescriptor struct

+ BackgroundCol SimpleColor

+ BorderCol SimpleColor

+ BorderStyle LineJoinStyle

+ BorderWidth float64

+ Dx float64

+ Dy float64

+ FillCol SimpleColor

+ FontKey string

+ FontName string

+ FontSize int

+ HAlign HAlignment

+ HairCross bool

+ MBot float64

+ MLeft float64

+ MRight float64

+ MTop float64

+ MinHeight float64

+ ParIndent bool

+ RMode RenderMode

+ RTL bool

+ Rotation float64

+ Scale float64

+ ScaleAbs bool

+ ShowBackground bool

+ ShowBorder bool

+ ShowLineBB bool

+ ShowMargins bool

+ ShowTextBB bool

+ StrokeCol SimpleColor

+ Text string

+ VAlign VAlignment

+ X float64

+ Y float64

+ type VAlignment int

+ const AlignBaseline

+ const AlignBottom

+ const AlignMiddle

+ const AlignTop

+ type Version int

+ const V10

+ const V11

+ const V12

+ const V13

+ const V14

+ const V15

+ const V16

+ const V17

+ func PDFVersion(versionStr string) (Version, error)

+ func (v Version) String() string

+ type Watermark struct

+ BgColor *SimpleColor

+ BorderColor *SimpleColor

+ BorderStyle LineJoinStyle

+ BorderWidth int

+ Color SimpleColor

+ Diagonal int

+ Dx int

+ Dy int

+ FileName string

+ FillColor SimpleColor

+ FontName string

+ FontSize int

+ HAlign *HAlignment

+ Image io.Reader

+ InpUnit DisplayUnit

+ MBot int

+ MLeft int

+ MRight int

+ MTop int

+ Mode int

+ OnTop bool

+ Opacity float64

+ Page int

+ Pos anchor

+ RTL bool

+ RenderMode RenderMode

+ Rotation float64

+ Scale float64

+ ScaleAbs bool

+ ScaleEff float64

+ ScaledFontSize int

+ StrokeColor SimpleColor

+ TextLines []string

+ TextString string

+ URL string

+ Update bool

+ UserRotOrDiagonal bool

+ func DefaultWatermarkConfig() *Watermark

+ func ParseImageWatermarkDetails(fileName, desc string, onTop bool, u DisplayUnit) (*Watermark, error)

+ func ParsePDFWatermarkDetails(fileName, desc string, onTop bool, u DisplayUnit) (*Watermark, error)

+ func ParseTextWatermarkDetails(text, desc string, onTop bool, u DisplayUnit) (*Watermark, error)

+ func (wm Watermark) OnTopString() string

+ func (wm Watermark) String() string

+ type WriteContext struct

+ BinaryFontSize int64

+ BinaryImageSize int64

+ BinaryTotalSize int64

+ CurrentObjStream *int

+ DirName string

+ Eol string

+ FileName string

+ FileSize int64

+ Fp *os.File

+ Increment bool

+ ObjNrs []int

+ Offset int64

+ OffsetPrevXRef *int64

+ SelectedPages IntSet

+ Table map[int]int64

+ WriteToObjectStream bool

+ func NewWriteContext(eol string) *WriteContext

+ func (wc *WriteContext) HasWriteOffset(objNumber int) bool

+ func (wc *WriteContext) IncrementWithObjNr(i int)

+ func (wc *WriteContext) LogStats()

+ func (wc *WriteContext) SetWriteOffset(objNumber int)

+ func (wc *WriteContext) WriteEol() error

+ type XRefStreamDict struct

+ Objects []int

+ PreviousOffset *int64

+ Size int

+ W [3]int

+ func NewXRefStreamDict(ctx *Context) *XRefStreamDict

+ type XRefTable struct

+ AES4EmbeddedStreams bool

+ AES4Streams bool

+ AES4Strings bool

+ AdditionalStreams *Array

+ Author string

+ CreationDate string

+ Creator string

+ CurObj int

+ CurPage int

+ E *Enc

+ EncKey []byte

+ Encrypt *IndirectRef

+ HeaderVersion *Version

+ ID Array

+ Info *IndirectRef

+ Keywords string

+ LinearizationObjs IntSet

+ ModDate string

+ Names map[string]*Node

+ OffsetOverflowHintTable *int64

+ OffsetPrimaryHintTable *int64

+ Optimized bool

+ PageAnnots map[int]PgAnnots

+ PageCount int

+ PageThumbs map[int]IndirectRef

+ Producer string

+ Properties map[string]string

+ Root *IndirectRef

+ RootDict Dict

+ RootVersion *Version

+ Size *int

+ Stats PDFStats

+ Subject string

+ Table map[int]*XRefTableEntry

+ Tagged bool

+ Title string

+ URIs map[int]map[string]string

+ Valid bool

+ ValidateLinks bool

+ ValidationMode int

+ Watermarked bool

+ func CreateAcroFormDemoXRef() (*XRefTable, error)

+ func CreateAnnotationDemoXRef() (*XRefTable, error)

+ func CreateDemoXRef(p Page) (*XRefTable, error)

+ func CreateResourceDictInheritanceDemoXRef() (*XRefTable, error)

+ func (xRefTable *XRefTable) Annotation(d Dict) (AnnotationRenderer, error)

+ func (xRefTable *XRefTable) BindNameTrees() error

+ func (xRefTable *XRefTable) Catalog() (Dict, error)

+ func (xRefTable *XRefTable) CatalogHasPieceInfo() (bool, error)

+ func (xRefTable *XRefTable) ColorSpaceComponents(sd *StreamDict) (int, error)

+ func (xRefTable *XRefTable) DeleteObjectGraph(o Object) error

+ func (xRefTable *XRefTable) Dereference(o Object) (Object, error)

+ func (xRefTable *XRefTable) DereferenceArray(o Object) (Array, error)

+ func (xRefTable *XRefTable) DereferenceBoolean(o Object, sinceVersion Version) (*Boolean, error)

+ func (xRefTable *XRefTable) DereferenceCSVSafeText(o Object) (string, error)

+ func (xRefTable *XRefTable) DereferenceDict(o Object) (Dict, error)

+ func (xRefTable *XRefTable) DereferenceDictEntry(d Dict, key string) (Object, error)

+ func (xRefTable *XRefTable) DereferenceInteger(o Object) (*Integer, error)

+ func (xRefTable *XRefTable) DereferenceName(o Object, sinceVersion Version, validate func(string) bool) (n Name, err error)

+ func (xRefTable *XRefTable) DereferenceNumber(o Object) (float64, error)

+ func (xRefTable *XRefTable) DereferenceStreamDict(o Object) (*StreamDict, bool, error)

+ func (xRefTable *XRefTable) DereferenceStringEntryBytes(d Dict, key string) ([]byte, error)

+ func (xRefTable *XRefTable) DereferenceStringLiteral(o Object, sinceVersion Version, validate func(string) bool) (s StringLiteral, err error)

+ func (xRefTable *XRefTable) DereferenceStringOrHexLiteral(obj Object, sinceVersion Version, validate func(string) bool) (s string, err error)

+ func (xRefTable *XRefTable) DereferenceText(o Object) (string, error)

+ func (xRefTable *XRefTable) EncryptDict() (Dict, error)

+ func (xRefTable *XRefTable) EnsureCollection() error

+ func (xRefTable *XRefTable) EnsurePageCount() error

+ func (xRefTable *XRefTable) EnsureValidFreeList() error

+ func (xRefTable *XRefTable) EnsureVersionForWriting()

+ func (xRefTable *XRefTable) Exists(objNr int) bool

+ func (xRefTable *XRefTable) Find(objNr int) (*XRefTableEntry, bool)

+ func (xRefTable *XRefTable) FindObject(objNr int) (Object, error)

+ func (xRefTable *XRefTable) FindTableEntry(objNr int, genNr int) (*XRefTableEntry, bool)

+ func (xRefTable *XRefTable) FindTableEntryForIndRef(ir *IndirectRef) (*XRefTableEntry, bool)

+ func (xRefTable *XRefTable) FindTableEntryLight(objNr int) (*XRefTableEntry, bool)

+ func (xRefTable *XRefTable) Free(objNr int) (*XRefTableEntry, error)

+ func (xRefTable *XRefTable) IDFirstElement() (id []byte, err error)

+ func (xRefTable *XRefTable) IndRefForNewObject(obj Object) (*IndirectRef, error)

+ func (xRefTable *XRefTable) InsertAndUseRecycled(xRefTableEntry XRefTableEntry) (objNr int, err error)

+ func (xRefTable *XRefTable) InsertBlankPages(pages IntSet, before bool) error

+ func (xRefTable *XRefTable) InsertNew(xRefTableEntry XRefTableEntry) (objNr int)

+ func (xRefTable *XRefTable) InsertObject(obj Object) (objNr int, err error)

+ func (xRefTable *XRefTable) IsLinearizationObject(i int) bool

+ func (xRefTable *XRefTable) IsValid(ir IndirectRef) (bool, error)

+ func (xRefTable *XRefTable) LinearizationObjsString() (int, string)

+ func (xRefTable *XRefTable) ListAnnotations(selectedPages IntSet) (int, []string, error)

+ func (xRefTable *XRefTable) LocateNameTree(nameTreeName string, ensure bool) error

+ func (xRefTable *XRefTable) MissingObjects() (int, *string)

+ func (xRefTable *XRefTable) NamesDict() (Dict, error)

+ func (xRefTable *XRefTable) NewEmbeddedFileStreamDict(filename string) (*IndirectRef, error)

+ func (xRefTable *XRefTable) NewEmbeddedStreamDict(r io.Reader, modDate time.Time) (*IndirectRef, error)

+ func (xRefTable *XRefTable) NewFileSpecDict(f, uf, desc string, indRefStreamDict IndirectRef) (Dict, error)

+ func (xRefTable *XRefTable) NewFileSpectDictForAttachment(a Attachment) (*IndirectRef, error)

+ func (xRefTable *XRefTable) NewSoundStreamDict(filename string, samplingRate int, fileSpecDict Dict) (*IndirectRef, error)

+ func (xRefTable *XRefTable) NewStreamDictForBuf(buf []byte) (*StreamDict, error)

+ func (xRefTable *XRefTable) NewStreamDictForFile(filename string) (*StreamDict, error)

+ func (xRefTable *XRefTable) NextForFree(objNr int) (int, error)

+ func (xRefTable *XRefTable) Outlines() (*IndirectRef, error)

+ func (xRefTable *XRefTable) PageBoundaries() ([]PageBoundaries, error)

+ func (xRefTable *XRefTable) PageContent(d Dict) ([]byte, error)

+ func (xRefTable *XRefTable) PageDict(pageNr int, consolidateRes bool) (Dict, *IndirectRef, *InheritedPageAttrs, error)

+ func (xRefTable *XRefTable) PageDictIndRef(page int) (*IndirectRef, error)

+ func (xRefTable *XRefTable) PageDims() ([]Dim, error)

+ func (xRefTable *XRefTable) PageNumber(pageObjNr int) (int, error)

+ func (xRefTable *XRefTable) Pages() (*IndirectRef, error)

+ func (xRefTable *XRefTable) ParseRootVersion() (v *string, err error)

+ func (xRefTable *XRefTable) RemoveCollection() error

+ func (xRefTable *XRefTable) RemoveEmbeddedFilesNameTree() error

+ func (xRefTable *XRefTable) RemoveNameTree(nameTreeName string) error

+ func (xRefTable *XRefTable) SetValid(ir IndirectRef) error

+ func (xRefTable *XRefTable) UndeleteObject(objectNumber int) error

+ func (xRefTable *XRefTable) ValidateVersion(element string, sinceVersion Version) error

+ func (xRefTable *XRefTable) Version() Version

+ func (xRefTable *XRefTable) VersionString() string

+ type XRefTableEntry struct

+ Compressed bool

+ Free bool

+ Generation *int

+ Object Object

+ ObjectStream *int

+ ObjectStreamInd *int

+ Offset *int64

+ RefCount int

+ Valid bool

+ func NewFreeHeadXRefTableEntry() *XRefTableEntry

+ func NewXRefTableEntryGen0(obj Object) *XRefTableEntry