props

Documentation

Index

• type Barcode
  • func (s *Barcode) MakeValid()
• type Font
  • func (s *Font) MakeValid(defaultFamily string)
  • func (s *Font) ToTextProp(align consts.Align, top float64, extrapolate bool, verticalPadding float64) Text
• type Line
  • func (s *Line) MakeValid(spaceHeight float64)
• type Proportion
• type Rect
  • func (s *Rect) MakeValid()
• type Style
• type Text
  • func (s *Text) MakeValid(font *Font)

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 string
	// Style of the text, ex: consts.Normal, bold and etc.
	Style consts.Style
	// Size of the text.
	Size float64
	// Color define the font color.
	Color *color.Color
}

Font represents properties from a text.

func (*Font) MakeValid

func (s *Font) MakeValid(defaultFamily string)

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 Line

type Line struct {
	// Color define the line color.
	Color color.Color
	// Style define the line style (solid, dashed or dotted).
	Style consts.LineStyle
	// Width define the line width (it cannot be greater than line height)
	Width float64
}

Line represents properties from a Line inside a cell.

func (*Line) MakeValid

func (s *Line) MakeValid(spaceHeight float64)

MakeValid from Line define default values for a Line.

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 Style

type Style struct {
	BackgroundColor *color.Color
	BorderColor     *color.Color
	Border          bool
}

type Text

type Text struct {
	// Top is the amount of space between the upper cell limit and the text.
	Top float64
	// Left is the minimal amount of space between the left cell boundary and the text.
	Left float64
	// Right is the minimal amount of space between the right cell boundary and the text.
	Right float64
	// Family of the text, ex: consts.Arial, helvetica and etc.
	Family string
	// 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
	// Color define the font color.
	Color *color.Color
}

Text represents properties from a Text inside a cell.

func (*Text) MakeValid

func (s *Text) MakeValid(font *Font)

MakeValid from Text define default values for a Text.