More configuration function API updates

Changes included:
  * Removed `OutputFormatOptionFunc`, instead use `SVGOutputOptionFunc()` or `PNGOutputOptionFunc()`
  * Dimensions are now always set together, `WidthOptionFunc` and `HeightOptionFunc` are now set with `DimensionsOptionFunc`.  Similar `SetDefaultWidth` and `SetDefaultHeight` were replaced with `SetDefaultChartDimensions`.
  * `BoxOptionFunc` was removed, we don't currently have a clear example of where this is useful.

Author: jentfoo

chart_option.go

@@ -8,16 +8,16 @@ import (
 )
 
 type ChartOption struct {
-	// OutputFormat specifies the output type of chart, "svg" or "png", default value is "png"
+	// OutputFormat specifies the output type of chart, "svg" or "png", default value is "png".
 	OutputFormat string
 	// Width is the width of chart, default width is 600.
 	Width int
-	// Height is the height of chart, default height is 400
+	// Height is the height of chart, default height is 400.
 	Height int
 	// Theme specifies the colors used for the chart. Built in themes can be loaded using GetTheme with
 	// "light", "dark", "vivid-light", "vivid-dark", "ant" or "grafana".
 	Theme ColorPalette
-	// Padding specifies the padding for chart, default padding is [20, 10, 10, 10]
+	// Padding specifies the padding for chart, default padding is [20, 10, 10, 10].
 	Padding Box
 	// XAxis are options for the x-axis.
 	XAxis XAxisOption
@@ -33,7 +33,7 @@ type ChartOption struct {
 	Box Box
 	// SeriesList provides the data series.
 	SeriesList SeriesList
-	// RadarIndicators are radar indicator list for radar charts
+	// RadarIndicators are radar indicator list for radar charts.
 	RadarIndicators []RadarIndicator
 	// SymbolShow set this to *false or *true (using False() or True()) to force if the symbols should be shown or hidden.
 	SymbolShow *bool
@@ -57,18 +57,18 @@ type ChartOption struct {
 // OptionFunc option function
 type OptionFunc func(opt *ChartOption)
 
-// SVGOutputOption set svg type of chart's output.
-func SVGOutputOption() OptionFunc {
-	return OutputFormatOptionFunc(ChartOutputSVG)
+// SVGOutputOptionFunc set svg type of chart's output.
+func SVGOutputOptionFunc() OptionFunc {
+	return outputFormatOptionFunc(ChartOutputSVG)
 }
 
-// PNGOutputOption set png type of chart's output.
-func PNGOutputOption() OptionFunc {
-	return OutputFormatOptionFunc(ChartOutputPNG)
+// PNGOutputOptionFunc set png type of chart's output.
+func PNGOutputOptionFunc() OptionFunc {
+	return outputFormatOptionFunc(ChartOutputPNG)
 }
 
-// OutputFormatOptionFunc set type of chart's output.
-func OutputFormatOptionFunc(t string) OptionFunc {
+// outputFormatOptionFunc set type of chart's output.
+func outputFormatOptionFunc(t string) OptionFunc {
 	return func(opt *ChartOption) {
 		opt.OutputFormat = t
 	}
@@ -162,16 +162,10 @@ func YAxisDataOptionFunc(data []string) OptionFunc {
 	}
 }
 
-// WidthOptionFunc set width of chart
-func WidthOptionFunc(width int) OptionFunc {
+// DimensionsOptionFunc sets the width and height dimensions of the chart.
+func DimensionsOptionFunc(width, height int) OptionFunc {
 	return func(opt *ChartOption) {
 		opt.Width = width
-	}
-}
-
-// HeightOptionFunc set height of chart
-func HeightOptionFunc(height int) OptionFunc {
-	return func(opt *ChartOption) {
 		opt.Height = height
 	}
 }
@@ -183,13 +177,6 @@ func PaddingOptionFunc(padding Box) OptionFunc {
 	}
 }
 
-// BoxOptionFunc set box of chart
-func BoxOptionFunc(box Box) OptionFunc {
-	return func(opt *ChartOption) {
-		opt.Box = box
-	}
-}
-
 // PieSeriesShowLabel set pie series show label
 func PieSeriesShowLabel() OptionFunc {
 	return func(opt *ChartOption) {

chart_option_test.go

@@ -11,15 +11,14 @@ func TestChartOption(t *testing.T) {
 	t.Parallel()
 
 	fns := []OptionFunc{
-		SVGOutputOption(),
+		SVGOutputOptionFunc(),
 		FontOptionFunc(GetDefaultFont()),
 		ThemeNameOptionFunc(ThemeVividDark),
 		TitleTextOptionFunc("title"),
 		LegendLabelsOptionFunc([]string{"label"}),
 		XAxisDataOptionFunc([]string{"xaxis"}),
 		YAxisDataOptionFunc([]string{"yaxis"}),
-		WidthOptionFunc(800),
-		HeightOptionFunc(600),
+		DimensionsOptionFunc(800, 600),
 		PaddingOptionFunc(Box{
 			Left:   10,
 			Top:    10,
@@ -142,7 +141,7 @@ func TestLineRender(t *testing.T) {
 	}
 	p, err := LineRender(
 		values,
-		SVGOutputOption(),
+		SVGOutputOptionFunc(),
 		TitleTextOptionFunc("Line"),
 		XAxisDataOptionFunc([]string{
 			"Mon",
@@ -202,7 +201,7 @@ func TestBarRender(t *testing.T) {
 	}
 	p, err := BarRender(
 		values,
-		SVGOutputOption(),
+		SVGOutputOptionFunc(),
 		XAxisDataOptionFunc([]string{
 			"Jan",
 			"Feb",
@@ -265,7 +264,7 @@ func TestHorizontalBarRender(t *testing.T) {
 	}
 	p, err := HorizontalBarRender(
 		values,
-		SVGOutputOption(),
+		SVGOutputOptionFunc(),
 		TitleTextOptionFunc("World Population"),
 		PaddingOptionFunc(Box{
 			Top:    20,
@@ -304,7 +303,7 @@ func TestPieRender(t *testing.T) {
 	}
 	p, err := PieRender(
 		values,
-		SVGOutputOption(),
+		SVGOutputOptionFunc(),
 		TitleOptionFunc(TitleOption{
 			Text:    "Rainfall vs Evaporation",
 			Subtext: "Fake Data",
@@ -358,7 +357,7 @@ func TestRadarRender(t *testing.T) {
 	}
 	p, err := RadarRender(
 		values,
-		SVGOutputOption(),
+		SVGOutputOptionFunc(),
 		TitleTextOptionFunc("Basic Radar Chart"),
 		LegendLabelsOptionFunc([]string{
 			"Allocated Budget",
@@ -398,7 +397,7 @@ func TestFunnelRender(t *testing.T) {
 	}
 	p, err := FunnelRender(
 		values,
-		SVGOutputOption(),
+		SVGOutputOptionFunc(),
 		TitleTextOptionFunc("Funnel"),
 		LegendLabelsOptionFunc([]string{
 			"Show",

charts.go

@@ -18,15 +18,11 @@ const defaultYAxisLabelCountLow = 3
 var defaultChartWidth = 600
 var defaultChartHeight = 400
 
-// SetDefaultWidth sets default width of chart
-func SetDefaultWidth(width int) {
+// SetDefaultChartDimensions sets default width and height of charts if not otherwise specified in their configuration.
+func SetDefaultChartDimensions(width, height int) {
 	if width > 0 {
 		defaultChartWidth = width
 	}
-}
-
-// SetDefaultHeight sets default height of chart
-func SetDefaultHeight(height int) {
 	if height > 0 {
 		defaultChartHeight = height
 	}

examples/line_chart-2/main.go

@@ -36,8 +36,7 @@ func main() {
 	p, err := charts.LineRender(
 		values,
 		charts.ThemeNameOptionFunc(charts.ThemeVividLight), // custom color theme
-		charts.WidthOptionFunc(800),
-		charts.HeightOptionFunc(600),
+		charts.DimensionsOptionFunc(800, 600),
 		charts.TitleOptionFunc(charts.TitleOption{
 			Text:   "Line Chart Demo",
 			Offset: charts.OffsetCenter,

examples/table-1/main.go

@@ -25,7 +25,7 @@ func writeFile(buf []byte, filename string) error {
 }
 
 func main() {
-	charts.SetDefaultWidth(810)
+	charts.SetDefaultChartDimensions(810, 0) // 0 for height will leave it unchanged
 	header := []string{
 		"Name",
 		"Age",

examples/web-1/main.go

@@ -73,8 +73,7 @@ func handler(w http.ResponseWriter, req *http.Request, chartOptions []charts.Cha
 	theme := query.Get("theme")
 	width, _ := strconv.Atoi(query.Get("width"))
 	height, _ := strconv.Atoi(query.Get("height"))
-	charts.SetDefaultWidth(width)
-	charts.SetDefaultWidth(height)
+	charts.SetDefaultChartDimensions(width, height)
 	bytesList := make([][]byte, 0)
 	for _, opt := range chartOptions {
 		opt.Theme = charts.GetTheme(theme)