feature: refactor guides

Author: johnfercher

cmd/timeseries/main.go

@@ -18,9 +18,10 @@ func main() {
 	width := 30.0
 	step := 0.1
 	timeSeriesList := SinCos(width, step)
+	timeSeriesList = append(timeSeriesList, Log(width, step)...)
 	prop := props.Chart{
 		XLabels: []float64{0, 10, 20, 30},
-		YLabels: []float64{0, 1, 2},
+		YLabels: []float64{0, 1, 2, 3},
 		Font: props.Font{
 			Family: fontfamily.Arial,
 			Style:  fontstyle.Normal,
@@ -39,9 +40,6 @@ func main() {
 		row.New(100).Add(
 			chart.NewTimeSeriesCol(12, timeSeriesList, prop),
 		),
-		/*row.New(100).Add(
-			chart.NewTimeSeriesCol(12, pointsMatrix),
-		),*/
 	)
 
 	document, err := m.Generate()
@@ -58,17 +56,52 @@ func main() {
 func SinCos(width float64, step float64) []entity.TimeSeries {
 	timeSeries := []entity.TimeSeries{}
 
+	var maxSin entity.Point
 	sin := []entity.Point{}
 	for i := 0.0; i < width; i += step {
-		sin = append(sin, entity.NewPoint(i, math.Sin(i)+1))
+		y := math.Sin(i) + 1 + (i / 25)
+		point := entity.NewPoint(i, y)
+		if y > maxSin.Y {
+			maxSin = point
+		}
+		sin = append(sin, point)
 	}
-	timeSeries = append(timeSeries, entity.NewTimeSeries(props.RedColor, sin...))
+	timeSeries = append(timeSeries, entity.NewTimeSeries(props.RedColor, sin, entity.NewLabel("Max", maxSin)))
 
+	var maxCos entity.Point
 	cos := []entity.Point{}
 	for i := 0.0; i < width; i += step {
-		cos = append(cos, entity.NewPoint(i, math.Cos(i)+1))
+		y := math.Cos(i) + 1 + (i / 30)
+		point := entity.NewPoint(i, y)
+		if y > maxCos.Y {
+			maxCos = point
+		}
+		cos = append(cos, point)
 	}
-	timeSeries = append(timeSeries, entity.NewTimeSeries(props.BlueColor, cos...))
+	timeSeries = append(timeSeries, entity.NewTimeSeries(props.BlueColor, cos, entity.NewLabel("Max", maxCos)))
+
+	return timeSeries
+}
+
+func Log(width float64, step float64) []entity.TimeSeries {
+	timeSeries := []entity.TimeSeries{}
+
+	var logMax entity.Point
+	sin := []entity.Point{}
+	for i := 0.0; i < width; i += step {
+		v := math.Log(i)
+		point := entity.NewPoint(i, v)
+		if v > logMax.Y {
+			logMax = point
+		}
+		if v > 0 {
+			sin = append(sin, point)
+		}
+	}
+	timeSeries = append(timeSeries, entity.NewTimeSeries(props.Color{
+		Red:  150,
+		Blue: 150,
+	}, sin, entity.NewLabel("Max", logMax)))
 
 	return timeSeries
 }

docs/assets/pdf/timeseries.pdf

@@ -73,7 +73,7 @@ func (b *builder) Build(cfg *entity.Config, cache cache.Cache) *Dependencies {
 	line := NewLine(fpdf)
 	baseChart := chart.NewChart(fpdf, font)
 	heatMap := chart.NewHeatMap(fpdf, baseChart)
-	timeSeries := chart.NewTimeSeries(fpdf, baseChart)
+	timeSeries := chart.NewTimeSeries(fpdf, baseChart, font)
 	cellWriter := cellwriter.NewBuilder().
 		Build(fpdf)
 

internal/providers/gofpdf/builder.go

@@ -1,6 +1,7 @@
 package chart
 
 import (
+	"fmt"
 	"github.com/johnfercher/maroto/v2/pkg/consts/linestyle"
 	"github.com/johnfercher/maroto/v2/pkg/props"
 
@@ -14,13 +15,15 @@ type timeSeries struct {
 	defaultFillColor *props.Color
 	defaultDrawColor *props.Color
 	chart            core.Chart
+	font             core.Font
 	defaultLineWidth float64
 }
 
-func NewTimeSeries(pdf gofpdfwrapper.Fpdf, chart core.Chart) *timeSeries {
+func NewTimeSeries(pdf gofpdfwrapper.Fpdf, chart core.Chart, font core.Font) *timeSeries {
 	return &timeSeries{
 		pdf:              pdf,
 		chart:            chart,
+		font:             font,
 		defaultFillColor: &props.WhiteColor,
 		defaultDrawColor: &props.BlueColor,
 		defaultLineWidth: linestyle.DefaultLineThickness,
@@ -38,20 +41,37 @@ func (s timeSeries) Add(timeSeriesList []entity.TimeSeries, cell *entity.Cell, m
 
 	for _, timeSeries := range timeSeriesList {
 		s.pdf.SetDrawColor(timeSeries.Color.Red, timeSeries.Color.Green, timeSeries.Color.Blue)
-		for i := 0; i < len(timeSeries.Values)-1; i++ {
 
-			aX := timeSeries.Values[i].X*stepX + margins.Left + cell.X
+		for i := 0; i < len(timeSeries.Points)-1; i++ {
+			aX := timeSeries.Points[i].X*stepX + margins.Left + cell.X
 
-			aY := timeSeries.Values[i].Y * stepY
+			aY := timeSeries.Points[i].Y * stepY
 			aY = cell.Height + margins.Top + cell.Y - aY
 
-			bX := timeSeries.Values[i+1].X*stepX + margins.Left + cell.X
+			bX := timeSeries.Points[i+1].X*stepX + margins.Left + cell.X
 
-			bY := timeSeries.Values[i+1].Y * stepY
+			bY := timeSeries.Points[i+1].Y * stepY
 			bY = cell.Height + margins.Top + cell.Y - bY
 
 			s.pdf.Line(aX, aY, bX, bY)
 		}
+
+		for i := 0; i < len(timeSeries.Labels); i++ {
+			aX := timeSeries.Labels[i].Point.X*stepX + margins.Left + cell.X
+
+			aY := timeSeries.Labels[i].Point.Y * stepY
+			aY = cell.Height + margins.Top + cell.Y - aY
+
+			stringLabel := fmt.Sprintf("%s(%.2f)", timeSeries.Labels[i].Value, timeSeries.Labels[i].Point.Y)
+			stringWidth := s.pdf.GetStringWidth(stringLabel)
+
+			fontFamily, fontType, fontSize := s.font.GetFont()
+			stringHeight := s.font.GetHeight(fontFamily, fontType, fontSize)
+
+			s.pdf.Circle(aX, aY, 0.6, "D")
+			s.pdf.Text(aX-(stringWidth/2), aY-(stringHeight/1.5), stringLabel)
+		}
+
 		s.pdf.SetDrawColor(s.defaultDrawColor.Red, s.defaultDrawColor.Green, s.defaultDrawColor.Blue)
 	}
 
@@ -63,12 +83,12 @@ func (s timeSeries) getSizes(timeSeriesList []entity.TimeSeries) (float64, float
 	height := 0.0
 
 	for _, timeSeries := range timeSeriesList {
-		for i := 0; i < len(timeSeries.Values); i++ {
-			if timeSeries.Values[i].X > width {
-				width = timeSeries.Values[i].X
+		for i := 0; i < len(timeSeries.Points); i++ {
+			if timeSeries.Points[i].X > width {
+				width = timeSeries.Points[i].X
 			}
-			if timeSeries.Values[i].Y > height {
-				height = timeSeries.Values[i].Y
+			if timeSeries.Points[i].Y > height {
+				height = timeSeries.Points[i].Y
 			}
 		}
 	}

internal/providers/gofpdf/chart/timeseries.go

@@ -14,14 +14,28 @@ func NewPoint(x, y float64) Point {
 	}
 }
 
+type Label struct {
+	Value string
+	Point Point
+}
+
+func NewLabel(value string, point Point) Label {
+	return Label{
+		Value: value,
+		Point: point,
+	}
+}
+
 type TimeSeries struct {
-	Values []Point
+	Points []Point
+	Labels []Label
 	Color  props.Color
 }
 
-func NewTimeSeries(color props.Color, values ...Point) TimeSeries {
+func NewTimeSeries(color props.Color, points []Point, labels ...Label) TimeSeries {
 	return TimeSeries{
-		Values: values,
+		Points: points,
 		Color:  color,
+		Labels: labels,
 	}
 }