go-charts/chart.go

// MIT License

// Copyright (c) 2022 Tree Xie

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

package charts

import (
	"errors"
	"math"

	"github.com/dustin/go-humanize"
	"github.com/wcharczuk/go-chart/v2"
	"github.com/wcharczuk/go-chart/v2/drawing"
)

const (
	ChartTypeLine = "line"
	ChartTypeBar  = "bar"
	ChartTypePie  = "pie"
)

type SeriesData struct {
	Value float64
	Style chart.Style
}
type Point struct {
	X int
	Y int
}

type Series struct {
	index      int
	Type       string
	Data       []SeriesData
	YAxisIndex int
	Style      chart.Style
}

type ChartOption struct {
	Theme           string
	Title           TitleOption
	Legend          LegendOption
	XAxis           XAxisOption
	YAxis           YAxisOption
	Width           int
	Height          int
	Parent          *Draw
	Padding         chart.Box
	SeriesList      []Series
	BackgroundColor drawing.Color
}

func (o *ChartOption) FillDefault(theme string) {
	t := NewTheme(theme)
	f, _ := chart.GetDefaultFont()
	if o.BackgroundColor.IsZero() {
		o.BackgroundColor = t.GetBackgroundColor()
	}
	if o.Title.Style.FontColor.IsZero() {
		o.Title.Style.FontColor = t.GetTextColor()
	}
	if o.Title.Style.FontSize == 0 {
		o.Title.Style.FontSize = 14
	}
	if o.Title.Style.Font == nil {
		o.Title.Style.Font = f
	}
	if o.Title.Style.Padding.IsZero() {
		o.Title.Style.Padding = chart.Box{
			Left:   5,
			Top:    5,
			Right:  5,
			Bottom: 5,
		}
	}
	o.Legend.Theme = t
	if o.Legend.Style.FontSize == 0 {
		o.Legend.Style.FontSize = 8
	}
	if o.Legend.Style.Font == nil {
		o.Legend.Style.Font = f
	}
	if o.Legend.Style.FontColor.IsZero() {
		o.Legend.Style.FontColor = t.GetTextColor()
	}
	if o.XAxis.Theme == "" {
		o.XAxis.Theme = theme
	}
}

func (o *ChartOption) getWidth() int {
	if o.Width == 0 {
		return 600
	}
	return o.Width
}

func (o *ChartOption) getHeight() int {
	if o.Height == 0 {
		return 400
	}
	return o.Height
}

func (o *ChartOption) getYRange(axisIndex int) Range {
	min := math.MaxFloat64
	max := -math.MaxFloat64

	for _, series := range o.SeriesList {
		if series.YAxisIndex != axisIndex {
			continue
		}
		for _, item := range series.Data {
			if item.Value > max {
				max = item.Value
			}
			if item.Value < min {
				min = item.Value
			}
		}
	}
	min = min * 0.9
	max = max * 1.1
	if o.YAxis.Min != nil {
		min = *o.YAxis.Min
	}
	if o.YAxis.Max != nil {
		max = *o.YAxis.Max
	}
	// y轴分设置默认划分为6块
	r := NewRange(min, max, 6)
	return r
}

func (r Range) Values() []string {
	offset := (r.Max - r.Min) / float64(r.divideCount)
	values := make([]string, 0)
	for i := 0; i <= r.divideCount; i++ {
		v := r.Min + float64(i)*offset
		value := humanize.CommafWithDigits(v, 2)
		values = append(values, value)
	}
	return values
}

type basicRenderResult struct {
	xRange   *Range
	yRange   *Range
	d        *Draw
	titleBox chart.Box
}

func ChartRender(opt ChartOption) (*Draw, error) {
	if len(opt.SeriesList) == 0 {
		return nil, errors.New("series can not be nil")
	}

	lineSeries := make([]Series, 0)
	barSeries := make([]Series, 0)
	isPieChart := false
	for index, item := range opt.SeriesList {
		item.index = index
		switch item.Type {
		case ChartTypePie:
			isPieChart = true
		case ChartTypeBar:
			barSeries = append(barSeries, item)
		default:
			lineSeries = append(lineSeries, item)
		}
	}
	// 如果指定了pie，则以pie的形式处理，不支持多类型图表
	// pie不需要axis
	if isPieChart {
		opt.XAxis.Hidden = true
		opt.YAxis.Hidden = true
	}
	result, err := chartBasicRender(&opt)
	if err != nil {
		return nil, err
	}
	if isPieChart {
		return pieChartRender(opt, result)
	}
	if len(barSeries) != 0 {
		o := opt
		o.SeriesList = barSeries
		_, err = barChartRender(o, result)
		if err != nil {
			return nil, err
		}
	}
	if len(lineSeries) != 0 {
		o := opt
		o.SeriesList = lineSeries
		_, err = lineChartRender(o, result)
		if err != nil {
			return nil, err
		}
	}
	return result.d, nil
}

func chartBasicRender(opt *ChartOption) (*basicRenderResult, error) {
	d, err := NewDraw(
		DrawOption{
			Parent: opt.Parent,
			Width:  opt.getWidth(),
			Height: opt.getHeight(),
		},
		PaddingOption(opt.Padding),
	)
	if err != nil {
		return nil, err
	}

	opt.FillDefault(opt.Theme)
	if opt.Parent == nil {
		d.setBackground(opt.getWidth(), opt.getHeight(), opt.BackgroundColor)
	}

	// 标题
	titleBox, err := drawTitle(d, &opt.Title)
	if err != nil {
		return nil, err
	}

	_, err = NewLegend(d, opt.Legend).Render()
	if err != nil {
		return nil, err
	}

	xAxisHeight := 0
	var xRange *Range

	if !opt.XAxis.Hidden {
		// xAxis
		xAxisHeight, xRange, err = drawXAxis(d, &opt.XAxis)
		if err != nil {
			return nil, err
		}
	}

	// 暂时仅支持单一yaxis
	var yRange *Range
	if !opt.YAxis.Hidden {
		yRange, err = drawYAxis(d, opt, xAxisHeight, chart.Box{
			Top: titleBox.Height(),
		})
		if err != nil {
			return nil, err
		}
	}
	return &basicRenderResult{
		xRange:   xRange,
		yRange:   yRange,
		d:        d,
		titleBox: titleBox,
	}, nil
}