signature

Documentation

Overview

Package signature implements creation of signatures.

Index

• func New(value string, ps ...props.Signature) core.Component
• func NewAutoRow(value string, ps ...props.Signature) core.Row
• func NewCol(size int, value string, ps ...props.Signature) core.Col
• func NewRow(height float64, value string, ps ...props.Signature) core.Row
• type Signature
  • func (s *Signature) GetHeight(provider core.Provider, cell *entity.Cell) float64
  • func (s *Signature) GetStructure() *node.Node[core.Structure]
  • func (s *Signature) Render(provider core.Provider, cell *entity.Cell)
  • func (s *Signature) SetConfig(config *entity.Config)

Examples

• New
• NewCol
• NewRow

Functions

func New

func New(value string, ps ...props.Signature) core.Component

New is responsible to create an instance of a Signature.

Example

ExampleNew demonstrates how to create a signature component.

m := maroto.New()

signature := signature.New("signature label")
col := col.New(12).Add(signature)
m.AddRow(10, col)

// generate document

func NewAutoRow

func NewAutoRow(value string, ps ...props.Signature) core.Row

NewRow is responsible to create an instance of a Signature wrapped in a automatic Row.

func NewCol

func NewCol(size int, value string, ps ...props.Signature) core.Col

NewCol is responsible to create an instance of a Signature wrapped in a Col.

Example

ExampleNewCol demonstrates how to create a signature component wrapped into a column.

m := maroto.New()

signatureCol := signature.NewCol(12, "signature label")
m.AddRow(10, signatureCol)

// generate document

func NewRow

func NewRow(height float64, value string, ps ...props.Signature) core.Row

NewRow is responsible to create an instance of a Signature wrapped in a Row.

Example

ExampleNewRow demonstrates how to create a signature component wrapped into a row.

m := maroto.New()

signatureRow := signature.NewRow(10, "signature label")
m.AddRows(signatureRow)

// generate document

Types

type Signature

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

func (*Signature) GetHeight

func (s *Signature) GetHeight(provider core.Provider, cell *entity.Cell) float64

GetHeight returns the height that the signature will have in the PDF

func (*Signature) GetStructure

func (s *Signature) GetStructure() *node.Node[core.Structure]

GetStructure returns the Structure of a Signature.

func (*Signature) Render

func (s *Signature) Render(provider core.Provider, cell *entity.Cell)

Render renders a Signature into a PDF context.

func (*Signature) SetConfig

func (s *Signature) SetConfig(config *entity.Config)

SetConfig sets the config.