Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

document

package

Go to main page

Versions in this module

v0

v0.6.0

Feb 24, 2026

v0.5.1

Feb 23, 2026

v0.5.0

Feb 23, 2026

v0.4.0

Feb 21, 2026

Changes in this version

type Document

+ func (d *Document) AddPageWithRect(rect types.Rectangle) (*Page, error)

type PageSize

+ const A0

+ const A1

+ const A2

+ const A6

+ const A7

+ const A8

+ const ANSIC

+ const ANSID

+ const ANSIE

+ const B0

+ const B1

+ const B2

+ const B3

+ const B6

+ const C4

+ const C5

+ const C6

+ const DL

+ const Digest

+ const Envelope10

+ const Executive

+ const HalfLetter

+ const JISB4

+ const JISB5

+ const Photo4x6

+ const Photo5x7

+ const Photo8x10

+ const Slide16x9

+ const Slide4x3

+ const USTradeBook

v0.3.0

Feb 16, 2026

v0.2.1

Feb 5, 2026

v0.2.0

Feb 3, 2026

v0.1.1

Jan 30, 2026

v0.1.0

Jan 7, 2026

Changes in this version

+ const PointsPerCM

+ const PointsPerInch

+ const PointsPerMM

+ var ErrCropBoxOutOfBounds = errors.New("crop box must be within media box bounds")

+ var ErrEmptyDocument = errors.New("document has no pages")

+ var ErrEmptyURI = errors.New("external link must have a URI")

+ var ErrInvalidAnnotationRect = errors.New("annotation rectangle must have x1 < x2 and y1 < y2")

+ var ErrInvalidBorderWidth = errors.New("border width must be non-negative")

+ var ErrInvalidColor = errors.New("color components must be in range [0.0, 1.0]")

+ var ErrInvalidDestPage = errors.New("destination page must be >= 0")

+ var ErrInvalidPageIndex = errors.New("invalid page index")

+ var ErrInvalidPageSize = errors.New("invalid page size: width and height must be positive")

+ var ErrInvalidRotation = errors.New("rotation must be 0, 90, 180, or 270")

+ var ErrMissingQuadPoints = errors.New("markup annotation must have QuadPoints")

+ var ErrMissingStampName = errors.New("stamp annotation must have a name")

+ var ErrNilAnnotation = errors.New("annotation cannot be nil")

+ var ErrNilContent = errors.New("content cannot be nil")

+ var ErrNilFormField = errors.New("form field cannot be nil")

+ func CMToPoints(cm float64) float64

+ func CustomPageSize(widthPt, heightPt float64) types.Rectangle

+ func InchesToPoints(inches float64) float64

+ func MMToPoints(mm float64) float64

+ func PointsToCM(points float64) float64

+ func PointsToInches(points float64) float64

+ func PointsToMM(points float64) float64

+ type AnnotationType int

+ const AnnotationTypeHighlight

+ const AnnotationTypeLink

+ const AnnotationTypeStamp

+ const AnnotationTypeStrikeOut

+ const AnnotationTypeText

+ const AnnotationTypeUnderline

+ type Document struct

+ func NewDocument() *Document

+ func (d *Document) AddPage(pageSize PageSize) (*Page, error)

+ func (d *Document) Author() string

+ func (d *Document) CreationDate() time.Time

+ func (d *Document) Creator() string

+ func (d *Document) InsertPage(index int, pageSize PageSize) (*Page, error)

+ func (d *Document) Keywords() []string

+ func (d *Document) ModificationDate() time.Time

+ func (d *Document) Page(index int) (*Page, error)

+ func (d *Document) PageCount() int

+ func (d *Document) Pages() []*Page

+ func (d *Document) Producer() string

+ func (d *Document) RemovePage(index int) error

+ func (d *Document) SetMetadata(title, author, subject string, keywords ...string)

+ func (d *Document) Subject() string

+ func (d *Document) Title() string

+ func (d *Document) Validate() error

+ func (d *Document) Version() types.Version

+ type FormField struct

+ func NewFormField(fieldType, name string, rect [4]float64) *FormField

+ func (f *FormField) AlternateText() string

+ func (f *FormField) AnnotationFlags() int

+ func (f *FormField) Appearance() string

+ func (f *FormField) BorderColor() *[3]float64

+ func (f *FormField) DefaultValue() string

+ func (f *FormField) FieldType() string

+ func (f *FormField) FillColor() *[3]float64

+ func (f *FormField) Flags() int

+ func (f *FormField) MaxLength() int

+ func (f *FormField) Name() string

+ func (f *FormField) Options() []string

+ func (f *FormField) Rect() [4]float64

+ func (f *FormField) SetAlternateText(text string)

+ func (f *FormField) SetAnnotationFlags(flags int)

+ func (f *FormField) SetAppearance(appearance string)

+ func (f *FormField) SetBorderColor(r, g, b float64)

+ func (f *FormField) SetDefaultValue(value string)

+ func (f *FormField) SetFillColor(r, g, b float64)

+ func (f *FormField) SetFlags(flags int)

+ func (f *FormField) SetMaxLength(length int)

+ func (f *FormField) SetOptions(options []string)

+ func (f *FormField) SetValue(value string)

+ func (f *FormField) Validate() error

+ func (f *FormField) Value() string

+ type LinkAnnotation struct

+ BorderWidth float64

+ DestPage int

+ IsInternal bool

+ Rect [4]float64

+ URI string

+ func NewInternalLinkAnnotation(rect [4]float64, destPage int) *LinkAnnotation

+ func NewLinkAnnotation(rect [4]float64, uri string) *LinkAnnotation

+ func (a *LinkAnnotation) Validate() error

+ type MarkupAnnotation struct

+ Color [3]float64

+ Contents string

+ QuadPoints [][8]float64

+ Rect [4]float64

+ Title string

+ Type AnnotationType

+ func NewMarkupAnnotation(annotType AnnotationType, rect [4]float64, quadPoints [][8]float64) *MarkupAnnotation

+ func (a *MarkupAnnotation) SetAuthor(author string)

+ func (a *MarkupAnnotation) SetColor(color [3]float64)

+ func (a *MarkupAnnotation) SetContents(contents string)

+ func (a *MarkupAnnotation) Validate() error

+ type Page struct

+ func NewPage(number int, size PageSize) *Page

+ func (p *Page) AddAnnotation(a *LinkAnnotation) error

+ func (p *Page) AddContent(c content.Content) error

+ func (p *Page) AddFormField(f *FormField) error

+ func (p *Page) AddLinkAnnotation(a *LinkAnnotation) error

+ func (p *Page) AddMarkupAnnotation(a *MarkupAnnotation) error

+ func (p *Page) AddStampAnnotation(a *StampAnnotation) error

+ func (p *Page) AddTextAnnotation(a *TextAnnotation) error

+ func (p *Page) AnnotationCount() int

+ func (p *Page) Annotations() []*LinkAnnotation

+ func (p *Page) ClearAnnotations()

+ func (p *Page) ClearContent()

+ func (p *Page) ContentCount() int

+ func (p *Page) Contents() []content.Content

+ func (p *Page) CropBox() *types.Rectangle

+ func (p *Page) FormFields() []*FormField

+ func (p *Page) Height() float64

+ func (p *Page) LinkAnnotations() []*LinkAnnotation

+ func (p *Page) MarkupAnnotations() []*MarkupAnnotation

+ func (p *Page) MediaBox() types.Rectangle

+ func (p *Page) Number() int

+ func (p *Page) Rotation() int

+ func (p *Page) SetCropBox(box types.Rectangle) error

+ func (p *Page) SetRotation(degrees int) error

+ func (p *Page) StampAnnotations() []*StampAnnotation

+ func (p *Page) TextAnnotations() []*TextAnnotation

+ func (p *Page) Validate() error

+ func (p *Page) Width() float64

+ type PageSize int

+ const A3

+ const A4

+ const A5

+ const B4

+ const B5

+ const Custom

+ const Legal

+ const Letter

+ const Tabloid

+ func (ps PageSize) String() string

+ func (ps PageSize) ToRectangle() types.Rectangle

+ type StampAnnotation struct

+ Color [3]float64

+ Contents string

+ Name string

+ Rect [4]float64

+ Title string

+ func NewStampAnnotation(rect [4]float64, name StampName) *StampAnnotation

+ func (a *StampAnnotation) SetAuthor(author string)

+ func (a *StampAnnotation) SetColor(color [3]float64)

+ func (a *StampAnnotation) SetContents(contents string)

+ func (a *StampAnnotation) Validate() error

+ type StampName string

+ const StampApproved

+ const StampAsIs

+ const StampConfidential

+ const StampDepartmental

+ const StampDraft

+ const StampExperimental

+ const StampExpired

+ const StampFinal

+ const StampForComment

+ const StampForPublicRelease

+ const StampNotApproved

+ const StampNotForPublicRelease

+ type TextAnnotation struct

+ Color [3]float64

+ Contents string

+ Open bool

+ Rect [4]float64

+ Title string

+ func NewTextAnnotation(rect [4]float64, contents, title string) *TextAnnotation

+ func (a *TextAnnotation) SetColor(color [3]float64)

+ func (a *TextAnnotation) SetOpen(open bool)

+ func (a *TextAnnotation) Validate() error