This closes #1358, made a refactor with breaking changes, see details:
This made a refactor with breaking changes: Motivation and Context When I decided to add set horizontal centered support for this library to resolve #1358, the reason I made this huge breaking change was: - There are too many exported types for set sheet view, properties, and format properties, although a function using the functional options pattern can be optimized by returning an anonymous function, these types or property set or get function has no binding categorization, so I change these functions like `SetAppProps` to accept a pointer of options structure. - Users can not easily find out which properties should be in the `SetSheetPrOptions` or `SetSheetFormatPr` categories - Nested properties cannot proceed modify easily Introduce 5 new export data types: `HeaderFooterOptions`, `PageLayoutMarginsOptions`, `PageLayoutOptions`, `SheetPropsOptions`, and `ViewOptions` Rename 4 exported data types: - Rename `PivotTableOption` to `PivotTableOptions` - Rename `FormatHeaderFooter` to `HeaderFooterOptions` - Rename `FormatSheetProtection` to `SheetProtectionOptions` - Rename `SparklineOption` to `SparklineOptions` Remove 54 exported types: `AutoPageBreaks`, `BaseColWidth`, `BlackAndWhite`, `CodeName`, `CustomHeight`, `Date1904`, `DefaultColWidth`, `DefaultGridColor`, `DefaultRowHeight`, `EnableFormatConditionsCalculation`, `FilterPrivacy`, `FirstPageNumber`, `FitToHeight`, `FitToPage`, `FitToWidth`, `OutlineSummaryBelow`, `PageLayoutOption`, `PageLayoutOptionPtr`, `PageLayoutOrientation`, `PageLayoutPaperSize`, `PageLayoutScale`, `PageMarginBottom`, `PageMarginFooter`, `PageMarginHeader`, `PageMarginLeft`, `PageMarginRight`, `PageMarginsOptions`, `PageMarginsOptionsPtr`, `PageMarginTop`, `Published`, `RightToLeft`, `SheetFormatPrOptions`, `SheetFormatPrOptionsPtr`, `SheetPrOption`, `SheetPrOptionPtr`, `SheetViewOption`, `SheetViewOptionPtr`, `ShowFormulas`, `ShowGridLines`, `ShowRowColHeaders`, `ShowRuler`, `ShowZeros`, `TabColorIndexed`, `TabColorRGB`, `TabColorTheme`, `TabColorTint`, `ThickBottom`, `ThickTop`, `TopLeftCell`, `View`, `WorkbookPrOption`, `WorkbookPrOptionPtr`, `ZeroHeight` and `ZoomScale` Remove 2 exported constants: `OrientationPortrait` and `OrientationLandscape` Change 8 functions: - Change the `func (f *File) SetPageLayout(sheet string, opts ...PageLayoutOption) error` to `func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error` - Change the `func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error` to `func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)` - Change the `func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error` to `func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error` - Change the `func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error` to `func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)` - Change the `func (f *File) SetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOption) error` to `func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error` - Change the `func (f *File) GetSheetViewOptions(sheet string, viewIndex int, opts ...SheetViewOptionPtr) error` to `func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)` - Change the `func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error` to `func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error` - Change the `func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error` to `func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)` Introduce new function to instead of existing functions: - New function `func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error` instead of `func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error` and `func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOptionpull/2/head
xuri
2 years ago
parent
efcf599dfe
commit
53a495563a
@ -1,501 +1,107 @@
|
||||
package excelize
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/mohae/deepcopy"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
var _ = []SheetPrOption{
|
||||
CodeName("hello"),
|
||||
EnableFormatConditionsCalculation(false),
|
||||
Published(false),
|
||||
FitToPage(true),
|
||||
TabColorIndexed(42),
|
||||
TabColorRGB("#FFFF00"),
|
||||
TabColorTheme(ColorMappingTypeLight2),
|
||||
TabColorTint(0.5),
|
||||
AutoPageBreaks(true),
|
||||
OutlineSummaryBelow(true),
|
||||
}
|
||||
|
||||
var _ = []SheetPrOptionPtr{
|
||||
(*CodeName)(nil),
|
||||
(*EnableFormatConditionsCalculation)(nil),
|
||||
(*Published)(nil),
|
||||
(*FitToPage)(nil),
|
||||
(*TabColorIndexed)(nil),
|
||||
(*TabColorRGB)(nil),
|
||||
(*TabColorTheme)(nil),
|
||||
(*TabColorTint)(nil),
|
||||
(*AutoPageBreaks)(nil),
|
||||
(*OutlineSummaryBelow)(nil),
|
||||
}
|
||||
|
||||
func ExampleFile_SetSheetPrOptions() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
if err := f.SetSheetPrOptions(sheet,
|
||||
CodeName("code"),
|
||||
EnableFormatConditionsCalculation(false),
|
||||
Published(false),
|
||||
FitToPage(true),
|
||||
TabColorIndexed(42),
|
||||
TabColorRGB("#FFFF00"),
|
||||
TabColorTheme(ColorMappingTypeLight2),
|
||||
TabColorTint(0.5),
|
||||
AutoPageBreaks(true),
|
||||
OutlineSummaryBelow(false),
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
// Output:
|
||||
}
|
||||
|
||||
func ExampleFile_GetSheetPrOptions() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
var (
|
||||
codeName CodeName
|
||||
enableFormatConditionsCalculation EnableFormatConditionsCalculation
|
||||
published Published
|
||||
fitToPage FitToPage
|
||||
tabColorIndexed TabColorIndexed
|
||||
tabColorRGB TabColorRGB
|
||||
tabColorTheme TabColorTheme
|
||||
tabColorTint TabColorTint
|
||||
autoPageBreaks AutoPageBreaks
|
||||
outlineSummaryBelow OutlineSummaryBelow
|
||||
)
|
||||
|
||||
if err := f.GetSheetPrOptions(sheet,
|
||||
&codeName,
|
||||
&enableFormatConditionsCalculation,
|
||||
&published,
|
||||
&fitToPage,
|
||||
&tabColorIndexed,
|
||||
&tabColorRGB,
|
||||
&tabColorTheme,
|
||||
&tabColorTint,
|
||||
&autoPageBreaks,
|
||||
&outlineSummaryBelow,
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
fmt.Println("Defaults:")
|
||||
fmt.Printf("- codeName: %q\n", codeName)
|
||||
fmt.Println("- enableFormatConditionsCalculation:", enableFormatConditionsCalculation)
|
||||
fmt.Println("- published:", published)
|
||||
fmt.Println("- fitToPage:", fitToPage)
|
||||
fmt.Printf("- tabColorIndexed: %d\n", tabColorIndexed)
|
||||
fmt.Printf("- tabColorRGB: %q\n", tabColorRGB)
|
||||
fmt.Printf("- tabColorTheme: %d\n", tabColorTheme)
|
||||
fmt.Printf("- tabColorTint: %f\n", tabColorTint)
|
||||
fmt.Println("- autoPageBreaks:", autoPageBreaks)
|
||||
fmt.Println("- outlineSummaryBelow:", outlineSummaryBelow)
|
||||
// Output:
|
||||
// Defaults:
|
||||
// - codeName: ""
|
||||
// - enableFormatConditionsCalculation: true
|
||||
// - published: true
|
||||
// - fitToPage: false
|
||||
// - tabColorIndexed: -1
|
||||
// - tabColorRGB: ""
|
||||
// - tabColorTheme: -1
|
||||
// - tabColorTint: 0.000000
|
||||
// - autoPageBreaks: false
|
||||
// - outlineSummaryBelow: true
|
||||
}
|
||||
|
||||
func TestSheetPrOptions(t *testing.T) {
|
||||
const sheet = "Sheet1"
|
||||
|
||||
testData := []struct {
|
||||
container SheetPrOptionPtr
|
||||
nonDefault SheetPrOption
|
||||
}{
|
||||
{new(CodeName), CodeName("xx")},
|
||||
{new(EnableFormatConditionsCalculation), EnableFormatConditionsCalculation(false)},
|
||||
{new(Published), Published(false)},
|
||||
{new(FitToPage), FitToPage(true)},
|
||||
{new(TabColorIndexed), TabColorIndexed(42)},
|
||||
{new(TabColorRGB), TabColorRGB("FFFF00")},
|
||||
{new(TabColorTheme), TabColorTheme(ColorMappingTypeLight2)},
|
||||
{new(TabColorTint), TabColorTint(0.5)},
|
||||
{new(AutoPageBreaks), AutoPageBreaks(true)},
|
||||
{new(OutlineSummaryBelow), OutlineSummaryBelow(false)},
|
||||
}
|
||||
|
||||
for i, test := range testData {
|
||||
t.Run(fmt.Sprintf("TestData%d", i), func(t *testing.T) {
|
||||
opts := test.nonDefault
|
||||
t.Logf("option %T", opts)
|
||||
|
||||
def := deepcopy.Copy(test.container).(SheetPrOptionPtr)
|
||||
val1 := deepcopy.Copy(def).(SheetPrOptionPtr)
|
||||
val2 := deepcopy.Copy(def).(SheetPrOptionPtr)
|
||||
|
||||
f := NewFile()
|
||||
// Get the default value
|
||||
assert.NoError(t, f.GetSheetPrOptions(sheet, def), opts)
|
||||
// Get again and check
|
||||
assert.NoError(t, f.GetSheetPrOptions(sheet, val1), opts)
|
||||
if !assert.Equal(t, val1, def, opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Set the same value
|
||||
assert.NoError(t, f.SetSheetPrOptions(sheet, val1), opts)
|
||||
// Get again and check
|
||||
assert.NoError(t, f.GetSheetPrOptions(sheet, val1), opts)
|
||||
if !assert.Equal(t, val1, def, "%T: value should not have changed", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Set a different value
|
||||
assert.NoError(t, f.SetSheetPrOptions(sheet, test.nonDefault), opts)
|
||||
assert.NoError(t, f.GetSheetPrOptions(sheet, val1), opts)
|
||||
// Get again and compare
|
||||
assert.NoError(t, f.GetSheetPrOptions(sheet, val2), opts)
|
||||
if !assert.Equal(t, val1, val2, "%T: value should not have changed", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Value should not be the same as the default
|
||||
if !assert.NotEqual(t, def, val1, "%T: value should have changed from default", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Restore the default value
|
||||
assert.NoError(t, f.SetSheetPrOptions(sheet, def), opts)
|
||||
assert.NoError(t, f.GetSheetPrOptions(sheet, val1), opts)
|
||||
if !assert.Equal(t, def, val1) {
|
||||
t.FailNow()
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetSheetPrOptions(t *testing.T) {
|
||||
f := NewFile()
|
||||
assert.NoError(t, f.SetSheetPrOptions("Sheet1", TabColorRGB("")))
|
||||
// Test SetSheetPrOptions on not exists worksheet.
|
||||
assert.EqualError(t, f.SetSheetPrOptions("SheetN"), "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
func TestGetSheetPrOptions(t *testing.T) {
|
||||
f := NewFile()
|
||||
// Test GetSheetPrOptions on not exists worksheet.
|
||||
assert.EqualError(t, f.GetSheetPrOptions("SheetN"), "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
var _ = []PageMarginsOptions{
|
||||
PageMarginBottom(1.0),
|
||||
PageMarginFooter(1.0),
|
||||
PageMarginHeader(1.0),
|
||||
PageMarginLeft(1.0),
|
||||
PageMarginRight(1.0),
|
||||
PageMarginTop(1.0),
|
||||
}
|
||||
|
||||
var _ = []PageMarginsOptionsPtr{
|
||||
(*PageMarginBottom)(nil),
|
||||
(*PageMarginFooter)(nil),
|
||||
(*PageMarginHeader)(nil),
|
||||
(*PageMarginLeft)(nil),
|
||||
(*PageMarginRight)(nil),
|
||||
(*PageMarginTop)(nil),
|
||||
}
|
||||
|
||||
func ExampleFile_SetPageMargins() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
if err := f.SetPageMargins(sheet,
|
||||
PageMarginBottom(1.0),
|
||||
PageMarginFooter(1.0),
|
||||
PageMarginHeader(1.0),
|
||||
PageMarginLeft(1.0),
|
||||
PageMarginRight(1.0),
|
||||
PageMarginTop(1.0),
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
// Output:
|
||||
}
|
||||
|
||||
func ExampleFile_GetPageMargins() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
var (
|
||||
marginBottom PageMarginBottom
|
||||
marginFooter PageMarginFooter
|
||||
marginHeader PageMarginHeader
|
||||
marginLeft PageMarginLeft
|
||||
marginRight PageMarginRight
|
||||
marginTop PageMarginTop
|
||||
)
|
||||
|
||||
if err := f.GetPageMargins(sheet,
|
||||
&marginBottom,
|
||||
&marginFooter,
|
||||
&marginHeader,
|
||||
&marginLeft,
|
||||
&marginRight,
|
||||
&marginTop,
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
fmt.Println("Defaults:")
|
||||
fmt.Println("- marginBottom:", marginBottom)
|
||||
fmt.Println("- marginFooter:", marginFooter)
|
||||
fmt.Println("- marginHeader:", marginHeader)
|
||||
fmt.Println("- marginLeft:", marginLeft)
|
||||
fmt.Println("- marginRight:", marginRight)
|
||||
fmt.Println("- marginTop:", marginTop)
|
||||
// Output:
|
||||
// Defaults:
|
||||
// - marginBottom: 0.75
|
||||
// - marginFooter: 0.3
|
||||
// - marginHeader: 0.3
|
||||
// - marginLeft: 0.7
|
||||
// - marginRight: 0.7
|
||||
// - marginTop: 0.75
|
||||
}
|
||||
|
||||
func TestPageMarginsOption(t *testing.T) {
|
||||
const sheet = "Sheet1"
|
||||
|
||||
testData := []struct {
|
||||
container PageMarginsOptionsPtr
|
||||
nonDefault PageMarginsOptions
|
||||
}{
|
||||
{new(PageMarginTop), PageMarginTop(1.0)},
|
||||
{new(PageMarginBottom), PageMarginBottom(1.0)},
|
||||
{new(PageMarginLeft), PageMarginLeft(1.0)},
|
||||
{new(PageMarginRight), PageMarginRight(1.0)},
|
||||
{new(PageMarginHeader), PageMarginHeader(1.0)},
|
||||
{new(PageMarginFooter), PageMarginFooter(1.0)},
|
||||
}
|
||||
|
||||
for i, test := range testData {
|
||||
t.Run(fmt.Sprintf("TestData%d", i), func(t *testing.T) {
|
||||
opts := test.nonDefault
|
||||
t.Logf("option %T", opts)
|
||||
|
||||
def := deepcopy.Copy(test.container).(PageMarginsOptionsPtr)
|
||||
val1 := deepcopy.Copy(def).(PageMarginsOptionsPtr)
|
||||
val2 := deepcopy.Copy(def).(PageMarginsOptionsPtr)
|
||||
|
||||
f := NewFile()
|
||||
// Get the default value
|
||||
assert.NoError(t, f.GetPageMargins(sheet, def), opts)
|
||||
// Get again and check
|
||||
assert.NoError(t, f.GetPageMargins(sheet, val1), opts)
|
||||
if !assert.Equal(t, val1, def, opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Set the same value
|
||||
assert.NoError(t, f.SetPageMargins(sheet, val1), opts)
|
||||
// Get again and check
|
||||
assert.NoError(t, f.GetPageMargins(sheet, val1), opts)
|
||||
if !assert.Equal(t, val1, def, "%T: value should not have changed", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Set a different value
|
||||
assert.NoError(t, f.SetPageMargins(sheet, test.nonDefault), opts)
|
||||
assert.NoError(t, f.GetPageMargins(sheet, val1), opts)
|
||||
// Get again and compare
|
||||
assert.NoError(t, f.GetPageMargins(sheet, val2), opts)
|
||||
if !assert.Equal(t, val1, val2, "%T: value should not have changed", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Value should not be the same as the default
|
||||
if !assert.NotEqual(t, def, val1, "%T: value should have changed from default", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Restore the default value
|
||||
assert.NoError(t, f.SetPageMargins(sheet, def), opts)
|
||||
assert.NoError(t, f.GetPageMargins(sheet, val1), opts)
|
||||
if !assert.Equal(t, def, val1) {
|
||||
t.FailNow()
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetPageMargins(t *testing.T) {
|
||||
f := NewFile()
|
||||
assert.NoError(t, f.SetPageMargins("Sheet1", nil))
|
||||
ws, ok := f.Sheet.Load("xl/worksheets/sheet1.xml")
|
||||
assert.True(t, ok)
|
||||
ws.(*xlsxWorksheet).PageMargins = nil
|
||||
ws.(*xlsxWorksheet).PrintOptions = nil
|
||||
expected := PageLayoutMarginsOptions{
|
||||
Bottom: float64Ptr(1.0),
|
||||
Footer: float64Ptr(1.0),
|
||||
Header: float64Ptr(1.0),
|
||||
Left: float64Ptr(1.0),
|
||||
Right: float64Ptr(1.0),
|
||||
Top: float64Ptr(1.0),
|
||||
Horizontally: boolPtr(true),
|
||||
Vertically: boolPtr(true),
|
||||
}
|
||||
assert.NoError(t, f.SetPageMargins("Sheet1", &expected))
|
||||
opts, err := f.GetPageMargins("Sheet1")
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, expected, opts)
|
||||
// Test set page margins on not exists worksheet.
|
||||
assert.EqualError(t, f.SetPageMargins("SheetN"), "sheet SheetN does not exist")
|
||||
assert.EqualError(t, f.SetPageMargins("SheetN", nil), "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
func TestGetPageMargins(t *testing.T) {
|
||||
f := NewFile()
|
||||
// Test get page margins on not exists worksheet.
|
||||
assert.EqualError(t, f.GetPageMargins("SheetN"), "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
func ExampleFile_SetSheetFormatPr() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
if err := f.SetSheetFormatPr(sheet,
|
||||
BaseColWidth(1.0),
|
||||
DefaultColWidth(1.0),
|
||||
DefaultRowHeight(1.0),
|
||||
CustomHeight(true),
|
||||
ZeroHeight(true),
|
||||
ThickTop(true),
|
||||
ThickBottom(true),
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
_, err := f.GetPageMargins("SheetN")
|
||||
assert.EqualError(t, err, "sheet SheetN does not exist")
|
||||
}
|
||||
// Output:
|
||||
}
|
||||
|
||||
func ExampleFile_GetSheetFormatPr() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
var (
|
||||
baseColWidth BaseColWidth
|
||||
defaultColWidth DefaultColWidth
|
||||
defaultRowHeight DefaultRowHeight
|
||||
customHeight CustomHeight
|
||||
zeroHeight ZeroHeight
|
||||
thickTop ThickTop
|
||||
thickBottom ThickBottom
|
||||
)
|
||||
|
||||
if err := f.GetSheetFormatPr(sheet,
|
||||
&baseColWidth,
|
||||
&defaultColWidth,
|
||||
&defaultRowHeight,
|
||||
&customHeight,
|
||||
&zeroHeight,
|
||||
&thickTop,
|
||||
&thickBottom,
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
fmt.Println("Defaults:")
|
||||
fmt.Println("- baseColWidth:", baseColWidth)
|
||||
fmt.Println("- defaultColWidth:", defaultColWidth)
|
||||
fmt.Println("- defaultRowHeight:", defaultRowHeight)
|
||||
fmt.Println("- customHeight:", customHeight)
|
||||
fmt.Println("- zeroHeight:", zeroHeight)
|
||||
fmt.Println("- thickTop:", thickTop)
|
||||
fmt.Println("- thickBottom:", thickBottom)
|
||||
// Output:
|
||||
// Defaults:
|
||||
// - baseColWidth: 0
|
||||
// - defaultColWidth: 0
|
||||
// - defaultRowHeight: 15
|
||||
// - customHeight: false
|
||||
// - zeroHeight: false
|
||||
// - thickTop: false
|
||||
// - thickBottom: false
|
||||
}
|
||||
|
||||
func TestSheetFormatPrOptions(t *testing.T) {
|
||||
const sheet = "Sheet1"
|
||||
|
||||
testData := []struct {
|
||||
container SheetFormatPrOptionsPtr
|
||||
nonDefault SheetFormatPrOptions
|
||||
}{
|
||||
{new(BaseColWidth), BaseColWidth(1.0)},
|
||||
{new(DefaultColWidth), DefaultColWidth(1.0)},
|
||||
{new(DefaultRowHeight), DefaultRowHeight(1.0)},
|
||||
{new(CustomHeight), CustomHeight(true)},
|
||||
{new(ZeroHeight), ZeroHeight(true)},
|
||||
{new(ThickTop), ThickTop(true)},
|
||||
{new(ThickBottom), ThickBottom(true)},
|
||||
}
|
||||
|
||||
for i, test := range testData {
|
||||
t.Run(fmt.Sprintf("TestData%d", i), func(t *testing.T) {
|
||||
opts := test.nonDefault
|
||||
t.Logf("option %T", opts)
|
||||
|
||||
def := deepcopy.Copy(test.container).(SheetFormatPrOptionsPtr)
|
||||
val1 := deepcopy.Copy(def).(SheetFormatPrOptionsPtr)
|
||||
val2 := deepcopy.Copy(def).(SheetFormatPrOptionsPtr)
|
||||
|
||||
f := NewFile()
|
||||
// Get the default value
|
||||
assert.NoError(t, f.GetSheetFormatPr(sheet, def), opts)
|
||||
// Get again and check
|
||||
assert.NoError(t, f.GetSheetFormatPr(sheet, val1), opts)
|
||||
if !assert.Equal(t, val1, def, opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Set the same value
|
||||
assert.NoError(t, f.SetSheetFormatPr(sheet, val1), opts)
|
||||
// Get again and check
|
||||
assert.NoError(t, f.GetSheetFormatPr(sheet, val1), opts)
|
||||
if !assert.Equal(t, val1, def, "%T: value should not have changed", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Set a different value
|
||||
assert.NoError(t, f.SetSheetFormatPr(sheet, test.nonDefault), opts)
|
||||
assert.NoError(t, f.GetSheetFormatPr(sheet, val1), opts)
|
||||
// Get again and compare
|
||||
assert.NoError(t, f.GetSheetFormatPr(sheet, val2), opts)
|
||||
if !assert.Equal(t, val1, val2, "%T: value should not have changed", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Value should not be the same as the default
|
||||
if !assert.NotEqual(t, def, val1, "%T: value should have changed from default", opts) {
|
||||
t.FailNow()
|
||||
}
|
||||
// Restore the default value
|
||||
assert.NoError(t, f.SetSheetFormatPr(sheet, def), opts)
|
||||
assert.NoError(t, f.GetSheetFormatPr(sheet, val1), opts)
|
||||
if !assert.Equal(t, def, val1) {
|
||||
t.FailNow()
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSetSheetFormatPr(t *testing.T) {
|
||||
func TestDebug(t *testing.T) {
|
||||
f := NewFile()
|
||||
assert.NoError(t, f.GetSheetFormatPr("Sheet1"))
|
||||
assert.NoError(t, f.SetSheetProps("Sheet1", nil))
|
||||
ws, ok := f.Sheet.Load("xl/worksheets/sheet1.xml")
|
||||
assert.True(t, ok)
|
||||
ws.(*xlsxWorksheet).PageMargins = nil
|
||||
ws.(*xlsxWorksheet).PrintOptions = nil
|
||||
ws.(*xlsxWorksheet).SheetPr = nil
|
||||
ws.(*xlsxWorksheet).SheetFormatPr = nil
|
||||
assert.NoError(t, f.SetSheetFormatPr("Sheet1", BaseColWidth(1.0)))
|
||||
// Test set formatting properties on not exists worksheet.
|
||||
assert.EqualError(t, f.SetSheetFormatPr("SheetN"), "sheet SheetN does not exist")
|
||||
// w := uint8(10)
|
||||
// f.SetSheetProps("Sheet1", &SheetPropsOptions{BaseColWidth: &w})
|
||||
f.SetPageMargins("Sheet1", &PageLayoutMarginsOptions{Horizontally: boolPtr(true)})
|
||||
assert.NoError(t, f.SaveAs(filepath.Join("test", "TestDebug.xlsx")))
|
||||
}
|
||||
|
||||
func TestGetSheetFormatPr(t *testing.T) {
|
||||
func TestSetSheetProps(t *testing.T) {
|
||||
f := NewFile()
|
||||
assert.NoError(t, f.GetSheetFormatPr("Sheet1"))
|
||||
assert.NoError(t, f.SetSheetProps("Sheet1", nil))
|
||||
ws, ok := f.Sheet.Load("xl/worksheets/sheet1.xml")
|
||||
assert.True(t, ok)
|
||||
ws.(*xlsxWorksheet).SheetPr = nil
|
||||
ws.(*xlsxWorksheet).SheetFormatPr = nil
|
||||
var (
|
||||
baseColWidth BaseColWidth
|
||||
defaultColWidth DefaultColWidth
|
||||
defaultRowHeight DefaultRowHeight
|
||||
customHeight CustomHeight
|
||||
zeroHeight ZeroHeight
|
||||
thickTop ThickTop
|
||||
thickBottom ThickBottom
|
||||
)
|
||||
assert.NoError(t, f.GetSheetFormatPr("Sheet1",
|
||||
&baseColWidth,
|
||||
&defaultColWidth,
|
||||
&defaultRowHeight,
|
||||
&customHeight,
|
||||
&zeroHeight,
|
||||
&thickTop,
|
||||
&thickBottom,
|
||||
))
|
||||
// Test get formatting properties on not exists worksheet.
|
||||
assert.EqualError(t, f.GetSheetFormatPr("SheetN"), "sheet SheetN does not exist")
|
||||
baseColWidth := uint8(8)
|
||||
expected := SheetPropsOptions{
|
||||
CodeName: stringPtr("code"),
|
||||
EnableFormatConditionsCalculation: boolPtr(true),
|
||||
Published: boolPtr(true),
|
||||
AutoPageBreaks: boolPtr(true),
|
||||
FitToPage: boolPtr(true),
|
||||
TabColorIndexed: intPtr(1),
|
||||
TabColorRGB: stringPtr("#FFFF00"),
|
||||
TabColorTheme: intPtr(1),
|
||||
TabColorTint: float64Ptr(1),
|
||||
OutlineSummaryBelow: boolPtr(true),
|
||||
BaseColWidth: &baseColWidth,
|
||||
DefaultColWidth: float64Ptr(10),
|
||||
DefaultRowHeight: float64Ptr(10),
|
||||
CustomHeight: boolPtr(true),
|
||||
ZeroHeight: boolPtr(true),
|
||||
ThickTop: boolPtr(true),
|
||||
ThickBottom: boolPtr(true),
|
||||
}
|
||||
assert.NoError(t, f.SetSheetProps("Sheet1", &expected))
|
||||
opts, err := f.GetSheetProps("Sheet1")
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, expected, opts)
|
||||
|
||||
ws.(*xlsxWorksheet).SheetPr = nil
|
||||
assert.NoError(t, f.SetSheetProps("Sheet1", &SheetPropsOptions{FitToPage: boolPtr(true)}))
|
||||
ws.(*xlsxWorksheet).SheetPr = nil
|
||||
assert.NoError(t, f.SetSheetProps("Sheet1", &SheetPropsOptions{TabColorRGB: stringPtr("#FFFF00")}))
|
||||
ws.(*xlsxWorksheet).SheetPr = nil
|
||||
assert.NoError(t, f.SetSheetProps("Sheet1", &SheetPropsOptions{TabColorTheme: intPtr(1)}))
|
||||
ws.(*xlsxWorksheet).SheetPr = nil
|
||||
assert.NoError(t, f.SetSheetProps("Sheet1", &SheetPropsOptions{TabColorTint: float64Ptr(1)}))
|
||||
|
||||
// Test SetSheetProps on not exists worksheet.
|
||||
assert.EqualError(t, f.SetSheetProps("SheetN", nil), "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
func TestGetSheetProps(t *testing.T) {
|
||||
f := NewFile()
|
||||
// Test GetSheetProps on not exists worksheet.
|
||||
_, err := f.GetSheetProps("SheetN")
|
||||
assert.EqualError(t, err, "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
@ -1,218 +1,50 @@
|
||||
package excelize
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
var _ = []SheetViewOption{
|
||||
DefaultGridColor(true),
|
||||
ShowFormulas(false),
|
||||
ShowGridLines(true),
|
||||
ShowRowColHeaders(true),
|
||||
ShowZeros(true),
|
||||
RightToLeft(false),
|
||||
ShowRuler(false),
|
||||
View("pageLayout"),
|
||||
TopLeftCell("B2"),
|
||||
ZoomScale(100),
|
||||
// SheetViewOptionPtr are also SheetViewOption
|
||||
new(DefaultGridColor),
|
||||
new(ShowFormulas),
|
||||
new(ShowGridLines),
|
||||
new(ShowRowColHeaders),
|
||||
new(ShowZeros),
|
||||
new(RightToLeft),
|
||||
new(ShowRuler),
|
||||
new(View),
|
||||
new(TopLeftCell),
|
||||
new(ZoomScale),
|
||||
}
|
||||
|
||||
var _ = []SheetViewOptionPtr{
|
||||
(*DefaultGridColor)(nil),
|
||||
(*ShowFormulas)(nil),
|
||||
(*ShowGridLines)(nil),
|
||||
(*ShowRowColHeaders)(nil),
|
||||
(*ShowZeros)(nil),
|
||||
(*RightToLeft)(nil),
|
||||
(*ShowRuler)(nil),
|
||||
(*View)(nil),
|
||||
(*TopLeftCell)(nil),
|
||||
(*ZoomScale)(nil),
|
||||
}
|
||||
|
||||
func ExampleFile_SetSheetViewOptions() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
if err := f.SetSheetViewOptions(sheet, 0,
|
||||
DefaultGridColor(false),
|
||||
ShowFormulas(true),
|
||||
ShowGridLines(true),
|
||||
ShowRowColHeaders(true),
|
||||
RightToLeft(false),
|
||||
ShowRuler(false),
|
||||
View("pageLayout"),
|
||||
TopLeftCell("C3"),
|
||||
ZoomScale(80),
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
var zoomScale ZoomScale
|
||||
fmt.Println("Default:")
|
||||
fmt.Println("- zoomScale: 80")
|
||||
|
||||
if err := f.SetSheetViewOptions(sheet, 0, ZoomScale(500)); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.GetSheetViewOptions(sheet, 0, &zoomScale); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
fmt.Println("Used out of range value:")
|
||||
fmt.Println("- zoomScale:", zoomScale)
|
||||
|
||||
if err := f.SetSheetViewOptions(sheet, 0, ZoomScale(123)); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.GetSheetViewOptions(sheet, 0, &zoomScale); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
fmt.Println("Used correct value:")
|
||||
fmt.Println("- zoomScale:", zoomScale)
|
||||
|
||||
// Output:
|
||||
// Default:
|
||||
// - zoomScale: 80
|
||||
// Used out of range value:
|
||||
// - zoomScale: 80
|
||||
// Used correct value:
|
||||
// - zoomScale: 123
|
||||
}
|
||||
|
||||
func ExampleFile_GetSheetViewOptions() {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
var (
|
||||
defaultGridColor DefaultGridColor
|
||||
showFormulas ShowFormulas
|
||||
showGridLines ShowGridLines
|
||||
showRowColHeaders ShowRowColHeaders
|
||||
showZeros ShowZeros
|
||||
rightToLeft RightToLeft
|
||||
showRuler ShowRuler
|
||||
view View
|
||||
topLeftCell TopLeftCell
|
||||
zoomScale ZoomScale
|
||||
)
|
||||
|
||||
if err := f.GetSheetViewOptions(sheet, 0,
|
||||
&defaultGridColor,
|
||||
&showFormulas,
|
||||
&showGridLines,
|
||||
&showRowColHeaders,
|
||||
&showZeros,
|
||||
&rightToLeft,
|
||||
&showRuler,
|
||||
&view,
|
||||
&topLeftCell,
|
||||
&zoomScale,
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
fmt.Println("Default:")
|
||||
fmt.Println("- defaultGridColor:", defaultGridColor)
|
||||
fmt.Println("- showFormulas:", showFormulas)
|
||||
fmt.Println("- showGridLines:", showGridLines)
|
||||
fmt.Println("- showRowColHeaders:", showRowColHeaders)
|
||||
fmt.Println("- showZeros:", showZeros)
|
||||
fmt.Println("- rightToLeft:", rightToLeft)
|
||||
fmt.Println("- showRuler:", showRuler)
|
||||
fmt.Println("- view:", view)
|
||||
fmt.Println("- topLeftCell:", `"`+topLeftCell+`"`)
|
||||
fmt.Println("- zoomScale:", zoomScale)
|
||||
|
||||
if err := f.SetSheetViewOptions(sheet, 0, ShowGridLines(false)); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.GetSheetViewOptions(sheet, 0, &showGridLines); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.SetSheetViewOptions(sheet, 0, ShowZeros(false)); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.GetSheetViewOptions(sheet, 0, &showZeros); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.SetSheetViewOptions(sheet, 0, View("pageLayout")); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.GetSheetViewOptions(sheet, 0, &view); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.SetSheetViewOptions(sheet, 0, TopLeftCell("B2")); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
if err := f.GetSheetViewOptions(sheet, 0, &topLeftCell); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
|
||||
fmt.Println("After change:")
|
||||
fmt.Println("- showGridLines:", showGridLines)
|
||||
fmt.Println("- showZeros:", showZeros)
|
||||
fmt.Println("- view:", view)
|
||||
fmt.Println("- topLeftCell:", topLeftCell)
|
||||
|
||||
// Output:
|
||||
// Default:
|
||||
// - defaultGridColor: true
|
||||
// - showFormulas: false
|
||||
// - showGridLines: true
|
||||
// - showRowColHeaders: true
|
||||
// - showZeros: true
|
||||
// - rightToLeft: false
|
||||
// - showRuler: true
|
||||
// - view: normal
|
||||
// - topLeftCell: ""
|
||||
// - zoomScale: 0
|
||||
// After change:
|
||||
// - showGridLines: false
|
||||
// - showZeros: false
|
||||
// - view: pageLayout
|
||||
// - topLeftCell: B2
|
||||
}
|
||||
|
||||
func TestSheetViewOptionsErrors(t *testing.T) {
|
||||
func TestSetView(t *testing.T) {
|
||||
f := NewFile()
|
||||
const sheet = "Sheet1"
|
||||
|
||||
assert.NoError(t, f.GetSheetViewOptions(sheet, 0))
|
||||
assert.NoError(t, f.GetSheetViewOptions(sheet, -1))
|
||||
assert.Error(t, f.GetSheetViewOptions(sheet, 1))
|
||||
assert.Error(t, f.GetSheetViewOptions(sheet, -2))
|
||||
assert.NoError(t, f.SetSheetViewOptions(sheet, 0))
|
||||
assert.NoError(t, f.SetSheetViewOptions(sheet, -1))
|
||||
assert.Error(t, f.SetSheetViewOptions(sheet, 1))
|
||||
assert.Error(t, f.SetSheetViewOptions(sheet, -2))
|
||||
|
||||
assert.NoError(t, f.SetSheetView("Sheet1", -1, nil))
|
||||
ws, ok := f.Sheet.Load("xl/worksheets/sheet1.xml")
|
||||
assert.True(t, ok)
|
||||
ws.(*xlsxWorksheet).SheetViews = nil
|
||||
assert.NoError(t, f.GetSheetViewOptions(sheet, 0))
|
||||
expected := ViewOptions{
|
||||
DefaultGridColor: boolPtr(false),
|
||||
RightToLeft: boolPtr(false),
|
||||
ShowFormulas: boolPtr(false),
|
||||
ShowGridLines: boolPtr(false),
|
||||
ShowRowColHeaders: boolPtr(false),
|
||||
ShowRuler: boolPtr(false),
|
||||
ShowZeros: boolPtr(false),
|
||||
TopLeftCell: stringPtr("A1"),
|
||||
View: stringPtr("normal"),
|
||||
ZoomScale: float64Ptr(120),
|
||||
}
|
||||
assert.NoError(t, f.SetSheetView("Sheet1", 0, &expected))
|
||||
opts, err := f.GetSheetView("Sheet1", 0)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, expected, opts)
|
||||
// Test set sheet view options with invalid view index.
|
||||
assert.EqualError(t, f.SetSheetView("Sheet1", 1, nil), "view index 1 out of range")
|
||||
assert.EqualError(t, f.SetSheetView("Sheet1", -2, nil), "view index -2 out of range")
|
||||
// Test set sheet view options on not exists worksheet.
|
||||
assert.EqualError(t, f.SetSheetView("SheetN", 0, nil), "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
func TestGetView(t *testing.T) {
|
||||
f := NewFile()
|
||||
_, err := f.getSheetView("SheetN", 0)
|
||||
assert.EqualError(t, err, "sheet SheetN does not exist")
|
||||
// Test get sheet view options with invalid view index.
|
||||
_, err = f.GetSheetView("Sheet1", 1)
|
||||
assert.EqualError(t, err, "view index 1 out of range")
|
||||
_, err = f.GetSheetView("Sheet1", -2)
|
||||
assert.EqualError(t, err, "view index -2 out of range")
|
||||
// Test get sheet view options on not exists worksheet.
|
||||
_, err = f.GetSheetView("SheetN", 0)
|
||||
assert.EqualError(t, err, "sheet SheetN does not exist")
|
||||
}
|
||||
|
||||
@ -1,69 +1,23 @@
|
||||
package excelize
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func ExampleFile_SetWorkbookPrOptions() {
|
||||
f := NewFile()
|
||||
if err := f.SetWorkbookPrOptions(
|
||||
Date1904(false),
|
||||
FilterPrivacy(false),
|
||||
CodeName("code"),
|
||||
); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
// Output:
|
||||
}
|
||||
|
||||
func ExampleFile_GetWorkbookPrOptions() {
|
||||
f := NewFile()
|
||||
var (
|
||||
date1904 Date1904
|
||||
filterPrivacy FilterPrivacy
|
||||
codeName CodeName
|
||||
)
|
||||
if err := f.GetWorkbookPrOptions(&date1904); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
if err := f.GetWorkbookPrOptions(&filterPrivacy); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
if err := f.GetWorkbookPrOptions(&codeName); err != nil {
|
||||
fmt.Println(err)
|
||||
}
|
||||
fmt.Println("Defaults:")
|
||||
fmt.Printf("- date1904: %t\n", date1904)
|
||||
fmt.Printf("- filterPrivacy: %t\n", filterPrivacy)
|
||||
fmt.Printf("- codeName: %q\n", codeName)
|
||||
// Output:
|
||||
// Defaults:
|
||||
// - date1904: false
|
||||
// - filterPrivacy: true
|
||||
// - codeName: ""
|
||||
}
|
||||
|
||||
func TestWorkbookPr(t *testing.T) {
|
||||
func TestWorkbookProps(t *testing.T) {
|
||||
f := NewFile()
|
||||
assert.NoError(t, f.SetWorkbookProps(nil))
|
||||
wb := f.workbookReader()
|
||||
wb.WorkbookPr = nil
|
||||
var date1904 Date1904
|
||||
assert.NoError(t, f.GetWorkbookPrOptions(&date1904))
|
||||
assert.Equal(t, false, bool(date1904))
|
||||
|
||||
wb.WorkbookPr = nil
|
||||
var codeName CodeName
|
||||
assert.NoError(t, f.GetWorkbookPrOptions(&codeName))
|
||||
assert.Equal(t, "", string(codeName))
|
||||
assert.NoError(t, f.SetWorkbookPrOptions(CodeName("code")))
|
||||
assert.NoError(t, f.GetWorkbookPrOptions(&codeName))
|
||||
assert.Equal(t, "code", string(codeName))
|
||||
|
||||
wb.WorkbookPr = nil
|
||||
var filterPrivacy FilterPrivacy
|
||||
assert.NoError(t, f.GetWorkbookPrOptions(&filterPrivacy))
|
||||
assert.Equal(t, false, bool(filterPrivacy))
|
||||
expected := WorkbookPropsOptions{
|
||||
Date1904: boolPtr(true),
|
||||
FilterPrivacy: boolPtr(true),
|
||||
CodeName: stringPtr("code"),
|
||||
}
|
||||
assert.NoError(t, f.SetWorkbookProps(&expected))
|
||||
opts, err := f.GetWorkbookProps()
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, expected, opts)
|
||||
}
|
||||
|
||||
Loading…
Reference in new issue