roadmap2

Documentation

Overview

roadmap2 represents a simplified set of data structures to represent a roadmap.

Index

• type Cell
• type Cells
  • func (c Cells) MaxCellItemsLength() int
• type Item
• type Items
• type Roadmap
  • func (r *Roadmap) ItemsByStream(streamName string) []Item
  • func (r *Roadmap) Streams(includeUnknown, includeUnassigned bool) ([]Stream, error)
  • func (r *Roadmap) Table(includeUnknown, includeUnassigned bool) (table.Table, error)
  • func (r *Roadmap) UnknownStreams() []string
• type Stream

Types

type Cell

type Cell struct {
	ColumnName string
	RowName    string
	Items      Items
}

Cell represents a cell of Roadmap Items where defined by a `ColumnName` and `RowName` where the row name is the Roadmap stream name.

type Cells

type Cells []Cell

func (Cells) MaxCellItemsLength

func (c Cells) MaxCellItemsLength() int

type Item

type Item struct {
	Name        string
	Description string
	ReleaseTime time.Time
	StreamName  string
}

Item represents a "roadmap item" or box on a roadmap slide.

type Items

type Items []Item

type Roadmap

type Roadmap struct {
	Name         string
	StreamNames  []string
	Columns      table.Columns // Includes Stream Title
	Items        []Item
	ItemCellFunc func(i Item) (colIdx int) // negative means don't use. colIdx is without Stream Title Column
}

Roadmap is a generic data structure to hold roadmap items.

func (*Roadmap) ItemsByStream

func (r *Roadmap) ItemsByStream(streamName string) []Item

func (*Roadmap) Streams

func (r *Roadmap) Streams(includeUnknown, includeUnassigned bool) ([]Stream, error)

Streams returns a slice of `Stream`.

func (*Roadmap) Table

func (r *Roadmap) Table(includeUnknown, includeUnassigned bool) (table.Table, error)

Table returns a `table` representing a roadmap slide. It can be used to generate CSV or XLSX files.

func (*Roadmap) UnknownStreams

func (r *Roadmap) UnknownStreams() []string

type Stream

type Stream struct {
	Name  string
	Cells Cells
}

Stream represents the horizontal swimlane on a roadmap chart.