code

Documentation

Overview

Package code implements creation of Barcode, MatrixCode and QrCode. nolint:dupl // It's similar to Barcode.go and it's hard to extract common code.

Package code implements creation of Barcode, MatrixCode and QrCode. nolint:dupl

Package code implements creation of Barcode, MatrixCode and QrCode. nolint:dupl

Index

• func NewBar(code string, ps ...props.Barcode) core.Component
• func NewBarCol(size int, code string, ps ...props.Barcode) core.Col
• func NewBarRow(height float64, code string, ps ...props.Barcode) core.Row
• func NewMatrix(code string, barcodeProps ...props.Rect) core.Component
• func NewMatrixCol(size int, code string, ps ...props.Rect) core.Col
• func NewMatrixRow(height float64, code string, ps ...props.Rect) core.Row
• func NewQr(code string, barcodeProps ...props.Rect) core.Component
• func NewQrCol(size int, code string, ps ...props.Rect) core.Col
• func NewQrRow(height float64, code string, ps ...props.Rect) core.Row
• type Barcode
  • func (b *Barcode) GetStructure() *node.Node[core.Structure]
  • func (b *Barcode) Render(provider core.Provider, cell *entity.Cell)
  • func (b *Barcode) SetConfig(config *entity.Config)
• type MatrixCode
  • func (m *MatrixCode) GetStructure() *node.Node[core.Structure]
  • func (m *MatrixCode) Render(provider core.Provider, cell *entity.Cell)
  • func (m *MatrixCode) SetConfig(config *entity.Config)
• type QrCode
  • func (q *QrCode) GetStructure() *node.Node[core.Structure]
  • func (q *QrCode) Render(provider core.Provider, cell *entity.Cell)
  • func (q *QrCode) SetConfig(config *entity.Config)

Examples

• NewBar
• NewBarCol
• NewBarRow

Functions

func NewBar

func NewBar(code string, ps ...props.Barcode) core.Component

NewBar is responsible to create an instance of a Barcode.

• code: The value that must be placed in the barcode
• ps: A set of settings that must be applied to the barcode

Example

ExampleNewBar demonstrates how to generate a barcode and add it to maroto

mrt := maroto.New()
m := maroto.NewMetricsDecorator(mrt)

m.AddRow(10, col.New(6).Add(code.NewBar("123456789", props.Barcode{Percent: 70.5})))

// generate document

func NewBarCol

func NewBarCol(size int, code string, ps ...props.Barcode) core.Col

NewBarCol is responsible to create an instance of a Barcode wrapped in a Col.

• size: O tamanho da coluna
• code: The value that must be placed in the barcode
• ps: A set of settings that must be applied to the barcode

Example

ExampleNewBar demonstrates how to generate a column with a barcode and add it to maroto

mrt := maroto.New()
m := maroto.NewMetricsDecorator(mrt)

m.AddRow(10, code.NewBarCol(6, "123456", props.Barcode{Percent: 70.5}))

// generate document

func NewBarRow

func NewBarRow(height float64, code string, ps ...props.Barcode) core.Row

NewBarRow is responsible to create an instance of a Barcode wrapped in a Row. using this method the col size will be automatically set to the maximum value

• height: The height of the line
• code: The value that must be placed in the barcode
• ps: A set of settings that must be applied to the barcode

Example

ExampleNewBarRow demonstrates how to generate a row with a barcode and add it to maroto

mrt := maroto.New()
m := maroto.NewMetricsDecorator(mrt)

m.AddRows(code.NewBarRow(10, "123456789", props.Barcode{Percent: 70.5}))

// generate document

func NewMatrix

func NewMatrix(code string, barcodeProps ...props.Rect) core.Component

NewMatrix is responsible to create an instance of a MatrixCode.

func NewMatrixCol

func NewMatrixCol(size int, code string, ps ...props.Rect) core.Col

NewMatrixCol is responsible to create an instance of a MatrixCode wrapped in a Col.

func NewMatrixRow

func NewMatrixRow(height float64, code string, ps ...props.Rect) core.Row

NewMatrixRow is responsible to create an instance of a MatrixCode wrapped in a Row.

func NewQr

func NewQr(code string, barcodeProps ...props.Rect) core.Component

NewQr is responsible to create an instance of a QrCode.

func NewQrCol

func NewQrCol(size int, code string, ps ...props.Rect) core.Col

NewQrCol is responsible to create an instance of a QrCode wrapped in a Col.

func NewQrRow

func NewQrRow(height float64, code string, ps ...props.Rect) core.Row

NewQrRow is responsible to create an instance of a QrCode wrapped in a Row.

Types

type Barcode

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

func (*Barcode) GetStructure

func (b *Barcode) GetStructure() *node.Node[core.Structure]

GetStructure returns the structure of a barcode. This method is typically used when creating tests

func (*Barcode) Render

func (b *Barcode) Render(provider core.Provider, cell *entity.Cell)

Render renders a Barcode into a PDF context. The maroto cal this methodo in process to generate the pdf.

• provider: Is the creator provider used to generate the pdf
• cell: cell represents the space available to draw the component

func (*Barcode) SetConfig

func (b *Barcode) SetConfig(config *entity.Config)

SetConfig sets the configuration of a Barcode.

type MatrixCode

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

func (*MatrixCode) GetStructure

func (m *MatrixCode) GetStructure() *node.Node[core.Structure]

GetStructure returns the Structure of a MatrixCode.

func (*MatrixCode) Render

func (m *MatrixCode) Render(provider core.Provider, cell *entity.Cell)

Render renders a MatrixCode into a PDF context.

func (*MatrixCode) SetConfig

func (m *MatrixCode) SetConfig(config *entity.Config)

SetConfig sets the configuration of a MatrixCode.

type QrCode

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

func (*QrCode) GetStructure

func (q *QrCode) GetStructure() *node.Node[core.Structure]

GetStructure returns the Structure of a QrCode.

func (*QrCode) Render

func (q *QrCode) Render(provider core.Provider, cell *entity.Cell)

Render renders a QrCode into a PDF context.

func (*QrCode) SetConfig

func (q *QrCode) SetConfig(config *entity.Config)

SetConfig set the config for the component.