props

Documentation

Index

• Variables
• type Barcode
  • func (b *Barcode) MakeValid()
  • func (b *Barcode) ToMap() map[string]interface{}
  • func (b *Barcode) ToRectProp() *Rect
• type Cell
  • func (c *Cell) ToMap() map[string]interface{}
• type Color
  • func (c *Color) ToString() string
• type Font
  • func (f *Font) AppendMap(m map[string]interface{}) map[string]interface{}
  • func (f *Font) MakeValid(defaultFamily string)
  • func (f *Font) ToTextProp(align align.Type, top float64, verticalPadding float64) *Text
• type Line
  • func (l *Line) MakeValid()
  • func (l *Line) ToMap() map[string]interface{}
• type Page
  • func (p *Page) GetNumberTextProp(height float64) *Text
  • func (p *Page) GetPageString(current, total int) string
• type Place
  • func (p Place) IsValid() bool
• type Proportion
• type Rect
  • func (r *Rect) MakeValid()
  • func (r *Rect) ToMap() map[string]interface{}
• type Signature
  • func (s *Signature) MakeValid(defaultFontFamily string)
  • func (s *Signature) ToFontProp() *Font
  • func (s *Signature) ToLineProp(offsetPercent float64) *Line
  • func (s *Signature) ToMap() map[string]interface{}
  • func (s *Signature) ToTextProp(align align.Type, top float64, verticalPadding float64) *Text
• type Text
  • func (t *Text) MakeValid(font *Font)
  • func (t *Text) ToMap() map[string]interface{}

Variables

var (
	WhiteColor = Color{Red: 255, Green: 255, Blue: 255}
	BlackColor = Color{Red: 0, Green: 0, Blue: 0}
	RedColor   = Color{Red: 255, Green: 0, Blue: 0}
	GreenColor = Color{Red: 0, Green: 255, Blue: 0}
	BlueColor  = Color{Red: 0, Green: 0, Blue: 255}
)

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 (b *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.

func (*Barcode) ToMap

func (b *Barcode) ToMap() map[string]interface{}

func (*Barcode) ToRectProp

func (b *Barcode) ToRectProp() *Rect

type Cell

type Cell struct {
	BackgroundColor *Color
	BorderColor     *Color
	BorderType      border.Type
	BorderThickness float64
	LineStyle       linestyle.Type
}

func (*Cell) ToMap

func (c *Cell) ToMap() map[string]interface{}

type Color

type Color struct {
	// Red is the amount of red
	Red int
	// Green is the amount of red
	Green int
	// Blue is the amount of red
	Blue int
}

Color represents a color in the RGB (Red, Green, Blue) space, is possible mix values, when all values are 0 the result color is black when all values are 255 the result color is white.

func (*Color) ToString

func (c *Color) ToString() string

type Font

type Font struct {
	// Family of the text, ex: constf.Arial, helvetica and etc.
	Family string
	// Style of the text, ex: constf.Normal, bold and etc.
	Style fontstyle.Type
	// Size of the text.
	Size float64
	// Color define the font color.
	Color *Color
}

Font represents properties from a text.

func (*Font) AppendMap

func (f *Font) AppendMap(m map[string]interface{}) map[string]interface{}

func (*Font) MakeValid

func (f *Font) MakeValid(defaultFamily string)

MakeValid from Font define default values for a Signature.

func (*Font) ToTextProp

func (f *Font) ToTextProp(align align.Type, top float64, verticalPadding float64) *Text

ToTextProp from Font return a Text based on Font.

type Line

type Line struct {
	// Color define the line color.
	Color *Color
	// Style define the line style (solid or dashed).
	Style linestyle.Type
	// Thickness define the line thicknesl.
	Thickness float64
	// Orientation define if line would be horizontal or vertical.
	Orientation orientation.Type
	// OffsetPercent define where the line would be placed, 0 is the start of cell, 50 the middle and 100 the end.
	OffsetPercent float64
	// SizePercent define the size of the line inside cell.
	SizePercent float64
}

Line represents properties from a Line inside a cell.

func (*Line) MakeValid

func (l *Line) MakeValid()

MakeValid from Line define default values for a Line.

func (*Line) ToMap

func (l *Line) ToMap() map[string]interface{}

type Page

type Page struct {
	Pattern string
	Place   Place
	Family  string
	Style   fontstyle.Type
	Size    float64
	Color   *Color
}

func (*Page) GetNumberTextProp

func (p *Page) GetNumberTextProp(height float64) *Text

func (*Page) GetPageString

func (p *Page) GetPageString(current, total int) string

type Place

type Place string

const (
	LeftTop     Place = "left_top"
	Top         Place = "top"
	RightTop    Place = "right_top"
	LeftBottom  Place = "left_bottom"
	Bottom      Place = "bottom"
	RightBottom Place = "right_bottom"
)

func (Place) IsValid

func (p Place) IsValid() bool

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 (r *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.

func (*Rect) ToMap

func (r *Rect) ToMap() map[string]interface{}

type Signature

type Signature struct {
	// FontFamily of the text, ex: consts.Arial, helvetica and etc.
	FontFamily string
	// FontStyle of the text, ex: consts.Normal, bold and etc.
	FontStyle fontstyle.Type
	// FontSize of the text.
	FontSize float64
	// FontColor define the font color.
	FontColor *Color
	// LineColor define the line color.
	LineColor *Color
	// LineStyle define the line style (solid or dashed).
	LineStyle linestyle.Type
	// LineThickness define the line thickness.
	LineThickness float64
}

Signature represents properties from a signature.

func (*Signature) MakeValid

func (s *Signature) MakeValid(defaultFontFamily string)

func (*Signature) ToFontProp

func (s *Signature) ToFontProp() *Font

func (*Signature) ToLineProp

func (s *Signature) ToLineProp(offsetPercent float64) *Line

func (*Signature) ToMap

func (s *Signature) ToMap() map[string]interface{}

func (*Signature) ToTextProp

func (s *Signature) ToTextProp(align align.Type, top float64, verticalPadding float64) *Text

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: constt.Arial, helvetica and etc.
	Family string
	// Style of the text, ex: constt.Normal, bold and etc.
	Style fontstyle.Type
	// Size of the text.
	Size float64
	// Align of the text.
	Align             align.Type
	BreakLineStrategy breakline.Strategy
	// VerticalPadding define an additional space between linet.
	VerticalPadding float64
	// Color define the fontstyle color.
	Color *Color
}

Text represents properties from a Text inside a cell.

func (*Text) MakeValid

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

MakeValid from Text define default values for a Text.

func (*Text) ToMap

func (t *Text) ToMap() map[string]interface{}