canvas

package

v1.0.5 Latest Latest Go to latest Published: Jan 11, 2022 License: MIT Imports: 5 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/esimov/diagram

Links

Open Source Insights

Documentation ¶

Overview ¶

The Draw method signature declared in the Drawer interface implements the method separately on Line and Text struct.

Index ¶

Constants
func DrawDiagram(content string, output string, fontPath string) error
func X(x float64) float64
func Y(y float64) float64
type Canvas
- func NewCanvas(ctx *gg.Context, font string, lineWidth float64) *Canvas
type Diagram
- func (d *Diagram) ParseASCIIArt(str string) []*Figures
type Drawer
type Figures
type Line
- func NewLine(x0, y0 int, start string, x1, y1 int, end string, color string) *Line
- func (line *Line) Draw(ctx *Canvas)
type Point
- func NewPoint(x, y int) *Point
type Text
- func NewText(x0, y0 int, text, color string) *Text
- func (text *Text) Draw(ctx *Canvas)

Constants ¶

View Source

const CellSize float64 = 20

CellSize defines symbol's cell size.

Variables ¶

This section is empty.

Functions ¶

func DrawDiagram ¶

func DrawDiagram(content string, output string, fontPath string) error

DrawDiagram generates the diagram and saves into the image file.

func X ¶

func X(x float64) float64

X returns the symbols x position.

func Y ¶

func Y(y float64) float64

Y returns the symbol y position.

Types ¶

type Canvas ¶

type Canvas struct {
	*gg.Context
	// contains filtered or unexported fields
}

Canvas defines the canvas basic elements.

func NewCanvas ¶

func NewCanvas(ctx *gg.Context, font string, lineWidth float64) *Canvas

NewCanvas is a constructor method, which instantiates a new Canvas element.

type Diagram ¶

type Diagram struct{}

Diagram defines a basic empty struct.

func (*Diagram) ParseASCIIArt ¶

func (d *Diagram) ParseASCIIArt(str string) []*Figures

ParseASCIIArt parses a given ASCII string into a list of figures.

type Drawer ¶

type Drawer interface {
	Draw(*Canvas)
}

Drawer interface defines the Canvas drawing method. Struct needs to implement the Draw method.

type Figures ¶

type Figures struct {
	Line
	Text
}

Figures defines a compounded struct containing the Line and Text struct elements.

type Line ¶

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

Line struct defines the line x & y coordinates, the starting and ending type and the color.

func NewLine ¶

func NewLine(x0, y0 int, start string, x1, y1 int, end string, color string) *Line

NewLine draws a new line from (x0, y0) to (x1, y1) with the given color at the start and end symbol.

func (*Line) Draw ¶

func (line *Line) Draw(ctx *Canvas)

Draw draws a line from (x0, y0) to (x1, y1) with the given color.

type Point ¶

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

Point is an auxiliary struct used during parsing.

func NewPoint ¶

func NewPoint(x, y int) *Point

NewPoint instantiates a new Point.

type Text ¶

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

Text struct containing the text x and y coordinates and the color.

func NewText ¶

func NewText(x0, y0 int, text, color string) *Text

NewText returns a new text annotation at (x0, y0) with the given color.

func (*Text) Draw ¶

func (text *Text) Draw(ctx *Canvas)

Draw draws the text annotation at (x0, y0) with the given color.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL