report

Documentation

Index

• func Render(config Config, r *Report) *table.Table
• type Collapse
• type Config
• type Options
• type Position
• type Report
  • func NewReport(options Options, bal []*balance.Balance) (*Report, error)
• type Segment
  • func NewSegment(k string) *Segment

Functions

func Render

func Render(config Config, r *Report) *table.Table

Render renders a report.

Types

type Collapse

type Collapse struct {
	Level int
	Regex *regexp.Regexp
}

Collapse is a rule for collapsing (shortening) accounts.

type Config

type Config struct {
	Commodities bool
}

Config configures a Renderer.

type Options

type Options struct {
	Value    bool
	Collapse []Collapse
}

Options contains configuration options to create a report.

type Position

type Position struct {
	balance.CommodityAccount
	Amounts amount.Vec
}

Position is a position.

type Report

type Report struct {
	Dates       []time.Time
	Options     Options
	Segments    map[accounts.AccountType]*Segment
	Commodities []*commodities.Commodity
	Positions   map[*commodities.Commodity]amount.Vec
}

Report is a balance report for a range of dates.

func NewReport

func NewReport(options Options, bal []*balance.Balance) (*Report, error)

NewReport creates a new report.

type Segment

type Segment struct {
	Key         string
	Positions   map[*commodities.Commodity]amount.Vec
	Subsegments []*Segment
}

Segment is a hierarchical segment of a report.

func NewSegment

func NewSegment(k string) *Segment

NewSegment creates a new segment.