line

Documentation

Overview

Package line implements creation of lines.

Index

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

Examples

• New
• NewCol
• NewRow

Functions

func New

func New(ps ...props.Line) core.Component

New is responsible to create an instance of a Line.

Example

ExampleNew demonstrates how create a line component.

m := maroto.New()

line := line.New()
col := col.New(12).Add(line)
m.AddRow(10, col)

// generate document

func NewAutoRow

func NewAutoRow(ps ...props.Line) core.Row

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

func NewCol

func NewCol(size int, ps ...props.Line) core.Col

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

Example

ExampleNewCol demonstrates how to crete a line wrapped into a column.

m := maroto.New()

lineCol := line.NewCol(12)
m.AddRow(10, lineCol)

// generate document

func NewRow

func NewRow(height float64, ps ...props.Line) core.Row

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

Example

ExampleNewRow demonstrates how to crete a line wrapped into a row.

m := maroto.New()

lineRow := line.NewRow(10)
m.AddRows(lineRow)

// generate document

Types

type Line

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

func (*Line) GetHeight

func (l *Line) GetHeight(provider core.Provider, cell *entity.Cell) float64

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

func (*Line) GetStructure

func (l *Line) GetStructure() *node.Node[core.Structure]

GetStructure returns the Structure of a Line.

func (*Line) Render

func (l *Line) Render(provider core.Provider, cell *entity.Cell)

Render renders a Line into a PDF context.

func (*Line) SetConfig

func (l *Line) SetConfig(config *entity.Config)

SetConfig sets the config.