generator

Documentation

Index

• func NewCSV() *csv
• func NewExcel(options *ExcelOptions) *excel
• type Banner
  • func NewBanner(opts ...Options) *Banner
  • func (b *Banner) AddImageLayer(img *ImageLayer) Banners
  • func (b *Banner) AddLabel(labelText *Label) Banners
  • func (b *Banner) Generate() Banners
  • func (b *Banner) Image() image.Image
  • func (b *Banner) Save(destPath string) error
• type Banners
• type BgProperty
• type CSVs
• type ConverterOptions
• type ExcelOptions
• type Excels
• type ImageLayer
• type Label
• type Options
  • func WithBackgroudColor(hexColor string) Options
  • func WithHeight(height int) Options
  • func WithWidth(width int) Options
• type PDF
  • func NewPDF(options ...*ConverterOptions) (*PDF, error)
  • func (c *PDF) Error() error
  • func (c *PDF) Generate() error
  • func (c *PDF) SetFileName(fileName *string) PDFs
  • func (c *PDF) SetFooterHTMLTemplate(footerHTMLPath string) PDFs
  • func (c *PDF) SetTemplate(templatePath string, data interface{}) PDFs
• type PDFs
• type QR
  • func (q *QR) Generate() error
  • func (q *QR) SetFileName(fileName *string) QRs
  • func (q *QR) SetLogoImg(logoPath string) QRs
• type QRs
  • func NewQR(content string) (QRs, error)

Functions

func NewCSV

func NewCSV() *csv

New - to initialize CSV struct object fileName: by default should be "generated-csv.csv"

func NewExcel

func NewExcel(options *ExcelOptions) *excel

New - to initialize Excel struct object fileName: by default should be "generated.xlsx"

Types

type Banner

type Banner struct {
	BgProperty
	// contains filtered or unexported fields
}

func NewBanner

func NewBanner(opts ...Options) *Banner

NewBanner - by default will be w: 1200, h: 400, bgColor: white

func (*Banner) AddImageLayer

func (b *Banner) AddImageLayer(img *ImageLayer) Banners

func (*Banner) AddLabel

func (b *Banner) AddLabel(labelText *Label) Banners

func (*Banner) Generate

func (b *Banner) Generate() Banners

func (*Banner) Image

func (b *Banner) Image() image.Image

func (*Banner) Save

func (b *Banner) Save(destPath string) error

type Banners

type Banners interface {
	AddImageLayer(img *ImageLayer) Banners
	AddLabel(labelText *Label) Banners
	Generate() Banners
	Image() image.Image
	Save(destPath string) error
}

type BgProperty

type BgProperty struct {
	Width   int
	Height  int
	BgColor color.Color
}

BgProperty is background property struct

type CSVs

type CSVs interface {
	SetFileName(fileName string) CSVs
	AppendDataRow(data []string) CSVs
	SetHeader(data []string) CSVs
	Generate() error
}

type ConverterOptions

type ConverterOptions struct {
	PageSize     string
	MarginBottom uint
	MarginTop    uint
	MarginLeft   uint
	MarginRight  uint
}

type ExcelOptions

type ExcelOptions struct {
	Source string
	File   interface{}
}

type Excels

type Excels interface {
	SetFileName(fileName string) Excels
	GetExcelFile() *excelize.File
	Error() error
	SetSheetName(sheetName string) Excels
	AppendDataRow(data []string) Excels
	SetHeader(data []string) Excels
	ScanContentToStruct(sheetName string, destinationStruct interface{}) error
	GetContents(sheetName string) ([]map[string]string, error)
	GetMergeCell(sheetName string) ([]excelize.MergeCell, error)
	Generate() error
}

type ImageLayer

type ImageLayer struct {
	Image image.Image
	XPos  int
	YPos  int
}

ImageLayer is a struct

type Label

type Label struct {
	Text        string
	FontPath    string
	FontType    string
	Size        float64
	Color       color.Color
	DPI         float64
	Spacing     float64
	XPos        int
	YPos        int
	RightMargin float64
}

Label is a struct

type Options

type Options func(*Banner)

func WithBackgroudColor

func WithBackgroudColor(hexColor string) Options

func WithHeight

func WithHeight(height int) Options

func WithWidth

func WithWidth(width int) Options

type PDF

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

func NewPDF

func NewPDF(options ...*ConverterOptions) (*PDF, error)

func (*PDF) Error

func (c *PDF) Error() error

func (*PDF) Generate

func (c *PDF) Generate() error

func (*PDF) SetFileName

func (c *PDF) SetFileName(fileName *string) PDFs

func (*PDF) SetFooterHTMLTemplate

func (c *PDF) SetFooterHTMLTemplate(footerHTMLPath string) PDFs

func (*PDF) SetTemplate

func (c *PDF) SetTemplate(templatePath string, data interface{}) PDFs

type PDFs

type PDFs interface {
	SetTemplate(templatePath string, data interface{}) PDFs
	SetFooterHTMLTemplate(footerHTMLPath string) PDFs
	SetFileName(fileName *string) PDFs
	Generate() error
	Error() error
}

type QR

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

func (*QR) Generate

func (q *QR) Generate() error

func (*QR) SetFileName

func (q *QR) SetFileName(fileName *string) QRs

func (*QR) SetLogoImg

func (q *QR) SetLogoImg(logoPath string) QRs

type QRs

type QRs interface {
	SetLogoImg(logoPath string) QRs
	SetFileName(fileName *string) QRs
	Generate() error
}

func NewQR

func NewQR(content string) (QRs, error)