scrummy

README

Scrummy

Nothing to be used right now.

Code

• Documentation: https://godoc.org/github.com/wlbr/scrummy
• Lint: http://go-lint.appspot.com/github.com/wlbr/scrummy
• Continuous Integration:
• Test Coverage:
• Metrics:

Documentation

Index

• func DrawGraphs(xfile string)
• func GetFloatColumn(rows [][]string, columnindex int, offset int) []float64
• type Chart
• type Exporter
• type Importer
• type LineChart
  • func NewLineChart(xaxis, yaxisL []float64, xlegend, ylegendR string) *LineChart
  • func (l *LineChart) AddValues(values []float64, legend string) int
  • func (l *LineChart) Legend() []string
  • func (l *LineChart) SetYAxisR(values []float64, title string)
  • func (l *LineChart) ValueMatrix() [][]float64
  • func (l *LineChart) Values(i int) []float64
  • func (l *LineChart) Xaxis() []float64
  • func (l *LineChart) Xlegend() string
  • func (l *LineChart) YaxisL() []float64
  • func (l *LineChart) YaxisR() []float64
  • func (l *LineChart) YlegendL() string
  • func (l *LineChart) YlegendR() string
• type Session
• type Set
  • func NewSet(name string, data []float64, series *chart.Series) *Set
• type Visualizer
  • func NewVisualizer() *Visualizer
  • func (v Visualizer) Render()
• type XlsxImporter
  • func NewXlsxImporter() *XlsxImporter
  • func (x XlsxImporter) Read(s Session)

Functions

func DrawGraphs

func DrawGraphs(xfile string)

DrawGraphs - well, it draws the graphs

func GetFloatColumn

func GetFloatColumn(rows [][]string, columnindex int, offset int) []float64

GetFloatColumn retrieves a column as a float array out of a string array of rows.

Types

type Chart

type Chart interface {
	Xaxis() []float64
	Yaxis() []float64
	Xlegend() string
	Ylegend() string
	Values() []float64
	Legend() []string
}

Chart represents each graph build of a coodinates system and (possibly multiple) data lines.

type Exporter

type Exporter interface {
	Generate(session Session)
}

Exporter export the internal object model to different data format. E.g. PDF, HTML, CSV ...

type Importer

type Importer interface {
	Read(session Session) Session
}

Importer x import a boards data into the internal object model.

type LineChart

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

LineChart is a diagram with one or more data lines.

func NewLineChart

func NewLineChart(xaxis, yaxisL []float64, xlegend, ylegendR string) *LineChart

NewLineChart is the constructor for LineChart.

func (*LineChart) AddValues

func (l *LineChart) AddValues(values []float64, legend string) int

AddValues adds a new dataset (line) and its legend to the chart. It returns the index of the added dataset.

func (*LineChart) Legend

func (l *LineChart) Legend() []string

Legend retrieves the titles of the line plots.

func (*LineChart) SetYAxisR

func (l *LineChart) SetYAxisR(values []float64, title string)

SetYAxisR set the values and the title for the optional right y-axis.

func (*LineChart) ValueMatrix

func (l *LineChart) ValueMatrix() [][]float64

ValueMatrix retrieves the values of the line plots.

func (*LineChart) Values

func (l *LineChart) Values(i int) []float64

Values retrieves the values of the line plots.

func (*LineChart) Xaxis

func (l *LineChart) Xaxis() []float64

Xaxis retrieves the values of the x-axis.

func (*LineChart) Xlegend

func (l *LineChart) Xlegend() string

Xlegend retrieves the title of the x-axis.

func (*LineChart) YaxisL

func (l *LineChart) YaxisL() []float64

YaxisL retrieves the values of the left y-axis.

func (*LineChart) YaxisR

func (l *LineChart) YaxisR() []float64

YaxisR retrieves the values of the right y-axis.

func (*LineChart) YlegendL

func (l *LineChart) YlegendL() string

YlegendL retrieves the title of the left y-axis.

func (*LineChart) YlegendR

func (l *LineChart) YlegendR() string

YlegendR retrieves the title of the right y-axis.

type Session

type Session interface {
	Config() tools.CommonConfig
	Read() Session
	Generate()
}

A Session represents a list of configurations of graphs to be generated

type Set

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

A Set represents a set of data on the chart, probably a line.

func NewSet

func NewSet(name string, data []float64, series *chart.Series) *Set

NewSet constructs a new object of type Set.

type Visualizer

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

A Visualizer renders controls the generation of a set of graphs.

func NewVisualizer

func NewVisualizer() *Visualizer

NewVisualizer constructs a new object of type Visualizer.

func (Visualizer) Render

func (v Visualizer) Render()

Render draws the contents of a Visualizer.

type XlsxImporter

type XlsxImporter struct {
}

XlsxImporter is

func NewXlsxImporter

func NewXlsxImporter() *XlsxImporter

NewXlsxImporter is a constructor for the struct XlsxImporter.

func (XlsxImporter) Read

func (x XlsxImporter) Read(s Session)