pdf

ExamplePdfMaroto_AddPage how to force add a new page

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Add rows, cols and components
	m.AddPage()

	// Add rows, col and components in a new page
	// Do more things and save...
}

Output:

ExamplePdfMaroto_Barcode demonstrates how to place a barcode inside a Col.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
)

func main() {
	// Passing nil on barcode props parameter implies the Barcode fills it's
	// context cell depending on it's size.
	// It's possible to define the barcode positioning through
	// the top and left parameters unless center parameter is true.
	// In brief, when center parameter equals true, left and top parameters has no effect.
	// Percent parameter represents the Barcode's width/height inside the cell.
	// i.e. Percent: 75 means that the Barcode will take up 75% of Col's width
	// There is a constraint in the proportion defined, height cannot be greater than 20% of
	// the width, and height cannot be smaller than 10% of the width.

	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Do a lot of things on rows and columns...

	m.Col(12, func() {
		_ = m.Barcode("https://github.com/Vale-sail/maroto", props.Barcode{
			Percent:    75,
			Proportion: props.Proportion{Width: 50, Height: 10},
			Center:     true,
		})
	})

	// do more things...
}

Output:

ExamplePdfMaroto_Base64Image demonstrates how to add an Image from a base64 string.

package main

import (
	"encoding/base64"
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
)

func main() {
	// When props.Rect is nil, method make Image fulfill the context cell.
	// When center is true, left and top has no effect.
	// Percent represents the width/height of the Image inside the cell,
	// Ex: 85, means that Image will have width of 85% of column width.
	// When center is false, is possible to manually positioning the Image.

	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	// Bytes of the image loaded
	bytes := []byte{1, 2, 3}
	base64String := base64.StdEncoding.EncodeToString(bytes)

	m.Row(rowHeight, func() {
		m.Col(12, func() {
			_ = m.Base64Image(base64String, consts.Png, props.Rect{
				Left:    5,
				Top:     5,
				Center:  true,
				Percent: 85,
			})
		})
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_Col demonstrates how to add an useful column

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	// Warning: The sum of all column gridSize cannot extrapolate 12
	m.Row(rowHeight, func() {
		m.Col(12, func() {
			// Add Image, Text, Signature, QrCode or Barcode...
		})
	})

	// Warning: The sum of all column gridSize cannot extrapolate 12
	m.Row(rowHeight, func() {
		m.Col(6, func() {
			// Add Image, Text, Signature, QrCode or Barcode...
		})
		m.Col(6, func() {
			// Add Image, Text, Signature, QrCode or Barcode...
		})
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_ColSpace demonstrates how to add an empty column inside a row.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	// Warning: The sum of all column gridSize cannot extrapolate 12
	m.Row(rowHeight, func() {
		m.ColSpace(12)
	})

	// Warning: The sum of all column gridSize cannot extrapolate 12
	m.Row(rowHeight, func() {
		m.ColSpace(6)
		m.ColSpace(6)
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_FileImage demonstrates how add an Image reading from disk.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
)

func main() {
	// When props.Rect is nil, method make Image fulfill the context cell.
	// When center is true, left and top has no effect.
	// Percent represents the width/height of the Image inside the cell,
	// Ex: 85, means that Image will have width of 85% of column width.
	// When center is false, is possible to manually positioning the Image.

	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	m.Row(rowHeight, func() {
		m.Col(12, func() {
			_ = m.FileImage("path/Image.jpg", props.Rect{
				Left:    5,
				Top:     5,
				Center:  true,
				Percent: 85,
			})
		})
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_GetBorder demonstrates how to obtain the actual borders status

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// false
	_ = m.GetBorder()

	m.SetBorder(true)

	// true
	_ = m.GetBorder()

	// Do more things and save...
}

Output:

ExamplePdfMaroto_GetCurrentOffset demonstrates how to obtain the current write offset i.e the height of cursor adding content in the pdf

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Offset here will be 0
	_ = m.GetCurrentOffset()

	// Add Rows, Cols and Components until maroto add a new page

	// Offset here will not be 0
	_ = m.GetCurrentOffset()

	// Add Rows, Cols and Components to maroto add a new page

	// Offset here will be 0
	_ = m.GetCurrentOffset()

	// Do more things and save...
}

Output:

ExamplePdfMaroto_GetCurrentPage demonstrates how to obtain the current page index

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Index here will be 0
	_ = m.GetCurrentPage()

	// Add Rows, Cols and Components

	// Index here will not be 0
	_ = m.GetCurrentPage()

	// Do more things and save...
}

Output:

ExamplePdfMaroto_GetPageMargins demonstrates how to obtain the current page margins

package main

import (
	"fmt"
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Get
	left, top, right, bottom := m.GetPageMargins()
	fmt.Println(left)
	fmt.Println(top)
	fmt.Println(right)
	fmt.Println(bottom)

	// Do more things and save...
}

Output:

ExamplePdfMaroto_GetPageSize demonstrates how to obtain the current page size (width and height)

package main

import (
	"fmt"
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Get
	width, height := m.GetPageSize()
	fmt.Println(width)
	fmt.Println(height)

	// Do more things and save...
}

Output:

ExamplePdfMaroto_Line demonstrates how to draw a line separator.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	m.Line(1.0)

	// Do more things and save...
}

Output:

ExamplePdfMaroto_Output demonstrates how to get a base64 string from PDF

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Do a lot of things on rows and columns...

	_, err := m.Output()
	if err != nil {
		return
	}
}

Output:

ExamplePdfMaroto_OutputFileAndClose demonstrates how to save a PDF object into disk.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	// Do a lot of things on rows and columns...

	err := m.OutputFileAndClose("path/file.pdf")
	if err != nil {
		return
	}
}

Output:

ExamplePdfMaroto_QrCode demonstrates how to add a QR Code inside a Col.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
)

func main() {
	// Passing nil on rectProps makes
	// the QR Code fills the context cell.
	// When center is true, left and top has no effect.
	// Percent represents the width/height of the QR Code inside the cell.
	// i.e. 80 means that the QR Code will take up 80% of Col's width
	// When center is false, positioning of the QR Code can be done through
	// left and top.

	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	m.Row(rowHeight, func() {
		m.Col(12, func() {
			m.QrCode("https://godoc.org/github.com/Vale-sail/maroto", props.Rect{
				Left:    5,
				Top:     5,
				Center:  false,
				Percent: 80,
			})
		})
	})
}

Output:

ExamplePdfMaroto_RegisterFooter demonstrates how to register footer.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
	"time"
)

func main() {
	// For register footer you need to call method RegisterFooter
	// that receives a closure.
	// In this closure you are free to set any components you want to compose
	// your footer.
	// In this example there is a signature and a text with right align.
	// It is important to remember that it is recommended to create Row's and
	// Col's if necessary.
	// You have to register the footer immediately after the Maroto

	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	m.RegisterFooter(func() {
		m.Row(10, func() {
			m.Col(6, func() {
				m.Signature("lorem ipsum dolor")
			})
			m.Col(6, func() {
				m.Text(time.Now().Format("02-January-2006"), props.Text{Align: consts.Right})
			})
		})
	})

	// Do more things or not and save...
}

Output:

ExamplePdfMaroto_RegisterHeader demonstrates how to register header.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
	"time"
)

func main() {
	// For register header in Maroto you need to call method RegisterHeader
	// that receives a closure.
	// In this closure you are free to set any components you want to compose
	// your header.
	// In this example there is a two texts with different props and one image.
	// It is important to remember that it is recommended to create Row's and
	// Col's if necessary.
	// You have to register the header immediately after the Maroto

	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	m.RegisterHeader(func() {
		m.Row(10, func() {
			m.Col(3, func() {
				m.Text("lorem ipsum dolor", props.Text{Align: consts.Left})
			})
			m.Col(3, func() {
				_ = m.FileImage("internal/assets/images/frontpage.png")
			})
			m.Col(3, func() {
				m.Text(time.Now().Format("02-January-2006"),
					props.Text{Align: consts.Right})
			})
		})
	})

	// Do more things or not and save...
}

Output:

ExamplePdfMaroto_Row demonstrates how to define a row.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	m.Row(rowHeight, func() {
		// ... Add some columns
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_SetBackgroundColor demonstrates how to use the SetBackgroundColor method.

package main

import (
	"github.com/Vale-sail/maroto/pkg/color"
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	m.SetBackgroundColor(color.Color{
		Red:   100,
		Green: 20,
		Blue:  30,
	})

	// This Row will be filled with the color
	m.Row(20, func() {
		m.Col(12, func() {
			// Add components
		})
	})

	m.SetBackgroundColor(color.NewWhite())
	// Note: The default value is White (255, 255, 255), if maroto see this value it will ignore not will the cell with any color

	// This Row will not be filled with the color
	m.Row(20, func() {
		m.Col(12, func() {
			// Add components
		})
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_SetBorder demonstrates how to enable the line drawing in every cell

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	m.SetBorder(true)

	// Add some Rows, Cols, Lines and etc...
	// Here will be drawn borders in every cell

	m.SetBorder(false)

	// Add some Rows, Cols, Lines and etc...
	// Here will not be drawn borders

	// Do more things and save...
}

Output:

ExamplePdfMaroto_SetPageMargins demonstrates how to set custom page margins.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
)

func main() {
	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	m.SetPageMargins(10, 60, 10)

	// Do more things or not and save...
}

Output:

ExamplePdfMaroto_Signature demonstrates how to add a Signature space inside a col.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
)

func main() {
	// Not passing this font prop will lead the method to use all the follow values.
	// Not passing family, make method use arial.
	// Not passing style, make method use normal.
	// Not passing size, make method use 10.0.

	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	m.Row(rowHeight, func() {
		m.Col(12, func() {
			m.Signature("LabelForSignature", props.Font{
				Size:   12.0,
				Style:  consts.BoldItalic,
				Family: consts.Courier,
			})
		})
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_TableList demonstrates how to add a table with multiple rows and columns.

package main

import (
	"github.com/Vale-sail/maroto/pkg/color"
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
)

func main() {
	// Not passing this table list prop will lead the method to use all the follow values.
	// Not passing HeaderProp.Size, make the method use 10.
	// Not passing HeaderProp.Family, make the method use arial.
	// Not passing HeaderProp.Style, make the method use bold.
	// Not passing HeaderProp.GridSizes, make the method use an array with same length
	// of header array, the values will be perfectly divided to make all columns with the same size.
	// Not passing Align, make the method to use left.
	// Not passing ContentProp.Size, make the method use 10.
	// Not passing ContentProp.Family, make the method use arial.
	// Not passing ContentProp.Style, make the method use normal.
	// Not passing Content.GridSizes, make the method use an array with same length
	// of content array in the first line, the values will be perfectly divided to make all columns with the same size.
	// Not passing HeaderContentSpace, will make the method use 4.

	m := pdf.NewMaroto(consts.Portrait, consts.A4)

	headers := []string{"Header1", "Header2"}
	contents := [][]string{
		{"Content1", "Content2"},
		{"Content3", "Content3"},
	}

	m.TableList(headers, contents, props.TableList{
		HeaderProp: props.TableListContent{
			Family:    consts.Arial,
			Style:     consts.Bold,
			Size:      11.0,
			GridSizes: []uint{3, 9},
		},
		ContentProp: props.TableListContent{
			Family:    consts.Courier,
			Style:     consts.Normal,
			Size:      10.0,
			GridSizes: []uint{3, 9},
		},
		Align: consts.Center,
		AlternatedBackground: &color.Color{
			Red:   100,
			Green: 20,
			Blue:  255,
		},
		HeaderContentSpace: 10.0,
		Line:               false,
	})

	// Do more things and save...
}

Output:

ExamplePdfMaroto_Text demonstrates how to add a Text inside a col.

package main

import (
	"github.com/Vale-sail/maroto/pkg/consts"
	"github.com/Vale-sail/maroto/pkg/pdf"
	"github.com/Vale-sail/maroto/pkg/props"
)

func main() {
	// Not passing the text prop will lead to use all the follow default values.
	// Not passing family, makes the method use arial.
	// Not passing style, makes the method use normal.
	// Not passing size, makes the method use 10.0.
	// Not passing align, makes the method use left.
	// Not passing extrapolate, makes the method use false.
	// Top cannot be less than 0.
	// VerticalPadding cannot be less than 0.

	m := pdf.NewMaroto(consts.Portrait, consts.A4)
	rowHeight := 5.0

	m.Row(rowHeight, func() {
		m.Col(12, func() {
			m.Text("TextContent", props.Text{
				Size:            12.0,
				Style:           consts.BoldItalic,
				Family:          consts.Courier,
				Align:           consts.Center,
				Top:             1.0,
				Extrapolate:     false,
				VerticalPadding: 1.0,
			})
		})
	})

	// Do more things and save...
}

Output: