plot

Documentation

Overview

Package plot provides library code to for rendering hex coordinates grids

Index

• type Cell
• type CellStyle
• type CellStyleFunc
• type Figure
  • func NewFigure() *Figure
  • func (f *Figure) AddCoord(coord coord.Coord)
  • func (f *Figure) AddCoords(coords coord.Coords)
  • func (f *Figure) AddStyledCoord(coord coord.Coord, style Style)
  • func (f *Figure) AddStyledCoords(coords coord.Coords, style Style)
  • func (f *Figure) Render(writer io.Writer) error
  • func (f *Figure) RenderFile(name string) error
  • func (f *Figure) SetCoordType(coordType consts.CoordType)
  • func (f *Figure) SetOrientation(orientation consts.Orientation)
  • func (f *Figure) SetTheme(theme *Theme)
• type Style
  • func (s Style) Color(color color.RGBA) Style
  • func (s Style) FontSize(size int) Style
  • func (s Style) Name(name string) Style
• type Theme
  • func DefaultTheme() *Theme

Types

type Cell

type Cell struct {
	Coord coord.Coord
	Style *CellStyle
	Text  string
}

Cell represents a hexagon to be drawn

type CellStyle

type CellStyle struct {
	Color    color.RGBA
	FontSize int
}

CellStyle represents style for a cell

type CellStyleFunc

type CellStyleFunc func(coord coord.Coord) (string, *CellStyle)

CellStyleFunc is a function for styling a cell in the figure

type Figure

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

Figure represents a collection of hex coordinates to be plotted

func NewFigure

func NewFigure() *Figure

NewFigure returns a new Figure instance

func (*Figure) AddCoord

func (f *Figure) AddCoord(coord coord.Coord)

AddCoord adds an un-styled hex cell at the given coordinate

func (*Figure) AddCoords

func (f *Figure) AddCoords(coords coord.Coords)

AddCoords adds un-styled hex cells at the given coordinates

func (*Figure) AddStyledCoord

func (f *Figure) AddStyledCoord(coord coord.Coord, style Style)

AddStyledCoord adds a styled hex cell at the given coordinate, using the given style

func (*Figure) AddStyledCoords

func (f *Figure) AddStyledCoords(coords coord.Coords, style Style)

AddStyledCoords adds a styled hex cells at the given coordinates, using the given style

func (*Figure) Render

func (f *Figure) Render(writer io.Writer) error

Render renders the figure as an SVG to the specified writer

func (*Figure) RenderFile

func (f *Figure) RenderFile(name string) error

RenderFile renders the figure to the specified SVG file

func (*Figure) SetCoordType

func (f *Figure) SetCoordType(coordType consts.CoordType)

SetCoordType sets the coordinate system type to use for rendering coordinate values

func (*Figure) SetOrientation

func (f *Figure) SetOrientation(orientation consts.Orientation)

SetOrientation sets the orientation of the hexagons rendered by the figure

func (*Figure) SetTheme

func (f *Figure) SetTheme(theme *Theme)

SetTheme sets the theme for the figure

type Style

type Style func(coord.Coord) (string, *CellStyle)

Style represents text and cell style

func (Style) Color

func (s Style) Color(color color.RGBA) Style

Color sets the color of the cell style

func (Style) FontSize

func (s Style) FontSize(size int) Style

FontSize sets the font size of the cell style

func (Style) Name

func (s Style) Name(name string) Style

Name sets the name of the cell style

type Theme

type Theme struct {
	BackgroundColor color.RGBA
	BorderColor     color.RGBA
	CellColor       color.RGBA
	CoordQColor     color.RGBA
	CoordRColor     color.RGBA
	CoordSColor     color.RGBA
	TextColor       color.RGBA
}

Theme represents a theme for coloring a figure and its cells

func DefaultTheme

func DefaultTheme() *Theme

DefaultTheme returns the default theme for styling figures