plain

Documentation

Overview

Package plain exposes functions for rendering vertical projections of treemaps

Index

• func Image(tree *treemap.Block, width, height float64) (image.Image, error)
• func NewGIF(tree *treemap.Block, width, height float64) (io.WriterTo, error)
• func NewJPEG(tree *treemap.Block, width, height float64) (io.WriterTo, error)
• func NewPNG(tree *treemap.Block, width, height float64) (io.WriterTo, error)

Examples

• NewGIF
• NewJPEG
• NewPNG

Functions

func Image

func Image(tree *treemap.Block, width, height float64) (image.Image, error)

Image returns an image of the tree using a vertincal projection of the treemap

func NewGIF

func NewGIF(tree *treemap.Block, width, height float64) (io.WriterTo, error)

NewGIF returns the image of the received tree encoded as a GIF

Example

encoder, err := NewGIF(block, 1024, 768)
if err != nil {
	fmt.Println(err.Error())
}
buf := new(bytes.Buffer)
fmt.Println(encoder.WriteTo(buf))
fmt.Println(ioutil.WriteFile("../docs/plain.gif", buf.Bytes(), 0644))

Output:

44119 <nil>
<nil>

func NewJPEG

func NewJPEG(tree *treemap.Block, width, height float64) (io.WriterTo, error)

NewJPEG returns the image of the received tree encoded as a JPEG

Example

encoder, err := NewJPEG(block, 1024, 768)
if err != nil {
	fmt.Println(err.Error())
}
buf := new(bytes.Buffer)
fmt.Println(encoder.WriteTo(buf))
fmt.Println(ioutil.WriteFile("../docs/plain.jpg", buf.Bytes(), 0644))

Output:

59797 <nil>
<nil>

func NewPNG

func NewPNG(tree *treemap.Block, width, height float64) (io.WriterTo, error)

NewPNG returns the image of the received tree encoded as a PNG

Example

encoder, err := NewPNG(block, 1024, 768)
if err != nil {
	fmt.Println(err.Error())
}
buf := new(bytes.Buffer)
fmt.Println(encoder.WriteTo(buf))
fmt.Println(ioutil.WriteFile("../docs/plain.png", buf.Bytes(), 0644))

Output:

6350 <nil>
<nil>