gopdf

package module
v0.9.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 27, 2020 License: MIT Imports: 25 Imported by: 0

README

gopdf

gopdf is a simple library for generating PDF document written in Go lang.

Features
  • Unicode subfont embedding. (Chinese, Japanese, Korean, etc.)
  • Draw line, oval, rect, curve
  • Draw image ( jpg, png )
  • Password protection
  • Font kerning

Installation

go get -u github.com/0x-1/gopdf
Print text
  
package main
import (
	"log"
	"github.com/0x-1/gopdf"
)

func main() {

	pdf := gopdf.GoPdf{}
	pdf.Start(gopdf.Config{ PageSize: *gopdf.PageSizeA4 })  
	pdf.AddPage()
	err := pdf.AddTTFFont("wts11", "../ttf/wts11.ttf")
	if err != nil {
		log.Print(err.Error())
		return
	}

	err = pdf.SetFont("wts11", "", 14)
	if err != nil {
		log.Print(err.Error())
		return
	}
	pdf.Cell(nil, "您好")
	pdf.WritePdf("hello.pdf")

}
Image

package main
import (
	"log"
	"github.com/0x-1/gopdf"
)

func main() {
	pdf := gopdf.GoPdf{}
	pdf.Start(gopdf.Config{PageSize: *gopdf.PageSizeA4 })  
	pdf.AddPage()
	var err error
	err = pdf.AddTTFFont("loma", "../ttf/Loma.ttf")
	if err != nil {
		log.Print(err.Error())
		return
	}
	
	pdf.Image("../imgs/gopher.jpg", 200, 50, nil) //print image
	err = pdf.SetFont("loma", "", 14)
	if err != nil {
		log.Print(err.Error())
		return
	}
	pdf.SetX(250) //move current location
	pdf.SetY(200)
	pdf.Cell(nil, "gopher and gopher") //print text

	pdf.WritePdf("image.pdf")
}
  


package main

import (
	"log"
	"github.com/0x-1/gopdf"
)

func main()  {
	pdf := gopdf.GoPdf{}
	pdf.Start(gopdf.Config{ PageSize: *gopdf.PageSizeA4 }) //595.28, 841.89 = A4
	pdf.AddPage()
	err := pdf.AddTTFFont("times", "./test/res/times.ttf")
	if err != nil {
		log.Print(err.Error())
		return
	}

	err = pdf.SetFont("times", "", 14)
	if err != nil {
		log.Print(err.Error())
		return
	}

	pdf.SetX(30)
	pdf.SetY(40)
	pdf.Text("Link to example.com")
	pdf.AddExternalLink("http://example.com/", 27.5, 28, 125, 15)

	pdf.SetX(30)
	pdf.SetY(70)
	pdf.Text("Link to second page")
	pdf.AddInternalLink("anchor", 27.5, 58, 120, 15)

	pdf.AddPage()
	pdf.SetX(30)
	pdf.SetY(100)
	pdf.SetAnchor("anchor")
	pdf.Text("Anchor position")

	pdf.WritePdf("hello.tmp.pdf")

}
Draw line
pdf.SetLineWidth(2)
pdf.SetLineType("dashed")
pdf.Line(10, 30, 585, 30)
Draw oval
pdf.SetLineWidth(1)
pdf.Oval(100, 200, 500, 500)
Rotation text or image
pdf.SetX(100)
pdf.SetY(100)
pdf.Rotate(270.0, 100.0, 100.0)
pdf.Text("Hello...")
pdf.RotateReset() //reset
Set transparency for text

Read about transparency in pdf (page 320, section 11)

pdf.SetAlpha(alpha float64, blendMode string)
  • alpha - value of transparency, can be between 0 and 1
  • blendMode - default value is Normal - read about blendMode and kinds of its (page 325, section 11.3.5)
Password protection
package main

import (
	"log"

	"github.com/0x-1/gopdf"
)


func main() {

	pdf := gopdf.GoPdf{}
	pdf.Start(gopdf.Config{
		PageSize: *gopdf.PageSizeA4, //595.28, 841.89 = A4
		Protection: gopdf.PDFProtectionConfig{
			UseProtection: true,
			Permissions: gopdf.PermissionsPrint | gopdf.PermissionsCopy | gopdf.PermissionsModify,
			OwnerPass:   []byte("123456"),
			UserPass:    []byte("123456789")},
	})

	pdf.AddPage()
	pdf.AddTTFFont("loma", "../ttf/loma.ttf")
	pdf.Cell(nil,"Hi")
	pdf.WritePdf("protect.pdf")
}
Import existing PDF

Import existing PDF power by package gofpdi created by @phpdave11 (thank you 😄)

package main

import (
        "github.com/0x-1/gopdf"
        "io"
        "net/http"
        "os"
)

func main() {
        var err error

        // Download a Font
        fontUrl := "https://github.com/google/fonts/raw/master/ofl/daysone/DaysOne-Regular.ttf"
        if err = DownloadFile("example-font.ttf", fontUrl); err != nil {
            panic(err)
        }

        // Download a PDF
        fileUrl := "https://tcpdf.org/files/examples/example_012.pdf"
        if err = DownloadFile("example-pdf.pdf", fileUrl); err != nil {
            panic(err)
        }

        pdf := gopdf.GoPdf{}
        pdf.Start(gopdf.Config{PageSize: gopdf.Rect{W: 595.28, H: 841.89}}) //595.28, 841.89 = A4

        pdf.AddPage()

        err = pdf.AddTTFFont("daysone", "example-font.ttf")
        if err != nil {
            panic(err)
        }

        err = pdf.SetFont("daysone", "", 20)
        if err != nil {
            panic(err)
        }

        // Color the page
        pdf.SetLineWidth(0.1)
        pdf.SetFillColor(124, 252, 0) //setup fill color
        pdf.RectFromUpperLeftWithStyle(50, 100, 400, 600, "FD")
        pdf.SetFillColor(0, 0, 0)

        pdf.SetX(50)
        pdf.SetY(50)
        pdf.Cell(nil, "Import existing PDF into GoPDF Document")

        // Import page 1
        tpl1 := pdf.ImportPage("example-pdf.pdf", 1, "/MediaBox")

        // Draw pdf onto page
        pdf.UseImportedTemplate(tpl1, 50, 100, 400, 0)

        pdf.WritePdf("example.pdf")

}

// DownloadFile will download a url to a local file. It's efficient because it will
// write as it downloads and not load the whole file into memory.
func DownloadFile(filepath string, url string) error {
        // Get the data
        resp, err := http.Get(url)
        if err != nil {
            return err
        }
        defer resp.Body.Close()

        // Create the file
        out, err := os.Create(filepath)
        if err != nil {
            return err
        }
        defer out.Close()

        // Write the body to file
        _, err = io.Copy(out, resp.Body)
        return err
}

visit https://github.com/oneplus1000/gopdfsample for more samples.

Documentation

Index

Constants

View Source 
const (
	Unit_Unset = iota // No units were set, when conversion is called on nothing will happen
	Unit_PT           // Points
	Unit_MM           // Millimeters
	Unit_CM           // centimeters
	Unit_IN           // inches

)

The units that can be used in the document

View Source 
const (
	//PermissionsPrint setProtection print
	PermissionsPrint = 4
	//PermissionsModify setProtection modify
	PermissionsModify = 8
	//PermissionsCopy setProtection copy
	PermissionsCopy = 16
	//PermissionsAnnotForms setProtection  annot-forms
	PermissionsAnnotForms = 32
)
View Source 
const ARG_1_AND_2_ARE_WORDS = 1
View Source 
const Bold = 2 //000010

Bold - font style bold

View Source 
const Bottom = 1 //000001

Bottom bottom

View Source 
const Center = 16 //010000

Center center

View Source 
const ContentTypeCell = 0

ContentTypeCell cell

View Source 
const ContentTypeText = 1

ContentTypeText text

View Source 
const Italic = 1 //000001

Italic - font style italic

View Source 
const Left = 8 //001000

Left left

View Source 
const MORE_COMPONENTS = 32
View Source 
const Middle = 32 //100000

Middle middle

View Source 
const Regular = 0 //000000

Regular - font style regular

View Source 
const Right = 2 //000010

Right right

View Source 
const Top = 4 //000100

Top top

View Source 
const Underline = 4 //000100

Underline - font style underline

View Source 
const WE_HAVE_AN_X_AND_Y_SCALE = 64
View Source 
const WE_HAVE_A_SCALE = 8
View Source 
const WE_HAVE_A_TWO_BY_TWO = 128

Variables

View Source 
var EntrySelectors = []int{
	0, 0, 1, 1, 2, 2,
	2, 2, 3, 3, 3, 3,
	3, 3, 3, 3, 4, 4,
	4, 4, 4, 4, 4, 4,
	4, 4, 4, 4, 4, 4, 4,
}

EntrySelectors entry selectors

View Source 
var ErrCharNotFound = errors.New("char not found")

ErrCharNotFound char not found

View Source 
var ErrNotSupportShortIndexYet = errors.New("not suport none short index yet")

ErrNotSupportShortIndexYet not suport none short index yet

View Source 
var PageSize10x14 = &Rect{W: 720, H: 1008, unitOverride: Unit_PT}
View Source 
var PageSizeA0 = &Rect{W: 2384, H: 3371, unitOverride: Unit_PT}
View Source 
var PageSizeA1 = &Rect{W: 1685, H: 2384, unitOverride: Unit_PT}
View Source 
var PageSizeA2 = &Rect{W: 1190, H: 1684, unitOverride: Unit_PT}
View Source 
var PageSizeA3 = &Rect{W: 842, H: 1190, unitOverride: Unit_PT}
View Source 
var PageSizeA4 = &Rect{W: 595, H: 842, unitOverride: Unit_PT}
View Source 
var PageSizeA4Small = &Rect{W: 595, H: 842, unitOverride: Unit_PT}
View Source 
var PageSizeA5 = &Rect{W: 420, H: 595, unitOverride: Unit_PT}
View Source 
var PageSizeB4 = &Rect{W: 729, H: 1032, unitOverride: Unit_PT}
View Source 
var PageSizeB5 = &Rect{W: 516, H: 729, unitOverride: Unit_PT}
View Source 
var PageSizeExecutive = &Rect{W: 540, H: 720, unitOverride: Unit_PT}
View Source 
var PageSizeFolio = &Rect{W: 612, H: 936, unitOverride: Unit_PT}
View Source 
var PageSizeLedger = &Rect{W: 1224, H: 792, unitOverride: Unit_PT}
View Source 
var PageSizeLegal = &Rect{W: 612, H: 1008, unitOverride: Unit_PT}
View Source 
var PageSizeLetter = &Rect{W: 612, H: 792, unitOverride: Unit_PT}
View Source 
var PageSizeLetterSmall = &Rect{W: 612, H: 792, unitOverride: Unit_PT}
View Source 
var PageSizeQuarto = &Rect{W: 610, H: 780, unitOverride: Unit_PT}
View Source 
var PageSizeStatement = &Rect{W: 396, H: 612, unitOverride: Unit_PT}
View Source 
var PageSizeTabloid = &Rect{W: 792, H: 1224, unitOverride: Unit_PT}

Functions

func CheckSum 

func CheckSum(data []byte) uint

CheckSum check sum

func Chr 

func Chr(n int) byte

func ContentObj_CalTextHeight 

func ContentObj_CalTextHeight(fontsize int) float64

ContentObj_CalTextHeight calculate height of text

func CreateEmbeddedFontSubsetName 

func CreateEmbeddedFontSubsetName(name string) string

CreateEmbeddedFontSubsetName create Embedded font (subset font) name

func DebugSubType 

func DebugSubType(b []byte)

func DesignUnitsToPdf 

func DesignUnitsToPdf(val int, unitsPerEm uint) int

DesignUnitsToPdf convert unit

func FontConvertHelper_Cw2Str 

func FontConvertHelper_Cw2Str(cw FontCw) string

func GetBuffer 

func GetBuffer() *bytes.Buffer

GetBuffer fetches a buffer from the pool

func ImgReactagleToWH 

func ImgReactagleToWH(imageRect image.Rectangle) (float64, float64)

ImgReactagleToWH Rectangle to W and H

func PointsToUnits added in v0.9.0 

func PointsToUnits(t int, u float64) float64

PointsToUnits converts points to the provided units

func PointsToUnitsVar added in v0.9.0 

func PointsToUnitsVar(t int, u ...*float64)

PointsToUnitsVar converts points to the provided units for all variables supplied

func PutBuffer 

func PutBuffer(buf *bytes.Buffer)

PutBuffer returns a buffer to the pool

func ReadShortFromByte 

func ReadShortFromByte(data []byte, offset int) (int64, int)

ReadShortFromByte read short from byte array

func ReadUShortFromByte 

func ReadUShortFromByte(data []byte, offset int) (uint64, int)

ReadUShortFromByte read ushort from byte array

func StrHelperGetStringWidth 

func StrHelperGetStringWidth(str string, fontSize int, ifont IFont) float64

StrHelperGetStringWidth get string width

func ToByte 

func ToByte(chr string) byte

func UnitsToPoints added in v0.9.0 

func UnitsToPoints(t int, u float64) float64

UnitsToPoints converts units of the provided type to points

func UnitsToPointsVar added in v0.9.0 

func UnitsToPointsVar(t int, u ...*float64)

UnitsToPointsVar converts units of the provided type to points for all variables supplied

func WriteBytes 

func WriteBytes(w io.Writer, data []byte, offset int, count int) error

WriteBytes writes []byte value to w io.Writer

func WriteTag 

func WriteTag(w io.Writer, tag string) error

WriteTag writes string value to w io.Writer

func WriteUInt16 

func WriteUInt16(w io.Writer, v uint) error

WriteUInt16 writes a 16-bit unsigned integer value to w io.Writer

func WriteUInt32 

func WriteUInt32(w io.Writer, v uint) error

WriteUInt32 writes a 32-bit unsigned integer value to w io.Writer

Types

type Buff 

type Buff struct {
	// contains filtered or unexported fields
}

Buff for pdf content

func (*Buff) Bytes 

func (b *Buff) Bytes() []byte

Bytes : get bytes

func (*Buff) Len 

func (b *Buff) Len() int

Len : len of buffer

func (*Buff) Position 

func (b *Buff) Position() int

Position : get current postion

func (*Buff) SetPosition 

func (b *Buff) SetPosition(pos int)

SetPosition : set current postion

func (*Buff) Write 

func (b *Buff) Write(p []byte) (int, error)

Write : write []byte to buffer

type CIDFontObj 

type CIDFontObj struct {
	PtrToSubsetFontObj *SubsetFontObj
	// contains filtered or unexported fields
}

func (*CIDFontObj) SetIndexObjSubfontDescriptor 

func (ci *CIDFontObj) SetIndexObjSubfontDescriptor(index int)

SetIndexObjSubfontDescriptor set indexObjSubfontDescriptor

func (*CIDFontObj) SetPtrToSubsetFontObj 

func (ci *CIDFontObj) SetPtrToSubsetFontObj(ptr *SubsetFontObj)

SetPtrToSubsetFontObj set PtrToSubsetFontObj

type CacheContent 

type CacheContent struct {
	// contains filtered or unexported fields
}

CacheContent Export cacheContent

func (*CacheContent) Setup 

func (c *CacheContent) Setup(rectangle *Rect,
	textColor Rgb,
	grayFill float64,
	fontCountIndex int,
	fontSize int,
	fontStyle int,
	setXCount int,
	x, y float64,
	fontSubset *SubsetFontObj,
	pageheight float64,
	contentType int,
	cellOpt CellOption,
	lineWidth float64,
)

Setup setup all infomation for cacheContent

func (*CacheContent) WriteTextToContent 

func (c *CacheContent) WriteTextToContent(text string)

WriteTextToContent write text to content

type CatalogObj 

type CatalogObj struct {
}

CatalogObj : catalog dictionary

type CellOption 

type CellOption struct {
	Align  int //Allows to align the text. Possible values are: Left,Center,Right,Top,Bottom,Middle
	Border int //Indicates if borders must be drawn around the cell. Possible values are: Left, Top, Right, Bottom, ALL
	Float  int //Indicates where the current position should go after the call. Possible values are: Right, Bottom
}

CellOption cell option

type Config 

type Config struct {
	Unit       int                 // The unit type to use when composing the document.
	PageSize   Rect                // The default page size for all pages in the document
	K          float64             // Not sure
	Protection PDFProtectionConfig // Protection settings
}

Config static config

type ContentObj 

type ContentObj struct {
	// contains filtered or unexported fields
}

ContentObj content object

func (*ContentObj) AppendStreamCurve 

func (c *ContentObj) AppendStreamCurve(x0 float64, y0 float64, x1 float64, y1 float64, x2 float64, y2 float64, x3 float64, y3 float64, style string)

AppendStreamCurve draw curve

  • x0, y0: Start point
  • x1, y1: Control point 1
  • x2, y2: Control point 2
  • x3, y3: End point
  • style: Style of rectangule (draw and/or fill: D, F, DF, FD) D or empty string: draw. This is the default value. F: fill DF or FD: draw and fill

func (*ContentObj) AppendStreamImage 

func (c *ContentObj) AppendStreamImage(index int, x float64, y float64, rect *Rect)

AppendStreamImage append image

func (*ContentObj) AppendStreamImportedTemplate added in v0.9.6 

func (c *ContentObj) AppendStreamImportedTemplate(tplName string, scaleX float64, scaleY float64, tX float64, tY float64)

AppendStreamImportedTemplate append imported template

func (*ContentObj) AppendStreamLine 

func (c *ContentObj) AppendStreamLine(x1 float64, y1 float64, x2 float64, y2 float64)

AppendStreamLine append line

func (*ContentObj) AppendStreamOval 

func (c *ContentObj) AppendStreamOval(x1 float64, y1 float64, x2 float64, y2 float64)

AppendStreamOval append oval

func (*ContentObj) AppendStreamRectangle 

func (c *ContentObj) AppendStreamRectangle(x float64, y float64, wdth float64, hght float64, style string)

AppendStreamRectangle : draw rectangle from lower-left corner (x, y) with specif width/height

func (*ContentObj) AppendStreamSetColorFill 

func (c *ContentObj) AppendStreamSetColorFill(r uint8, g uint8, b uint8)

AppendStreamSetColorFill set the color fill

func (*ContentObj) AppendStreamSetColorStroke 

func (c *ContentObj) AppendStreamSetColorStroke(r uint8, g uint8, b uint8)

AppendStreamSetColorStroke set the color stroke

func (*ContentObj) AppendStreamSetGrayFill 

func (c *ContentObj) AppendStreamSetGrayFill(w float64)

AppendStreamSetGrayFill set the grayscale fills

func (*ContentObj) AppendStreamSetGrayStroke 

func (c *ContentObj) AppendStreamSetGrayStroke(w float64)

AppendStreamSetGrayStroke set the grayscale stroke

func (*ContentObj) AppendStreamSetLineType 

func (c *ContentObj) AppendStreamSetLineType(t string)

AppendStreamSetLineType : Set linetype [solid, dashed, dotted]

func (*ContentObj) AppendStreamSetLineWidth 

func (c *ContentObj) AppendStreamSetLineWidth(w float64)

AppendStreamSetLineWidth : set line width

func (*ContentObj) AppendStreamSubsetFont 

func (c *ContentObj) AppendStreamSubsetFont(rectangle *Rect, text string, cellOpt CellOption) error

AppendStreamSubsetFont add stream of text

func (*ContentObj) AppendStreamText 

func (c *ContentObj) AppendStreamText(text string) error

AppendStreamText append text

type Current 

type Current struct {
	X float64
	Y float64

	//font
	IndexOfFontObj int
	CountOfFont    int
	CountOfL       int

	Font_Size      int
	Font_Style     int // Regular|Bold|Italic|Underline
	Font_FontCount int
	Font_Type      int // CURRENT_FONT_TYPE_IFONT or  CURRENT_FONT_TYPE_SUBSET

	Font_ISubset *SubsetFontObj // Font_Type == CURRENT_FONT_TYPE_SUBSET

	//page
	IndexOfPageObj int

	//img
	CountOfImg int
	//cache of image in pdf file
	ImgCaches []ImageCache
	// contains filtered or unexported fields
}

Current current state

type DeviceRGBObj 

type DeviceRGBObj struct {
	// contains filtered or unexported fields
}

DeviceRGBObj DeviceRGB

type EmbedFontObj 

type EmbedFontObj struct {
	Data string
	// contains filtered or unexported fields
}

func (*EmbedFontObj) SetFont 

func (e *EmbedFontObj) SetFont(font IFont, zfontpath string)

type EncodingObj 

type EncodingObj struct {
	// contains filtered or unexported fields
}

func (*EncodingObj) GetFont 

func (e *EncodingObj) GetFont() IFont

func (*EncodingObj) SetFont 

func (e *EncodingObj) SetFont(font IFont)

type EncryptionObj 

type EncryptionObj struct {
	// contains filtered or unexported fields
}

EncryptionObj encryption object res

type ExtGS added in v0.9.6 

type ExtGS struct {
	Index int
}

type ExtGStateObj added in v0.9.6 

type ExtGStateObj struct {
	CA float64
	BM string
	// contains filtered or unexported fields
}

TODO add all fields https://www.adobe.com/content/dam/acom/en/devnet/acrobat/pdfs/PDF32000_2008.pdf 8.4.5 page 128

type FontCw 

type FontCw map[byte]int

type FontDescItem 

type FontDescItem struct {
	Key string
	Val string
}

type FontDescriptorObj 

type FontDescriptorObj struct {
	// contains filtered or unexported fields
}

func (*FontDescriptorObj) GetFont 

func (f *FontDescriptorObj) GetFont() IFont

func (*FontDescriptorObj) SetFont 

func (f *FontDescriptorObj) SetFont(font IFont)

func (*FontDescriptorObj) SetFontFileObjRelate 

func (f *FontDescriptorObj) SetFontFileObjRelate(relate string)

type FontObj 

type FontObj struct {
	Family string
	//Style string
	//Size int
	IsEmbedFont bool

	Font        IFont
	CountOfFont int
	// contains filtered or unexported fields
}

FontObj font obj

func (*FontObj) SetIndexObjEncoding 

func (f *FontObj) SetIndexObjEncoding(index int)

func (*FontObj) SetIndexObjFontDescriptor 

func (f *FontObj) SetIndexObjFontDescriptor(index int)

func (*FontObj) SetIndexObjWidth 

func (f *FontObj) SetIndexObjWidth(index int)

type FuncKernOverride 

type FuncKernOverride func(
	leftRune rune,
	rightRune rune,
	leftPair uint,
	rightPair uint,
	pairVal int16,
) int16

FuncKernOverride return your custome pair value

type GoPdf 

type GoPdf struct {
	// contains filtered or unexported fields
}

GoPdf : A simple library for generating PDF written in Go lang 

func (gp *GoPdf) AddExternalLink(url string, x, y, w, h float64)

AddExternalLink 

func (gp *GoPdf) AddInternalLink(anchor string, x, y, w, h float64)

func (*GoPdf) AddPage 

func (gp *GoPdf) AddPage()

AddPage : add new page

func (*GoPdf) AddPageWithOption 

func (gp *GoPdf) AddPageWithOption(opt PageOption)

AddPageWithOption : add new page with option

func (*GoPdf) AddTTFFont 

func (gp *GoPdf) AddTTFFont(family string, ttfpath string) error

AddTTFFont : add font file

func (*GoPdf) AddTTFFontByReader 

func (gp *GoPdf) AddTTFFontByReader(family string, rd io.Reader) error

AddTTFFontByReader add font file

func (*GoPdf) AddTTFFontByReaderWithOption 

func (gp *GoPdf) AddTTFFontByReaderWithOption(family string, rd io.Reader, option TtfOption) error

AddTTFFontByReaderWithOption add font file

func (*GoPdf) AddTTFFontWithOption 

func (gp *GoPdf) AddTTFFontWithOption(family string, ttfpath string, option TtfOption) error

AddTTFFontWithOption : add font file

func (*GoPdf) Br 

func (gp *GoPdf) Br(h float64)

Br : new line

func (*GoPdf) Cell 

func (gp *GoPdf) Cell(rectangle *Rect, text string) error

Cell : create cell of text ( use current x,y is upper-left corner of cell) Note that this has no effect on Rect.H pdf (now). Fix later :-)

func (*GoPdf) CellWithOption 

func (gp *GoPdf) CellWithOption(rectangle *Rect, text string, opt CellOption) error

CellWithOption create cell of text ( use current x,y is upper-left corner of cell)

func (*GoPdf) Close 

func (gp *GoPdf) Close() error

func (*GoPdf) Curve 

func (gp *GoPdf) Curve(x0 float64, y0 float64, x1 float64, y1 float64, x2 float64, y2 float64, x3 float64, y3 float64, style string)

Curve Draws a Bézier curve (the Bézier curve is tangent to the line between the control points at either end of the curve) Parameters: - x0, y0: Start point - x1, y1: Control point 1 - x2, y2: Control point 2 - x3, y3: End point - style: Style of rectangule (draw and/or fill: D, F, DF, FD)

func (*GoPdf) GetBytesPdf 

func (gp *GoPdf) GetBytesPdf() []byte

GetBytesPdf : get bytes of pdf file

func (*GoPdf) GetBytesPdfReturnErr 

func (gp *GoPdf) GetBytesPdfReturnErr() ([]byte, error)

GetBytesPdfReturnErr : get bytes of pdf file

func (*GoPdf) GetNextObjectID added in v0.9.6 

func (gp *GoPdf) GetNextObjectID() int

Get the next object ID so that gofpdi knows where to start the object IDs

func (*GoPdf) GetX 

func (gp *GoPdf) GetX() float64

GetX : get current position X

func (*GoPdf) GetY 

func (gp *GoPdf) GetY() float64

GetY : get current position y

func (*GoPdf) Image 

func (gp *GoPdf) Image(picPath string, x float64, y float64, rect *Rect) error

Image : draw image

func (*GoPdf) ImageByHolder 

func (gp *GoPdf) ImageByHolder(img ImageHolder, x float64, y float64, rect *Rect) error

ImageByHolder : draw image by ImageHolder

func (*GoPdf) ImportObjects added in v0.9.6 

func (gp *GoPdf) ImportObjects(objs map[int]string, startObjId int)

Import objects from gofpdi into current document

func (*GoPdf) ImportPage added in v0.9.6 

func (gp *GoPdf) ImportPage(sourceFile string, pageno int, box string) int

gofpdi code Return template id after importing

func (*GoPdf) ImportPageStream added in v0.9.6 

func (gp *GoPdf) ImportPageStream(sourceStream *io.ReadSeeker, pageno int, box string) int

gofpdi code Imports using a stream Return template id after importing

func (*GoPdf) ImportTemplates added in v0.9.6 

func (gp *GoPdf) ImportTemplates(tpls map[string]int)

Import template names into procset dictionary

func (*GoPdf) KernOverride 

func (gp *GoPdf) KernOverride(family string, fn FuncKernOverride) error

KernOverride override kern value

func (*GoPdf) Line 

func (gp *GoPdf) Line(x1 float64, y1 float64, x2 float64, y2 float64)

Line : draw line

func (*GoPdf) MarginBottom added in v0.9.0 

func (gp *GoPdf) MarginBottom() float64

MarginBottom returns the bottom margin

func (*GoPdf) MarginLeft added in v0.9.0 

func (gp *GoPdf) MarginLeft() float64

MarginLeft returns the left margin

func (*GoPdf) MarginRight added in v0.9.0 

func (gp *GoPdf) MarginRight() float64

MarginRight returns the right margin

func (*GoPdf) MarginTop added in v0.9.0 

func (gp *GoPdf) MarginTop() float64

MarginTop returns the top margin

func (*GoPdf) Margins added in v0.9.0 

func (gp *GoPdf) Margins() (float64, float64, float64, float64)

Margins gets the current margins, The margins will be converted back to the documents units. Returned values will be in the following order Left, Top, Right, Bottom

func (*GoPdf) MeasureTextWidth 

func (gp *GoPdf) MeasureTextWidth(text string) (float64, error)

MeasureTextWidth : measure Width of text (use current font)

func (*GoPdf) MultiCell added in v0.9.0 

func (gp *GoPdf) MultiCell(rectangle *Rect, text string) error

MultiCell : create of text with line breaks ( use current x,y is upper-left corner of cell)

func (*GoPdf) Oval 

func (gp *GoPdf) Oval(x1 float64, y1 float64, x2 float64, y2 float64)

Oval : draw oval

func (*GoPdf) PointsToUnits added in v0.9.0 

func (gp *GoPdf) PointsToUnits(u float64) float64

PointsToUnits converts the points to the documents unit type

func (*GoPdf) PointsToUnitsVar added in v0.9.0 

func (gp *GoPdf) PointsToUnitsVar(u ...*float64)

PointsToUnitsVar converts the points to the documents unit type for all variables passed in

func (*GoPdf) Read 

func (gp *GoPdf) Read(p []byte) (int, error)

func (*GoPdf) RectFromLowerLeft 

func (gp *GoPdf) RectFromLowerLeft(x float64, y float64, wdth float64, hght float64)

RectFromLowerLeft : draw rectangle from lower-left corner (x, y)

func (*GoPdf) RectFromLowerLeftWithStyle 

func (gp *GoPdf) RectFromLowerLeftWithStyle(x float64, y float64, wdth float64, hght float64, style string)

RectFromLowerLeftWithStyle : draw rectangle from lower-left corner (x, y)

  • style: Style of rectangule (draw and/or fill: D, F, DF, FD) D or empty string: draw. This is the default value. F: fill DF or FD: draw and fill

func (*GoPdf) RectFromUpperLeft 

func (gp *GoPdf) RectFromUpperLeft(x float64, y float64, wdth float64, hght float64)

RectFromUpperLeft : draw rectangle from upper-left corner (x, y)

func (*GoPdf) RectFromUpperLeftWithStyle 

func (gp *GoPdf) RectFromUpperLeftWithStyle(x float64, y float64, wdth float64, hght float64, style string)

RectFromUpperLeftWithStyle : draw rectangle from upper-left corner (x, y)

  • style: Style of rectangule (draw and/or fill: D, F, DF, FD) D or empty string: draw. This is the default value. F: fill DF or FD: draw and fill

func (*GoPdf) Rotate added in v0.8.3 

func (gp *GoPdf) Rotate(angle, x, y float64)

Rotate rotate text or image angle is angle in degrees. x, y is rotation center

func (*GoPdf) RotateReset added in v0.8.3 

func (gp *GoPdf) RotateReset()

RotateReset reset rotate

func (*GoPdf) SetAlpha added in v0.9.6 

func (gp *GoPdf) SetAlpha(alpha float64, blendModeStr string) error

alpha: value from 0 (transparent) to 1 (opaque) blendMode: blend mode, one of the following: 

Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn,
HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity

func (*GoPdf) SetAnchor 

func (gp *GoPdf) SetAnchor(name string)

func (*GoPdf) SetCompressLevel 

func (gp *GoPdf) SetCompressLevel(level int)

SetCompressLevel : set compress Level for content streams Possible values for level: 

-2 HuffmanOnly, -1 DefaultCompression (which is level 6)
 0 No compression,
 1 fastest compression, but not very good ratio
 9 best compression, but slowest

func (*GoPdf) SetFillColor 

func (gp *GoPdf) SetFillColor(r uint8, g uint8, b uint8)

SetFillColor set the color for the stroke

func (*GoPdf) SetFont 

func (gp *GoPdf) SetFont(family string, style string, size int) error

SetFont : set font style support "" or "U" for "B" and "I" should be loaded apropriate fonts with same styles defined

func (*GoPdf) SetFontWithStyle 

func (gp *GoPdf) SetFontWithStyle(family string, style int, size int) error

SetFontWithStyle : set font style support Regular or Underline for Bold|Italic should be loaded apropriate fonts with same styles defined

func (*GoPdf) SetGrayFill 

func (gp *GoPdf) SetGrayFill(grayScale float64)

SetGrayFill set the grayscale for the fill, takes a float64 between 0.0 and 1.0

func (*GoPdf) SetGrayStroke 

func (gp *GoPdf) SetGrayStroke(grayScale float64)

SetGrayStroke set the grayscale for the stroke, takes a float64 between 0.0 and 1.0

func (*GoPdf) SetInfo 

func (gp *GoPdf) SetInfo(info PdfInfo)

SetInfo set Document Information Dictionary

func (*GoPdf) SetLeftMargin 

func (gp *GoPdf) SetLeftMargin(margin float64)

SetLeftMargin : set left margin

func (*GoPdf) SetLineType 

func (gp *GoPdf) SetLineType(linetype string)

SetLineType : set line type ("dashed" ,"dotted") 

Usage:
pdf.SetLineType("dashed")
pdf.Line(50, 200, 550, 200)
pdf.SetLineType("dotted")
pdf.Line(50, 400, 550, 400)

func (*GoPdf) SetLineWidth 

func (gp *GoPdf) SetLineWidth(width float64)

SetLineWidth : set line width

func (*GoPdf) SetMarginBottom added in v0.9.0 

func (gp *GoPdf) SetMarginBottom(margin float64)

SetMarginBottom set the bottom margin

func (*GoPdf) SetMarginLeft added in v0.9.0 

func (gp *GoPdf) SetMarginLeft(margin float64)

SetMarginLeft sets the left margin

func (*GoPdf) SetMarginRight added in v0.9.0 

func (gp *GoPdf) SetMarginRight(margin float64)

SetMarginRight sets the right margin

func (*GoPdf) SetMarginTop added in v0.9.0 

func (gp *GoPdf) SetMarginTop(margin float64)

SetMarginTop sets the top margin

func (*GoPdf) SetMargins added in v0.9.0 

func (gp *GoPdf) SetMargins(left, top, right, bottom float64)

SetMargins defines the left, top, right and bottom margins. By default, they equal 1 cm. Call this method to change them.

func (*GoPdf) SetNoCompression 

func (gp *GoPdf) SetNoCompression()

SetNoCompression : compressLevel = 0

func (*GoPdf) SetStrokeColor 

func (gp *GoPdf) SetStrokeColor(r uint8, g uint8, b uint8)

SetStrokeColor set the color for the stroke

func (*GoPdf) SetTextColor 

func (gp *GoPdf) SetTextColor(r uint8, g uint8, b uint8)

SetTextColor : function sets the text color

func (*GoPdf) SetTopMargin 

func (gp *GoPdf) SetTopMargin(margin float64)

SetTopMargin : set top margin

func (*GoPdf) SetX 

func (gp *GoPdf) SetX(x float64)

SetX : set current position X

func (*GoPdf) SetY 

func (gp *GoPdf) SetY(y float64)

SetY : set current position y

func (*GoPdf) SplitText added in v0.9.6 

func (gp *GoPdf) SplitText(text string, width float64) ([]string, error)

Split text into multiple lines based on width

func (*GoPdf) Start 

func (gp *GoPdf) Start(config Config)

Start : init gopdf

func (*GoPdf) Text 

func (gp *GoPdf) Text(text string) error

Text write text start at current x,y ( current y is the baseline of text )

func (*GoPdf) UnitsToPoints added in v0.9.0 

func (gp *GoPdf) UnitsToPoints(u float64) float64

UnitsToPoints converts the units to the documents unit type

func (*GoPdf) UnitsToPointsVar added in v0.9.0 

func (gp *GoPdf) UnitsToPointsVar(u ...*float64)

UnitsToPointsVar converts the units to the documents unit type for all variables passed in

func (*GoPdf) UseImportedTemplate added in v0.9.6 

func (gp *GoPdf) UseImportedTemplate(tplid int, x float64, y float64, w float64, h float64)

Use imported template - draws imported PDF page onto page

func (*GoPdf) Write 

func (gp *GoPdf) Write(w io.Writer) error

func (*GoPdf) WritePdf 

func (gp *GoPdf) WritePdf(pdfPath string) error

WritePdf : wirte pdf file

type IFont 

type IFont interface {
	Init()
	GetType() string
	GetName() string
	GetDesc() []FontDescItem
	GetUp() int
	GetUt() int
	GetCw() FontCw
	GetEnc() string
	GetDiff() string
	GetOriginalsize() int

	SetFamily(family string)
	GetFamily() string
}

type IObj 

type IObj interface {
	// contains filtered or unexported methods
}

IObj inteface for all pdf object

type ImageCache 

type ImageCache struct {
	Path  string //ID or Path
	Index int
	Rect  *Rect
}

type ImageHolder 

type ImageHolder interface {
	ID() string
	io.Reader
}

ImageHolder hold image data

func ImageHolderByBytes 

func ImageHolderByBytes(b []byte) (ImageHolder, error)

ImageHolderByBytes create ImageHolder by []byte

func ImageHolderByPath 

func ImageHolderByPath(path string) (ImageHolder, error)

ImageHolderByPath create ImageHolder by image path

func ImageHolderByReader 

func ImageHolderByReader(r io.Reader) (ImageHolder, error)

ImageHolderByReader create ImageHolder by io.Reader

type ImageObj 

type ImageObj struct {
	// contains filtered or unexported fields
}

ImageObj image object

func (*ImageObj) GetRect 

func (i *ImageObj) GetRect() *Rect

GetRect get rect of img

func (*ImageObj) Parse 

func (i *ImageObj) Parse() error

Parse parse img

func (*ImageObj) SetImage 

func (i *ImageObj) SetImage(r io.Reader) error

SetImage set image

func (*ImageObj) SetImagePath 

func (i *ImageObj) SetImagePath(path string) error

SetImagePath set image path

type ImportedObj added in v0.9.6 

type ImportedObj struct {
	Data string
}

ImportedObj : imported object

type MapOfCharacterToGlyphIndex 

type MapOfCharacterToGlyphIndex struct {
	Keys []rune
	Vals []uint
	// contains filtered or unexported fields
}

MapOfCharacterToGlyphIndex map of CharacterToGlyphIndex

func NewMapOfCharacterToGlyphIndex 

func NewMapOfCharacterToGlyphIndex() *MapOfCharacterToGlyphIndex

NewMapOfCharacterToGlyphIndex new CharacterToGlyphIndex

func (*MapOfCharacterToGlyphIndex) AllKeys 

func (m *MapOfCharacterToGlyphIndex) AllKeys() []rune

AllKeys get keys

func (*MapOfCharacterToGlyphIndex) AllVals 

func (m *MapOfCharacterToGlyphIndex) AllVals() []uint

AllVals get all values

func (*MapOfCharacterToGlyphIndex) Index 

func (m *MapOfCharacterToGlyphIndex) Index(k rune) (int, bool)

Index get index by key

func (*MapOfCharacterToGlyphIndex) KeyExists 

func (m *MapOfCharacterToGlyphIndex) KeyExists(k rune) bool

KeyExists key is exists?

func (*MapOfCharacterToGlyphIndex) Set 

func (m *MapOfCharacterToGlyphIndex) Set(k rune, v uint)

Set set key and value to map

func (*MapOfCharacterToGlyphIndex) Val 

func (m *MapOfCharacterToGlyphIndex) Val(k rune) (uint, bool)

Val get value by Key

type Margins added in v0.9.0 

type Margins struct {
	Left, Top, Right, Bottom float64
}

type PDFProtection 

type PDFProtection struct {
	// contains filtered or unexported fields
}

PDFProtection protection in pdf

func (*PDFProtection) EncryptionObj 

func (p *PDFProtection) EncryptionObj() *EncryptionObj

EncryptionObj get Encryption Object

func (*PDFProtection) Objectkey 

func (p *PDFProtection) Objectkey(objID int) []byte

Objectkey create object key from ObjID

func (*PDFProtection) SetProtection 

func (p *PDFProtection) SetProtection(permissions int, userPass []byte, ownerPass []byte) error

SetProtection set protection infomation

type PDFProtectionConfig 

type PDFProtectionConfig struct {
	UseProtection bool
	Permissions   int
	UserPass      []byte
	OwnerPass     []byte
}

PDFProtectionConfig config of pdf protection

type PageObj 

type PageObj struct {
	Contents        string
	ResourcesRelate string

	Links []linkOption
	// contains filtered or unexported fields
}

PageObj pdf page object

type PageOption 

type PageOption struct {
	PageSize *Rect
}

PageOption option of page

type PagesObj 

type PagesObj struct {
	PageCount int
	Kids      string
	// contains filtered or unexported fields
}

PagesObj pdf pages object

type PdfDictionaryObj 

type PdfDictionaryObj struct {
	PtrToSubsetFontObj *SubsetFontObj
	// contains filtered or unexported fields
}

PdfDictionaryObj pdf dictionary object

func (*PdfDictionaryObj) AddCompositeGlyphs 

func (p *PdfDictionaryObj) AddCompositeGlyphs(glyphArray *[]int, glyph int)

AddCompositeGlyphs add composite glyph composite glyph is a Unicode entity that can be defined as a sequence of one or more other characters.

func (*PdfDictionaryObj) GetOffset 

func (p *PdfDictionaryObj) GetOffset(glyph int) int

GetOffset get offset from glyf table

func (*PdfDictionaryObj) SetPtrToSubsetFontObj 

func (p *PdfDictionaryObj) SetPtrToSubsetFontObj(ptr *SubsetFontObj)

SetPtrToSubsetFontObj set subsetFontObj pointer

type PdfInfo 

type PdfInfo struct {
	Title        string    //The document’s title
	Author       string    //The name of the person who created the document.
	Subject      string    //The subject of the document.
	Creator      string    // If the document was converted to PDF from another format, the name of the application original document from which it was converted.
	Producer     string    //If the document was converted to PDF from another format, the name of the application (for example, Acrobat Distiller) that converted it to PDF.
	CreationDate time.Time //The date and time the document was created, in human-readable form
}

PdfInfo Document Information Dictionary

type ProcSetObj 

type ProcSetObj struct {
	//Font
	Realtes             RelateFonts
	RealteXobjs         RealteXobjects
	ExtGStates          []ExtGS
	ImportedTemplateIds map[string]int
	// contains filtered or unexported fields
}

ProcSetObj pdf procSet object

type RealteXobject 

type RealteXobject struct {
	IndexOfObj int
}

type RealteXobjects 

type RealteXobjects []RealteXobject

type Rect 

type Rect struct {
	W float64
	H float64
	// contains filtered or unexported fields
}

func (*Rect) PointsToUnits added in v0.9.0 

func (rect *Rect) PointsToUnits(t int) (r *Rect)

PointsToUnits converts the rectanlges width and height to Units. When this is called it is assumed the values of the rectangle are in Points

func (*Rect) UnitsToPoints added in v0.9.0 

func (rect *Rect) UnitsToPoints(t int) (r *Rect)

UnitsToPoints converts the rectanlges width and height to Points. When this is called it is assumed the values of the rectangle are in Units

type RelateFont 

type RelateFont struct {
	Family string
	//etc /F1
	CountOfFont int
	//etc  5 0 R
	IndexOfObj int
	Style      int // Regular|Bold|Italic
}

type RelateFonts 

type RelateFonts []RelateFont

func (*RelateFonts) IsContainsFamily 

func (re *RelateFonts) IsContainsFamily(family string) bool

func (*RelateFonts) IsContainsFamilyAndStyle 

func (re *RelateFonts) IsContainsFamilyAndStyle(family string, style int) bool

IsContainsFamilyAndStyle - checks if already exists font with same name and style

type Rgb 

type Rgb struct {
	// contains filtered or unexported fields
}

Rgb rgb color

func (*Rgb) SetB 

func (rgb *Rgb) SetB(b uint8)

SetB set blue

func (*Rgb) SetG 

func (rgb *Rgb) SetG(g uint8)

SetG set green

func (*Rgb) SetR 

func (rgb *Rgb) SetR(r uint8)

SetR set red

type SMask 

type SMask struct {
	// contains filtered or unexported fields
}

SMask smask

type SubfontDescriptorObj 

type SubfontDescriptorObj struct {
	PtrToSubsetFontObj *SubsetFontObj
	// contains filtered or unexported fields
}

SubfontDescriptorObj pdf subfont descriptorObj object

func (*SubfontDescriptorObj) SetIndexObjPdfDictionary 

func (s *SubfontDescriptorObj) SetIndexObjPdfDictionary(index int)

SetIndexObjPdfDictionary set PdfDictionary pointer

func (*SubfontDescriptorObj) SetPtrToSubsetFontObj 

func (s *SubfontDescriptorObj) SetPtrToSubsetFontObj(ptr *SubsetFontObj)

SetPtrToSubsetFontObj set SubsetFont pointer

type SubsetFontObj 

type SubsetFontObj struct {
	Family                string
	CharacterToGlyphIndex *MapOfCharacterToGlyphIndex
	CountOfFont           int
	// contains filtered or unexported fields
}

SubsetFontObj pdf subsetFont object

func (*SubsetFontObj) AddChars 

func (s *SubsetFontObj) AddChars(txt string) error

AddChars add char to map CharacterToGlyphIndex

func (*SubsetFontObj) CharCodeToGlyphIndex 

func (s *SubsetFontObj) CharCodeToGlyphIndex(r rune) (uint, error)

CharCodeToGlyphIndex get glyph index from char code

func (*SubsetFontObj) CharIndex 

func (s *SubsetFontObj) CharIndex(r rune) (uint, error)

CharIndex index of char in glyph table

func (*SubsetFontObj) CharWidth 

func (s *SubsetFontObj) CharWidth(r rune) (uint, error)

CharWidth with of char

func (*SubsetFontObj) GetFamily 

func (s *SubsetFontObj) GetFamily() string

GetFamily get font family name

func (*SubsetFontObj) GetTTFParser 

func (s *SubsetFontObj) GetTTFParser() *core.TTFParser

GetTTFParser get TTFParser

func (*SubsetFontObj) GetTtfFontOption 

func (s *SubsetFontObj) GetTtfFontOption() TtfOption

GetTtfFontOption get TtfOption must set before SetTTFByPath

func (*SubsetFontObj) GetUp 

func (s *SubsetFontObj) GetUp() int

GetUp underline postion

func (*SubsetFontObj) GetUt 

func (s *SubsetFontObj) GetUt() int

GetUt underlineThickness

func (*SubsetFontObj) GlyphIndexToPdfWidth 

func (s *SubsetFontObj) GlyphIndexToPdfWidth(glyphIndex uint) uint

GlyphIndexToPdfWidth get with from glyphIndex

func (*SubsetFontObj) KernValueByLeft 

func (s *SubsetFontObj) KernValueByLeft(left uint) (bool, *core.KernValue)

KernValueByLeft find kern value from kern table by left

func (*SubsetFontObj) SetFamily 

func (s *SubsetFontObj) SetFamily(familyname string)

SetFamily set font family name

func (*SubsetFontObj) SetIndexObjCIDFont 

func (s *SubsetFontObj) SetIndexObjCIDFont(index int)

SetIndexObjCIDFont set IndexObjCIDFont

func (*SubsetFontObj) SetIndexObjUnicodeMap 

func (s *SubsetFontObj) SetIndexObjUnicodeMap(index int)

SetIndexObjUnicodeMap set IndexObjUnicodeMap

func (*SubsetFontObj) SetTTFByPath 

func (s *SubsetFontObj) SetTTFByPath(ttfpath string) error

SetTTFByPath set ttf

func (*SubsetFontObj) SetTTFByReader 

func (s *SubsetFontObj) SetTTFByReader(rd io.Reader) error

SetTTFByReader set ttf

func (*SubsetFontObj) SetTtfFontOption 

func (s *SubsetFontObj) SetTtfFontOption(option TtfOption)

SetTtfFontOption set TtfOption must set before SetTTFByPath

type Transparency added in v0.9.6 

type Transparency struct {
	IndexOfExtGState int
}

type TtfOption 

type TtfOption struct {
	UseKerning bool
	Style      int // Regular|Bold|Italic
}

TtfOption font option

type UnicodeMap 

type UnicodeMap struct {
	PtrToSubsetFontObj *SubsetFontObj
	// contains filtered or unexported fields
}

UnicodeMap unicode map

func (*UnicodeMap) SetPtrToSubsetFontObj 

func (u *UnicodeMap) SetPtrToSubsetFontObj(ptr *SubsetFontObj)

SetPtrToSubsetFontObj set pointer to SubsetFontObj

Source Files

View all Source files

Directories

Path Synopsis
core

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.