// Copyright 2015 The Gonum Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package plot
import (
"image/color"
"io"
"math"
"os"
"path/filepath"
"strings"
"gonum.org/v1/plot/vg"
"gonum.org/v1/plot/vg/draw"
)
var (
// DefaultFont is the name of the default font for plot text.
DefaultFont = "Times-Roman"
)
// Plot is the basic type representing a plot.
type Plot struct {
Title struct {
// Text is the text of the plot title. If
// Text is the empty string then the plot
// will not have a title.
Text string
// Padding is the amount of padding
// between the bottom of the title and
// the top of the plot.
Padding vg.Length
draw.TextStyle
}
// BackgroundColor is the background color of the plot.
// The default is White.
BackgroundColor color.Color
// X and Y are the horizontal and vertical axes
// of the plot respectively.
X, Y Axis
// Legend is the plot's legend.
Legend Legend
// plotters are drawn by calling their Plot method
// after the axes are drawn.
plotters []Plotter
}
// Plotter is an interface that wraps the Plot method.
// Some standard implementations of Plotter can be
// found in the gonum.org/v1/plot/plotter
// package, documented here:
// https://godoc.org/gonum.org/v1/plot/plotter
type Plotter interface {
// Plot draws the data to a draw.Canvas.
Plot(draw.Canvas, *Plot)
}
// DataRanger wraps the DataRange method.
type DataRanger interface {
// DataRange returns the range of X and Y values.
DataRange() (xmin, xmax, ymin, ymax float64)
}
const (
vertical = true
horizontal = false
)
// New returns a new plot with some reasonable
// default settings.
func New() (*Plot, error) {
titleFont, err := vg.MakeFont(DefaultFont, 12)
if err != nil {
return nil, err
}
x, err := makeAxis(horizontal)
if err != nil {
return nil, err
}
y, err := makeAxis(vertical)
if err != nil {
return nil, err
}
legend, err := NewLegend()
if err != nil {
return nil, err
}
p := &Plot{
BackgroundColor: color.White,
X: x,
Y: y,
Legend: legend,
}
p.Title.TextStyle = draw.TextStyle{
Color: color.Black,
Font: titleFont,
XAlign: draw.XCenter,
YAlign: draw.YTop,
}
return p, nil
}
// Add adds a Plotters to the plot.
//
// If the plotters implements DataRanger then the
// minimum and maximum values of the X and Y
// axes are changed if necessary to fit the range of
// the data.
//
// When drawing the plot, Plotters are drawn in the
// order in which they were added to the plot.
func (p *Plot) Add(ps ...Plotter) {
for _, d := range ps {
if x, ok := d.(DataRanger); ok {
xmin, xmax, ymin, ymax := x.DataRange()
p.X.Min = math.Min(p.X.Min, xmin)
p.X.Max = math.Max(p.X.Max, xmax)
p.Y.Min = math.Min(p.Y.Min, ymin)
p.Y.Max = math.Max(p.Y.Max, ymax)
}
}
p.plotters = append(p.plotters, ps...)
}
// Draw draws a plot to a draw.Canvas.
//
// Plotters are drawn in the order in which they were
// added to the plot. Plotters that implement the
// GlyphBoxer interface will have their GlyphBoxes
// taken into account when padding the plot so that
// none of their glyphs are clipped.
func (p *Plot) Draw(c draw.Canvas) {
if p.BackgroundColor != nil {
c.SetColor(p.BackgroundColor)
c.Fill(c.Rectangle.Path())
}
if p.Title.Text != "" {
c.FillText(p.Title.TextStyle, vg.Point{X: c.Center().X, Y: c.Max.Y}, p.Title.Text)
c.Max.Y -= p.Title.Height(p.Title.Text) - p.Title.Font.Extents().Descent
c.Max.Y -= p.Title.Padding
}
p.X.sanitizeRange()
x := horizontalAxis{p.X}
p.Y.sanitizeRange()
y := verticalAxis{p.Y}
ywidth := y.size()
xheight := x.size()
x.draw(padX(p, draw.Crop(c, ywidth, 0, 0, 0)))
y.draw(padY(p, draw.Crop(c, 0, 0, xheight, 0)))
dataC := padY(p, padX(p, draw.Crop(c, ywidth, 0, xheight, 0)))
for _, data := range p.plotters {
data.Plot(dataC, p)
}
p.Legend.Draw(draw.Crop(c, ywidth, 0, xheight, 0))
}
// DataCanvas returns a new draw.Canvas that
// is the subset of the given draw area into which
// the plot data will be drawn.
func (p *Plot) DataCanvas(da draw.Canvas) draw.Canvas {
if p.Title.Text != "" {
da.Max.Y -= p.Title.Height(p.Title.Text) - p.Title.Font.Extents().Descent
da.Max.Y -= p.Title.Padding
}
p.X.sanitizeRange()
x := horizontalAxis{p.X}
p.Y.sanitizeRange()
y := verticalAxis{p.Y}
return padY(p, padX(p, draw.Crop(da, y.size(), 0, x.size(), 0)))
}
// DrawGlyphBoxes draws red outlines around the plot's
// GlyphBoxes. This is intended for debugging.
func (p *Plot) DrawGlyphBoxes(c *draw.Canvas) {
c.SetColor(color.RGBA{R: 255, A: 255})
for _, b := range p.GlyphBoxes(p) {
b.Rectangle.Min.X += c.X(b.X)
b.Rectangle.Min.Y += c.Y(b.Y)
c.Stroke(b.Rectangle.Path())
}
}
// padX returns a draw.Canvas that is padded horizontally
// so that glyphs will no be clipped.
func padX(p *Plot, c draw.Canvas) draw.Canvas {
glyphs := p.GlyphBoxes(p)
l := leftMost(&c, glyphs)
xAxis := horizontalAxis{p.X}
glyphs = append(glyphs, xAxis.GlyphBoxes(p)...)
r := rightMost(&c, glyphs)
minx := c.Min.X - l.Min.X
maxx := c.Max.X - (r.Min.X + r.Size().X)
lx := vg.Length(l.X)
rx := vg.Length(r.X)
n := (lx*maxx - rx*minx) / (lx - rx)
m := ((lx-1)*maxx - rx*minx + minx) / (lx - rx)
return draw.Canvas{
Canvas: vg.Canvas(c),
Rectangle: vg.Rectangle{
Min: vg.Point{X: n, Y: c.Min.Y},
Max: vg.Point{X: m, Y: c.Max.Y},
},
}
}
// rightMost returns the right-most GlyphBox.
func rightMost(c *draw.Canvas, boxes []GlyphBox) GlyphBox {
maxx := c.Max.X
r := GlyphBox{X: 1}
for _, b := range boxes {
if b.Size().X maxx && b.X 0 and the Y value is not in range of
// the Y axis then the box is ignored.
//
// Also, GlyphBoxes with Size.X