Documentation
¶
Overview ¶
Package wkhtmltopdf contains wrappers around the wkhtmltopdf commandline tool
Index ¶
- Constants
- func GetPath() string
- func SetPath(path string)
- type PDFGenerator
- func (pdfg *PDFGenerator) AddPage(p page)
- func (pdfg *PDFGenerator) ArgString() string
- func (pdfg *PDFGenerator) Args() []string
- func (pdfg *PDFGenerator) Buffer() *bytes.Buffer
- func (pdfg *PDFGenerator) Bytes() []byte
- func (pdfg *PDFGenerator) Create() error
- func (pdfg *PDFGenerator) SetPages(p []page)
- func (pdfg *PDFGenerator) WriteFile(filename string) error
- type Page
- type PageOptions
- type PageReader
Constants ¶
const ( OrientationLandscape = "Landscape" // Landscape mode OrientationPortrait = "Portrait" // Portrait mode )
Constants for orientation modes
const ( PageSizeA0 = "A0" // 841 x 1189 mm PageSizeA1 = "A1" // 594 x 841 mm PageSizeA2 = "A2" // 420 x 594 mm PageSizeA3 = "A3" // 297 x 420 mm PageSizeA4 = "A4" // 210 x 297 mm, 8.26 PageSizeA5 = "A5" // 148 x 210 mm PageSizeA6 = "A6" // 105 x 148 mm PageSizeA7 = "A7" // 74 x 105 mm PageSizeA8 = "A8" // 52 x 74 mm PageSizeA9 = "A9" // 37 x 52 mm PageSizeB0 = "B0" // 1000 x 1414 mm PageSizeB1 = "B1" // 707 x 1000 mm PageSizeB2 = "B2" // 500 x 707 mm PageSizeB3 = "B3" // 353 x 500 mm PageSizeB4 = "B4" // 250 x 353 mm PageSizeB5 = "B5" // 176 x 250 mm, 6.93 PageSizeB6 = "B6" // 125 x 176 mm PageSizeB7 = "B7" // 88 x 125 mm PageSizeB8 = "B8" // 62 x 88 mm PageSizeB9 = "B9" // 33 x 62 mm PageSizeB10 = "B10" // 31 x 44 mm PageSizeC5E = "C5E" // 163 x 229 mm PageSizeComm10E = "Comm10E" // 105 x 241 mm, U.S. Common 10 Envelope PageSizeDLE = "DLE" // 110 x 220 mm PageSizeExecutive = "Executive" // 7.5 x 10 inches, 190.5 x 254 mm PageSizeFolio = "Folio" // 210 x 330 mm PageSizeLedger = "Ledger" // 431.8 x 279.4 mm PageSizeLegal = "Legal" // 8.5 x 14 inches, 215.9 x 355.6 mm PageSizeLetter = "Letter" // 8.5 x 11 inches, 215.9 x 279.4 mm PageSizeTabloid = "Tabloid" // 279.4 x 431.8 mm PageSizeCustom = "Custom" // Unknown, or a user defined size. )
Constants for page sizes
Variables ¶
This section is empty.
Functions ¶
Types ¶
type PDFGenerator ¶
type PDFGenerator struct {
Cover cover
TOC toc
OutputFile string //filename to write to, default empty (writes to internal buffer)
// contains filtered or unexported fields
}
PDFGenerator is the main wkhtmltopdf struct, always use NewPDFGenerator to obtain a new PDFGenerator struct
func NewPDFGenerator ¶
func NewPDFGenerator() (*PDFGenerator, error)
NewPDFGenerator returns a new PDFGenerator struct with all options created and checks if wkhtmltopdf can be found on the system
func (*PDFGenerator) AddPage ¶
func (pdfg *PDFGenerator) AddPage(p page)
AddPage adds a new input page to the document. A page is an input HTML page, it can span multiple pages in the output document. It is a Page when read from file or URL or a PageReader when read from memory.
func (*PDFGenerator) ArgString ¶
func (pdfg *PDFGenerator) ArgString() string
ArgString returns Args as a single string
func (*PDFGenerator) Args ¶
func (pdfg *PDFGenerator) Args() []string
Args returns the commandline arguments as a string slice
func (*PDFGenerator) Buffer ¶
func (pdfg *PDFGenerator) Buffer() *bytes.Buffer
Buffer returns the embedded output buffer used if OutputFile is empty
func (*PDFGenerator) Bytes ¶
func (pdfg *PDFGenerator) Bytes() []byte
Bytes returns the output byte slice from the output buffer used if OutputFile is empty
func (*PDFGenerator) Create ¶
func (pdfg *PDFGenerator) Create() error
Create creates the PDF document and stores it in the internal buffer if no error is returned
func (*PDFGenerator) SetPages ¶
func (pdfg *PDFGenerator) SetPages(p []page)
SetPages resets all pages
func (*PDFGenerator) WriteFile ¶
func (pdfg *PDFGenerator) WriteFile(filename string) error
WriteFile writes the contents of the output buffer to a file
type Page ¶
type Page struct {
Input string
PageOptions
}
Page is the input struct for each page
type PageOptions ¶
type PageOptions struct {
// contains filtered or unexported fields
}
PageOptions are options for each input page
func NewPageOptions ¶
func NewPageOptions() PageOptions
NewPageOptions returns a new PageOptions struct with all options
type PageReader ¶
type PageReader struct {
Input io.Reader
PageOptions
}
PageReader is one input page (a HTML document) that is read from an io.Reader You can add only one Page from a reader
func NewPageReader ¶
func NewPageReader(input io.Reader) *PageReader
NewPageReader creates a new PageReader from an io.Reader
func (*PageReader) Args ¶
func (pr *PageReader) Args() []string
Args returns the argument slice and is part of the page interface
func (*PageReader) InputFile ¶
func (pr *PageReader) InputFile() string
InputFile returns the input string and is part of the page interface
func (*PageReader) Reader ¶
func (pr *PageReader) Reader() io.Reader
Reader returns the io.Reader and is part of the page interface
Source Files