linechart

Documentation

Overview

Package linechart contains a widget that displays line charts.

Index

• type LineChart
  • func New(opts ...Option) *LineChart
  • func (lc *LineChart) Draw(cvs *canvas.Canvas) error
  • func (lc *LineChart) Keyboard(k *terminalapi.Keyboard) error
  • func (lc *LineChart) Mouse(m *terminalapi.Mouse) error
  • func (lc *LineChart) Options() widgetapi.Options
  • func (lc *LineChart) Series(label string, values []float64, opts ...SeriesOption) error
• type Option
  • func AxesCellOpts(co ...cell.Option) Option
  • func XLabelCellOpts(co ...cell.Option) Option
  • func YAxisAdaptive() Option
  • func YLabelCellOpts(co ...cell.Option) Option
• type SeriesOption
  • func SeriesCellOpts(co ...cell.Option) SeriesOption
  • func SeriesXLabels(labels map[int]string) SeriesOption

Types

type LineChart

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

LineChart draws line charts.

Each line chart has an identifying label and a set of values that are plotted.

The size of the two axes is determined from the values. The X axis will have a number of evenly distributed data points equal to the largest count of values among all the labeled line charts. The Y axis will be sized so that it can conveniently accommodate the largest value among all the labeled line charts. This determines the used scale.

Implements widgetapi.Widget. This object is thread-safe.

func New

func New(opts ...Option) *LineChart

New returns a new line chart widget.

func (*LineChart) Draw

func (lc *LineChart) Draw(cvs *canvas.Canvas) error

Draw draws the values as line charts. Implements widgetapi.Widget.Draw.

func (*LineChart) Keyboard

func (lc *LineChart) Keyboard(k *terminalapi.Keyboard) error

Keyboard implements widgetapi.Widget.Keyboard.

func (*LineChart) Mouse

func (lc *LineChart) Mouse(m *terminalapi.Mouse) error

Mouse implements widgetapi.Widget.Mouse.

func (*LineChart) Options

func (lc *LineChart) Options() widgetapi.Options

Options implements widgetapi.Widget.Options.

func (*LineChart) Series

func (lc *LineChart) Series(label string, values []float64, opts ...SeriesOption) error

Series sets the values that should be displayed as the line chart with the provided label. Subsequent calls with the same label replace any previously provided values.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is used to provide options to New().

func AxesCellOpts

func AxesCellOpts(co ...cell.Option) Option

AxesCellOpts set the cell options for the X and Y axes.

func XLabelCellOpts

func XLabelCellOpts(co ...cell.Option) Option

XLabelCellOpts set the cell options for the labels on the X axis.

func YAxisAdaptive

func YAxisAdaptive() Option

YAxisAdaptive makes the Y axis adapt its base value depending on the provided series. Without this option, the Y axis always starts at the zero value regardless of values available in the series. When this option is specified and the series don't contain value zero, the Y axis will be adapted to the minimum value for all-positive series or the maximum value for all-negative series. The Y axis still starts at the zero value if the series contain both positive and negative values.

func YLabelCellOpts

func YLabelCellOpts(co ...cell.Option) Option

YLabelCellOpts set the cell options for the labels on the Y axis.

type SeriesOption

type SeriesOption interface {
	// contains filtered or unexported methods
}

SeriesOption is used to provide options to Series.

func SeriesCellOpts

func SeriesCellOpts(co ...cell.Option) SeriesOption

SeriesCellOpts sets the cell options for this series. Note that the braille canvas has resolution of 2x4 pixels per cell, but each cell can only have one set of cell options set. Meaning that where series share a cell, the last drawn series sets the cell options. Series are drawn in alphabetical order based on their name.

func SeriesXLabels

func SeriesXLabels(labels map[int]string) SeriesOption

SeriesXLabels is used to provide custom labels for the X axis. The argument maps the positions in the provided series to the desired label. The labels are only used if they fit under the axis. Custom labels are property of the line chart, since there is only one X axis, providing multiple custom labels overwrites the previous value.