props

Documentation

Index

• type Barcode
  • func (s *Barcode) MakeValid()
• type Font
  • func (s *Font) MakeValid()
  • func (s *Font) ToTextProp(align consts.Align, top float64, extrapolate bool, verticalPadding float64) Text
• type Proportion
• type Rect
  • func (s *Rect) MakeValid()
• type TableList
  • func (s *TableList) MakeValid(header []string, contents [][]string)
• type TableListContent
  • func (s *TableListContent) ToTextProp(align consts.Align, top float64, extrapolate bool, verticalPadding float64) Text
• type Text
  • func (s *Text) MakeValid()

Types

type Barcode

type Barcode struct {
	// Left is the space between the left cell boundary to the barcode, if center is false
	Left float64
	// Top is space between the upper cell limit to the barcode, if center is false
	Top float64
	// Percent is how much the barcode will occupy the cell,
	// ex 100%: The barcode will fulfill the entire cell
	// ex 50%: The greater side from the barcode will have half the size of the cell
	Percent float64
	// Proportion is the proportion between size of the barcode
	// Ex: 16x9, 4x3...
	Proportion Proportion
	// Center define that the barcode will be vertically and horizontally centralized
	Center bool
}

Barcode represents properties from a barcode inside a cell

func (*Barcode) MakeValid

func (s *Barcode) MakeValid()

MakeValid from Barcode will make the properties from a barcode reliable to fit inside a cell and define default values for a barcode

type Font

type Font struct {
	// Family of the text, ex: consts.Arial, helvetica and etc
	Family consts.Family
	// Style of the text, ex: consts.Normal, bold and etc
	Style consts.Style
	// Size of the text
	Size float64
}

Font represents properties from a text

func (*Font) MakeValid

func (s *Font) MakeValid()

MakeValid from Font define default values for a Signature

func (*Font) ToTextProp

func (s *Font) ToTextProp(align consts.Align, top float64, extrapolate bool, verticalPadding float64) Text

ToTextProp from Font return a Text based on Font

type Proportion

type Proportion struct {
	// Width from the rectangle: Barcode, image and etc
	Width float64
	// Height from the rectangle: Barcode, image and etc
	Height float64
}

Proportion represents a proportion from a rectangle, example: 16x9, 4x3...

type Rect

type Rect struct {
	// Left is the space between the left cell boundary to the rectangle, if center is false
	Left float64
	// Top is space between the upper cell limit to the barcode, if center is false
	Top float64
	// Percent is how much the rectangle will occupy the cell,
	// ex 100%: The rectangle will fulfill the entire cell
	// ex 50%: The greater side from the rectangle will have half the size of the cell
	Percent float64
	// Center define that the barcode will be vertically and horizontally centralized
	Center bool
}

Rect represents properties from a rectangle (Image, QrCode or Barcode) inside a cell

func (*Rect) MakeValid

func (s *Rect) MakeValid()

MakeValid from Rect will make the properties from a rectangle reliable to fit inside a cell and define default values for a rectangle

type TableList

type TableList struct {
	// HeaderProp is the custom properties of the text inside
	// the headers
	HeaderProp TableListContent
	// ContentProp is the custom properties of the text inside
	// the contents
	ContentProp TableListContent
	// Align is the align of the text (header and content) inside the columns
	Align consts.Align
	// AlternatedBackground define the background color from even rows
	// i.e rows with index (0, 2, 4, ..., N) will have background colorized,
	// rows with index (1, 3, 5, ..., N) will not
	AlternatedBackground *color.Color
	// HeaderContentSpace is the space between the header and the contents
	HeaderContentSpace float64
	// Line adds a line after every content-row to separate rows. The line's spaceHeight is set to 1.0
	Line bool
}

TableList represents properties from a TableList

func (*TableList) MakeValid

func (s *TableList) MakeValid(header []string, contents [][]string)

MakeValid from TableList define default values for a TableList

type TableListContent

type TableListContent struct {
	// Family of the text, ex: consts.Arial, helvetica and etc
	Family consts.Family
	// Style of the text, ex: consts.Normal, bold and etc
	Style consts.Style
	// Size of the text
	Size float64
	// GridSizes is the custom properties of the size of the grid
	// the sum of the values cannot be greater than 12, if this
	// value is not provided the width of all columns will be the
	// same
	GridSizes []uint
}

TableListContent represents properties from a line (header/content) from a TableList

func (*TableListContent) ToTextProp

func (s *TableListContent) ToTextProp(align consts.Align, top float64, extrapolate bool, verticalPadding float64) Text

ToTextProp from Font return a TableListContent based on Font

type Text

type Text struct {
	// Top is space between the upper cell limit to the barcode, if align is not center
	Top float64
	// Family of the text, ex: consts.Arial, helvetica and etc
	Family consts.Family
	// Style of the text, ex: consts.Normal, bold and etc
	Style consts.Style
	// Size of the text
	Size float64
	// Align of the text
	Align consts.Align
	// Extrapolate define if the text will automatically add a new line when
	// text reach the right cell boundary
	Extrapolate bool
	// VerticalPadding define an additional space between lines
	VerticalPadding float64
}

Text represents properties from a Text inside a cell

func (*Text) MakeValid

func (s *Text) MakeValid()

MakeValid from Text define default values for a Text