This closes qax-os#2025, support set chart axis text direction and rotation

xuri · xuri · commit 5f446f25f0a0 · 2024-11-15T22:03:10.000+08:00
- Add new field Alignment in the ChartAxis data type
- Update unit tests
- Update doc of the AddHeaderFooterImage function
diff --git a/chart.go b/chart.go
@@ -850,6 +850,7 @@ func (opts *Chart) parseTitle() {
 //	ReverseOrder
 //	Maximum
 //	Minimum
+//	Alignment
 //	Font
 //	NumFmt
 //	Title
@@ -864,6 +865,7 @@ func (opts *Chart) parseTitle() {
 //	ReverseOrder
 //	Maximum
 //	Minimum
+//	Alignment
 //	Font
 //	LogBase
 //	NumFmt
@@ -896,6 +898,24 @@ func (opts *Chart) parseTitle() {
 // Minimum: Specifies that the fixed minimum, 0 is auto. The 'Minimum' property
 // is optional. The default value is auto.
 //
+// Alignment: Specifies that the alignment of the horizontal and vertical axis.
+// The properties of font that can be set are:
+//
+//	TextRotation
+//	Vertical
+//
+// The value of 'TextRotation' that can be set from -90 to 90:
+//
+// The value of 'Vertical' that can be set are:
+//
+//	horz
+//	vert
+//	vert270
+//	wordArtVert
+//	eaVert
+//	mongolianVert
+//	wordArtVertRtl
+//
 // Font: Specifies that the font of the horizontal and vertical axis. The
 // properties of font that can be set are:
 //
diff --git a/chart_test.go b/chart_test.go
@@ -216,9 +216,9 @@ func TestAddChart(t *testing.T) {
 	}{
 		{sheetName: "Sheet1", cell: "P1", opts: &Chart{Type: Col, Series: series, Format: format, Legend: ChartLegend{Position: "none", ShowLegendKey: true}, Title: []RichTextRun{{Text: "2D Column Chart"}}, PlotArea: plotArea, Border: ChartLine{Type: ChartLineNone}, ShowBlanksAs: "zero", XAxis: ChartAxis{Font: Font{Bold: true, Italic: true, Underline: "dbl", Family: "Times New Roman", Size: 15, Strike: true, Color: "000000"}, Title: []RichTextRun{{Text: "Primary Horizontal Axis Title"}}}, YAxis: ChartAxis{Font: Font{Bold: false, Italic: false, Underline: "sng", Color: "777777"}, Title: []RichTextRun{{Text: "Primary Vertical Axis Title", Font: &Font{Color: "777777", Bold: true, Italic: true, Size: 12}}}}}},
 		{sheetName: "Sheet1", cell: "X1", opts: &Chart{Type: ColStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "2D Stacked Column Chart"}}, PlotArea: plotArea, Fill: Fill{Type: "pattern", Pattern: 1}, Border: ChartLine{Type: ChartLineAutomatic}, ShowBlanksAs: "zero"}},
-		{sheetName: "Sheet1", cell: "P16", opts: &Chart{Type: ColPercentStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "100% Stacked Column Chart"}}, PlotArea: plotArea, Fill: Fill{Type: "pattern", Color: []string{"EEEEEE"}, Pattern: 1}, Border: ChartLine{Type: ChartLineSolid, Width: 2}, ShowBlanksAs: "zero"}},
+		{sheetName: "Sheet1", cell: "P16", opts: &Chart{Type: ColPercentStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "100% Stacked Column Chart"}}, PlotArea: plotArea, Fill: Fill{Type: "pattern", Color: []string{"EEEEEE"}, Pattern: 1}, Border: ChartLine{Type: ChartLineSolid, Width: 2}, ShowBlanksAs: "zero", XAxis: ChartAxis{Alignment: Alignment{Vertical: "wordArtVertRtl", TextRotation: 0}}}},
 		{sheetName: "Sheet1", cell: "X16", opts: &Chart{Type: Col3DClustered, Series: series, Format: format, Legend: ChartLegend{Position: "bottom", ShowLegendKey: false}, Title: []RichTextRun{{Text: "3D Clustered Column Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
-		{sheetName: "Sheet1", cell: "P30", opts: &Chart{Type: Col3DStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Stacked Column Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
+		{sheetName: "Sheet1", cell: "P30", opts: &Chart{Type: Col3DStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Stacked Column Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero", XAxis: ChartAxis{Alignment: Alignment{Vertical: "vert", TextRotation: 0}}}},
 		{sheetName: "Sheet1", cell: "X30", opts: &Chart{Type: Col3DPercentStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D 100% Stacked Column Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
 		{sheetName: "Sheet1", cell: "X45", opts: &Chart{Type: Radar, Series: series, Format: format, Legend: ChartLegend{Position: "top_right", ShowLegendKey: false}, Title: []RichTextRun{{Text: "Radar Chart"}}, PlotArea: plotArea, ShowBlanksAs: "span"}},
 		{sheetName: "Sheet1", cell: "AF1", opts: &Chart{Type: Col3DConeStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Column Cone Stacked Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
@@ -233,7 +233,7 @@ func TestAddChart(t *testing.T) {
 		{sheetName: "Sheet1", cell: "AV16", opts: &Chart{Type: Col3DCylinderClustered, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Column Cylinder Clustered Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
 		{sheetName: "Sheet1", cell: "AV30", opts: &Chart{Type: Col3DCylinderPercentStacked, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Column Cylinder Percent Stacked Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
 		{sheetName: "Sheet1", cell: "AV45", opts: &Chart{Type: Col3DCylinder, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Column Cylinder Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
-		{sheetName: "Sheet1", cell: "P45", opts: &Chart{Type: Col3D, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Column Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
+		{sheetName: "Sheet1", cell: "P45", opts: &Chart{Type: Col3D, Series: series, Format: format, Legend: legend, Title: []RichTextRun{{Text: "3D Column Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero", XAxis: ChartAxis{Alignment: Alignment{Vertical: "vert270", TextRotation: 0}}}},
 		{sheetName: "Sheet2", cell: "P1", opts: &Chart{Type: Line3D, Series: series2, Format: format, Legend: ChartLegend{Position: "top", ShowLegendKey: false}, Title: []RichTextRun{{Text: "3D Line Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero", XAxis: ChartAxis{MajorGridLines: true, MinorGridLines: true, TickLabelSkip: 1, NumFmt: ChartNumFmt{CustomNumFmt: "General"}}, YAxis: ChartAxis{MajorGridLines: true, MinorGridLines: true, MajorUnit: 1, NumFmt: ChartNumFmt{CustomNumFmt: "General"}}}},
 		{sheetName: "Sheet2", cell: "X1", opts: &Chart{Type: Scatter, Series: series, Format: format, Legend: ChartLegend{Position: "bottom", ShowLegendKey: false}, Title: []RichTextRun{{Text: "Scatter Chart"}}, PlotArea: plotArea, ShowBlanksAs: "zero"}},
 		{sheetName: "Sheet2", cell: "P16", opts: &Chart{Type: Doughnut, Series: series3, Format: format, Legend: ChartLegend{Position: "right", ShowLegendKey: false}, Title: []RichTextRun{{Text: "Doughnut Chart"}}, PlotArea: ChartPlotArea{ShowBubbleSize: false, ShowCatName: false, ShowLeaderLines: false, ShowPercent: true, ShowSerName: false, ShowVal: false}, ShowBlanksAs: "zero", HoleSize: 30}},
diff --git a/drawing.go b/drawing.go
@@ -1256,6 +1256,12 @@ func (f *File) drawPlotAreaTxPr(opts *ChartAxis) *cTxPr {
 	}
 	if opts != nil {
 		drawChartFont(&opts.Font, &cTxPr.P.PPr.DefRPr)
+		if -90 <= opts.Alignment.TextRotation && opts.Alignment.TextRotation <= 90 {
+			cTxPr.BodyPr.Rot = opts.Alignment.TextRotation * 60000
+		}
+		if idx := inStrSlice(supportedDrawingTextVerticalType, opts.Alignment.Vertical, true); idx != -1 {
+			cTxPr.BodyPr.Vert = supportedDrawingTextVerticalType[idx]
+		}
 	}
 	return cTxPr
 }
diff --git a/templates.go b/templates.go
@@ -495,6 +495,10 @@ var supportedDrawingUnderlineTypes = []string{
 	"wavyDbl",
 }
 
+// supportedDrawingTextVerticalType defined supported text vertical types in
+// drawing markup language.
+var supportedDrawingTextVerticalType = []string{"horz", "vert", "vert270", "wordArtVert", "eaVert", "mongolianVert", "wordArtVertRtl"}
+
 // supportedPositioning defined supported positioning types.
 var supportedPositioning = []string{"absolute", "oneCell", "twoCell"}
 
diff --git a/vml.go b/vml.go
@@ -1083,9 +1083,8 @@ func extractVMLFont(font []decodeVMLFont) []RichTextRun {
 }
 
 // AddHeaderFooterImage provides a mechanism to set the graphics that can be
-// referenced in the header and footer definitions via &G, file base name,
-// extension name and file bytes, supported image types: EMF, EMZ, GIF, JPEG,
-// JPG, PNG, SVG, TIF, TIFF, WMF, and WMZ.
+// referenced in the header and footer definitions via &G, supported image
+// types: EMF, EMZ, GIF, JPEG, JPG, PNG, SVG, TIF, TIFF, WMF, and WMZ.
 //
 // The extension should be provided with a "." in front, e.g. ".png".
 // The width and height should have units in them, e.g. "100pt".
diff --git a/xmlChart.go b/xmlChart.go
@@ -540,6 +540,7 @@ type ChartAxis struct {
 	Secondary         bool
 	Maximum           *float64
 	Minimum           *float64
+	Alignment         Alignment
 	Font              Font
 	LogBase           float64
 	NumFmt            ChartNumFmt

Original file line number	Diff line number	Diff line change
`@@ -1256,6 +1256,12 @@ func (f File) drawPlotAreaTxPr(opts ChartAxis) *cTxPr {`
`1256`	`1256`	`}`
`1257`	`1257`	`if opts != nil {`
`1258`	`1258`	`drawChartFont(&opts.Font, &cTxPr.P.PPr.DefRPr)`
	`1259`	`+ if -90 <= opts.Alignment.TextRotation && opts.Alignment.TextRotation <= 90 {`
	`1260`	`+ cTxPr.BodyPr.Rot = opts.Alignment.TextRotation * 60000`
	`1261`	`+ }`
	`1262`	`+ if idx := inStrSlice(supportedDrawingTextVerticalType, opts.Alignment.Vertical, true); idx != -1 {`
	`1263`	`+ cTxPr.BodyPr.Vert = supportedDrawingTextVerticalType[idx]`
	`1264`	`+ }`
`1259`	`1265`	`}`
`1260`	`1266`	`return cTxPr`
`1261`	`1267`	`}`
Original file line number	Diff line number	Diff line change
`@@ -495,6 +495,10 @@ var supportedDrawingUnderlineTypes = []string{`
`495`	`495`	`"wavyDbl",`
`496`	`496`	`}`
`497`	`497`
	`498`	`+// supportedDrawingTextVerticalType defined supported text vertical types in`
	`499`	`+// drawing markup language.`
	`500`	`+var supportedDrawingTextVerticalType = []string{"horz", "vert", "vert270", "wordArtVert", "eaVert", "mongolianVert", "wordArtVertRtl"}`
	`501`	`+`
`498`	`502`	`// supportedPositioning defined supported positioning types.`
`499`	`503`	`var supportedPositioning = []string{"absolute", "oneCell", "twoCell"}`
`500`	`504`