diff options
Diffstat (limited to 'sheetpr.go')
| -rw-r--r-- | sheetpr.go | 808 |
1 files changed, 205 insertions, 603 deletions
@@ -11,647 +11,249 @@ package excelize -import "strings" - -// SheetPrOption is an option of a view of a worksheet. See SetSheetPrOptions(). -type SheetPrOption interface { - setSheetPrOption(view *xlsxSheetPr) -} - -// SheetPrOptionPtr is a writable SheetPrOption. See GetSheetPrOptions(). -type SheetPrOptionPtr interface { - SheetPrOption - getSheetPrOption(view *xlsxSheetPr) -} - -type ( - // CodeName is an option used for SheetPrOption and WorkbookPrOption - CodeName string - // EnableFormatConditionsCalculation is a SheetPrOption - EnableFormatConditionsCalculation bool - // Published is a SheetPrOption - Published bool - // FitToPage is a SheetPrOption - FitToPage bool - // TabColorIndexed is a TabColor option, within SheetPrOption - TabColorIndexed int - // TabColorRGB is a TabColor option, within SheetPrOption - TabColorRGB string - // TabColorTheme is a TabColor option, within SheetPrOption - TabColorTheme int - // TabColorTint is a TabColor option, within SheetPrOption - TabColorTint float64 - // AutoPageBreaks is a SheetPrOption - AutoPageBreaks bool - // OutlineSummaryBelow is an outlinePr, within SheetPr option - OutlineSummaryBelow bool -) - -// setSheetPrOption implements the SheetPrOption interface. -func (o OutlineSummaryBelow) setSheetPrOption(pr *xlsxSheetPr) { - if pr.OutlinePr == nil { - pr.OutlinePr = new(xlsxOutlinePr) +// SetPageMargins provides a function to set worksheet page margins. +func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error { + ws, err := f.workSheetReader(sheet) + if err != nil { + return err } - pr.OutlinePr.SummaryBelow = bool(o) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface. -func (o *OutlineSummaryBelow) getSheetPrOption(pr *xlsxSheetPr) { - // Excel default: true - if pr == nil || pr.OutlinePr == nil { - *o = true - return - } - *o = OutlineSummaryBelow(defaultTrue(&pr.OutlinePr.SummaryBelow)) -} - -// setSheetPrOption implements the SheetPrOption interface and specifies a -// stable name of the sheet. -func (o CodeName) setSheetPrOption(pr *xlsxSheetPr) { - pr.CodeName = string(o) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface and get the -// stable name of the sheet. -func (o *CodeName) getSheetPrOption(pr *xlsxSheetPr) { - if pr == nil { - *o = "" - return - } - *o = CodeName(pr.CodeName) -} - -// setSheetPrOption implements the SheetPrOption interface and flag indicating -// whether the conditional formatting calculations shall be evaluated. -func (o EnableFormatConditionsCalculation) setSheetPrOption(pr *xlsxSheetPr) { - pr.EnableFormatConditionsCalculation = boolPtr(bool(o)) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface and get the -// settings of whether the conditional formatting calculations shall be -// evaluated. -func (o *EnableFormatConditionsCalculation) getSheetPrOption(pr *xlsxSheetPr) { - if pr == nil { - *o = true - return - } - *o = EnableFormatConditionsCalculation(defaultTrue(pr.EnableFormatConditionsCalculation)) -} - -// setSheetPrOption implements the SheetPrOption interface and flag indicating -// whether the worksheet is published. -func (o Published) setSheetPrOption(pr *xlsxSheetPr) { - pr.Published = boolPtr(bool(o)) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface and get the -// settings of whether the worksheet is published. -func (o *Published) getSheetPrOption(pr *xlsxSheetPr) { - if pr == nil { - *o = true - return - } - *o = Published(defaultTrue(pr.Published)) -} - -// setSheetPrOption implements the SheetPrOption interface. -func (o FitToPage) setSheetPrOption(pr *xlsxSheetPr) { - if pr.PageSetUpPr == nil { - if !o { - return - } - pr.PageSetUpPr = new(xlsxPageSetUpPr) + if opts == nil { + return err } - pr.PageSetUpPr.FitToPage = bool(o) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface. -func (o *FitToPage) getSheetPrOption(pr *xlsxSheetPr) { - // Excel default: false - if pr == nil || pr.PageSetUpPr == nil { - *o = false - return - } - *o = FitToPage(pr.PageSetUpPr.FitToPage) -} - -// setSheetPrOption implements the SheetPrOption interface and sets the -// TabColor Indexed. -func (o TabColorIndexed) setSheetPrOption(pr *xlsxSheetPr) { - if pr.TabColor == nil { - pr.TabColor = new(xlsxTabColor) + preparePageMargins := func(ws *xlsxWorksheet) { + if ws.PageMargins == nil { + ws.PageMargins = new(xlsxPageMargins) + } } - pr.TabColor.Indexed = int(o) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface and gets the -// TabColor Indexed. Defaults to -1 if no indexed has been set. -func (o *TabColorIndexed) getSheetPrOption(pr *xlsxSheetPr) { - if pr == nil || pr.TabColor == nil { - *o = TabColorIndexed(ColorMappingTypeUnset) - return - } - *o = TabColorIndexed(pr.TabColor.Indexed) -} - -// setSheetPrOption implements the SheetPrOption interface and specifies a -// stable name of the sheet. -func (o TabColorRGB) setSheetPrOption(pr *xlsxSheetPr) { - if pr.TabColor == nil { - if string(o) == "" { - return + preparePrintOptions := func(ws *xlsxWorksheet) { + if ws.PrintOptions == nil { + ws.PrintOptions = new(xlsxPrintOptions) } - pr.TabColor = new(xlsxTabColor) } - pr.TabColor.RGB = getPaletteColor(string(o)) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface and get the -// stable name of the sheet. -func (o *TabColorRGB) getSheetPrOption(pr *xlsxSheetPr) { - if pr == nil || pr.TabColor == nil { - *o = "" - return - } - *o = TabColorRGB(strings.TrimPrefix(pr.TabColor.RGB, "FF")) -} - -// setSheetPrOption implements the SheetPrOption interface and sets the -// TabColor Theme. Warning: it does not create a clrScheme! -func (o TabColorTheme) setSheetPrOption(pr *xlsxSheetPr) { - if pr.TabColor == nil { - pr.TabColor = new(xlsxTabColor) + if opts.Bottom != nil { + preparePageMargins(ws) + ws.PageMargins.Bottom = *opts.Bottom } - pr.TabColor.Theme = int(o) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface and gets the -// TabColor Theme. Defaults to -1 if no theme has been set. -func (o *TabColorTheme) getSheetPrOption(pr *xlsxSheetPr) { - if pr == nil || pr.TabColor == nil { - *o = TabColorTheme(ColorMappingTypeUnset) - return - } - *o = TabColorTheme(pr.TabColor.Theme) -} - -// setSheetPrOption implements the SheetPrOption interface and sets the -// TabColor Tint. -func (o TabColorTint) setSheetPrOption(pr *xlsxSheetPr) { - if pr.TabColor == nil { - pr.TabColor = new(xlsxTabColor) + if opts.Footer != nil { + preparePageMargins(ws) + ws.PageMargins.Footer = *opts.Footer } - pr.TabColor.Tint = float64(o) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface and gets the -// TabColor Tint. Defaults to 0.0 if no tint has been set. -func (o *TabColorTint) getSheetPrOption(pr *xlsxSheetPr) { - if pr == nil || pr.TabColor == nil { - *o = 0.0 - return - } - *o = TabColorTint(pr.TabColor.Tint) -} - -// setSheetPrOption implements the SheetPrOption interface. -func (o AutoPageBreaks) setSheetPrOption(pr *xlsxSheetPr) { - if pr.PageSetUpPr == nil { - if !o { - return - } - pr.PageSetUpPr = new(xlsxPageSetUpPr) + if opts.Header != nil { + preparePageMargins(ws) + ws.PageMargins.Header = *opts.Header } - pr.PageSetUpPr.AutoPageBreaks = bool(o) -} - -// getSheetPrOption implements the SheetPrOptionPtr interface. -func (o *AutoPageBreaks) getSheetPrOption(pr *xlsxSheetPr) { - // Excel default: false - if pr == nil || pr.PageSetUpPr == nil { - *o = false - return - } - *o = AutoPageBreaks(pr.PageSetUpPr.AutoPageBreaks) -} - -// SetSheetPrOptions provides a function to sets worksheet properties. -// -// Available options: -// -// CodeName(string) -// EnableFormatConditionsCalculation(bool) -// Published(bool) -// FitToPage(bool) -// TabColorIndexed(int) -// TabColorRGB(string) -// TabColorTheme(int) -// TabColorTint(float64) -// AutoPageBreaks(bool) -// OutlineSummaryBelow(bool) -func (f *File) SetSheetPrOptions(sheet string, opts ...SheetPrOption) error { - ws, err := f.workSheetReader(sheet) - if err != nil { - return err + if opts.Left != nil { + preparePageMargins(ws) + ws.PageMargins.Left = *opts.Left } - pr := ws.SheetPr - if pr == nil { - pr = new(xlsxSheetPr) - ws.SheetPr = pr + if opts.Right != nil { + preparePageMargins(ws) + ws.PageMargins.Right = *opts.Right } - - for _, opt := range opts { - opt.setSheetPrOption(pr) + if opts.Top != nil { + preparePageMargins(ws) + ws.PageMargins.Top = *opts.Top + } + if opts.Horizontally != nil { + preparePrintOptions(ws) + ws.PrintOptions.HorizontalCentered = *opts.Horizontally + } + if opts.Vertically != nil { + preparePrintOptions(ws) + ws.PrintOptions.VerticalCentered = *opts.Vertically } return err } -// GetSheetPrOptions provides a function to gets worksheet properties. -// -// Available options: -// -// CodeName(string) -// EnableFormatConditionsCalculation(bool) -// Published(bool) -// FitToPage(bool) -// TabColorIndexed(int) -// TabColorRGB(string) -// TabColorTheme(int) -// TabColorTint(float64) -// AutoPageBreaks(bool) -// OutlineSummaryBelow(bool) -func (f *File) GetSheetPrOptions(sheet string, opts ...SheetPrOptionPtr) error { +// GetPageMargins provides a function to get worksheet page margins. +func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error) { + opts := PageLayoutMarginsOptions{ + Bottom: float64Ptr(0.75), + Footer: float64Ptr(0.3), + Header: float64Ptr(0.3), + Left: float64Ptr(0.7), + Right: float64Ptr(0.7), + Top: float64Ptr(0.75), + } ws, err := f.workSheetReader(sheet) if err != nil { - return err + return opts, err } - pr := ws.SheetPr - - for _, opt := range opts { - opt.getSheetPrOption(pr) + if ws.PageMargins != nil { + if ws.PageMargins.Bottom != 0 { + opts.Bottom = float64Ptr(ws.PageMargins.Bottom) + } + if ws.PageMargins.Footer != 0 { + opts.Footer = float64Ptr(ws.PageMargins.Footer) + } + if ws.PageMargins.Header != 0 { + opts.Header = float64Ptr(ws.PageMargins.Header) + } + if ws.PageMargins.Left != 0 { + opts.Left = float64Ptr(ws.PageMargins.Left) + } + if ws.PageMargins.Right != 0 { + opts.Right = float64Ptr(ws.PageMargins.Right) + } + if ws.PageMargins.Top != 0 { + opts.Top = float64Ptr(ws.PageMargins.Top) + } } - return err -} - -type ( - // PageMarginBottom specifies the bottom margin for the page. - PageMarginBottom float64 - // PageMarginFooter specifies the footer margin for the page. - PageMarginFooter float64 - // PageMarginHeader specifies the header margin for the page. - PageMarginHeader float64 - // PageMarginLeft specifies the left margin for the page. - PageMarginLeft float64 - // PageMarginRight specifies the right margin for the page. - PageMarginRight float64 - // PageMarginTop specifies the top margin for the page. - PageMarginTop float64 -) - -// setPageMargins provides a method to set the bottom margin for the worksheet. -func (p PageMarginBottom) setPageMargins(pm *xlsxPageMargins) { - pm.Bottom = float64(p) -} - -// setPageMargins provides a method to get the bottom margin for the worksheet. -func (p *PageMarginBottom) getPageMargins(pm *xlsxPageMargins) { - // Excel default: 0.75 - if pm == nil || pm.Bottom == 0 { - *p = 0.75 - return - } - *p = PageMarginBottom(pm.Bottom) -} - -// setPageMargins provides a method to set the footer margin for the worksheet. -func (p PageMarginFooter) setPageMargins(pm *xlsxPageMargins) { - pm.Footer = float64(p) -} - -// setPageMargins provides a method to get the footer margin for the worksheet. -func (p *PageMarginFooter) getPageMargins(pm *xlsxPageMargins) { - // Excel default: 0.3 - if pm == nil || pm.Footer == 0 { - *p = 0.3 - return - } - *p = PageMarginFooter(pm.Footer) -} - -// setPageMargins provides a method to set the header margin for the worksheet. -func (p PageMarginHeader) setPageMargins(pm *xlsxPageMargins) { - pm.Header = float64(p) -} - -// setPageMargins provides a method to get the header margin for the worksheet. -func (p *PageMarginHeader) getPageMargins(pm *xlsxPageMargins) { - // Excel default: 0.3 - if pm == nil || pm.Header == 0 { - *p = 0.3 - return - } - *p = PageMarginHeader(pm.Header) -} - -// setPageMargins provides a method to set the left margin for the worksheet. -func (p PageMarginLeft) setPageMargins(pm *xlsxPageMargins) { - pm.Left = float64(p) -} - -// setPageMargins provides a method to get the left margin for the worksheet. -func (p *PageMarginLeft) getPageMargins(pm *xlsxPageMargins) { - // Excel default: 0.7 - if pm == nil || pm.Left == 0 { - *p = 0.7 - return - } - *p = PageMarginLeft(pm.Left) -} - -// setPageMargins provides a method to set the right margin for the worksheet. -func (p PageMarginRight) setPageMargins(pm *xlsxPageMargins) { - pm.Right = float64(p) -} - -// setPageMargins provides a method to get the right margin for the worksheet. -func (p *PageMarginRight) getPageMargins(pm *xlsxPageMargins) { - // Excel default: 0.7 - if pm == nil || pm.Right == 0 { - *p = 0.7 - return - } - *p = PageMarginRight(pm.Right) -} - -// setPageMargins provides a method to set the top margin for the worksheet. -func (p PageMarginTop) setPageMargins(pm *xlsxPageMargins) { - pm.Top = float64(p) -} - -// setPageMargins provides a method to get the top margin for the worksheet. -func (p *PageMarginTop) getPageMargins(pm *xlsxPageMargins) { - // Excel default: 0.75 - if pm == nil || pm.Top == 0 { - *p = 0.75 - return - } - *p = PageMarginTop(pm.Top) -} - -// PageMarginsOptions is an option of a page margin of a worksheet. See -// SetPageMargins(). -type PageMarginsOptions interface { - setPageMargins(layout *xlsxPageMargins) -} - -// PageMarginsOptionsPtr is a writable PageMarginsOptions. See -// GetPageMargins(). -type PageMarginsOptionsPtr interface { - PageMarginsOptions - getPageMargins(layout *xlsxPageMargins) + if ws.PrintOptions != nil { + opts.Horizontally = boolPtr(ws.PrintOptions.HorizontalCentered) + opts.Vertically = boolPtr(ws.PrintOptions.VerticalCentered) + } + return opts, err } -// SetPageMargins provides a function to set worksheet page margins. -// -// Available options: -// -// PageMarginBottom(float64) -// PageMarginFooter(float64) -// PageMarginHeader(float64) -// PageMarginLeft(float64) -// PageMarginRight(float64) -// PageMarginTop(float64) -func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error { - s, err := f.workSheetReader(sheet) - if err != nil { - return err +// setSheetProps set worksheet format properties by given options. +func (ws *xlsxWorksheet) setSheetProps(opts *SheetPropsOptions) { + prepareSheetPr := func(ws *xlsxWorksheet) { + if ws.SheetPr == nil { + ws.SheetPr = new(xlsxSheetPr) + } } - pm := s.PageMargins - if pm == nil { - pm = new(xlsxPageMargins) - s.PageMargins = pm + preparePageSetUpPr := func(ws *xlsxWorksheet) { + prepareSheetPr(ws) + if ws.SheetPr.PageSetUpPr == nil { + ws.SheetPr.PageSetUpPr = new(xlsxPageSetUpPr) + } } - - for _, opt := range opts { - opt.setPageMargins(pm) + prepareOutlinePr := func(ws *xlsxWorksheet) { + prepareSheetPr(ws) + if ws.SheetPr.OutlinePr == nil { + ws.SheetPr.OutlinePr = new(xlsxOutlinePr) + } } - return err -} - -// GetPageMargins provides a function to get worksheet page margins. -// -// Available options: -// -// PageMarginBottom(float64) -// PageMarginFooter(float64) -// PageMarginHeader(float64) -// PageMarginLeft(float64) -// PageMarginRight(float64) -// PageMarginTop(float64) -func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error { - s, err := f.workSheetReader(sheet) - if err != nil { - return err + prepareTabColor := func(ws *xlsxWorksheet) { + prepareSheetPr(ws) + if ws.SheetPr.TabColor == nil { + ws.SheetPr.TabColor = new(xlsxTabColor) + } } - pm := s.PageMargins - - for _, opt := range opts { - opt.getPageMargins(pm) + if opts.CodeName != nil { + prepareSheetPr(ws) + ws.SheetPr.CodeName = *opts.CodeName } - return err -} - -// SheetFormatPrOptions is an option of the formatting properties of a -// worksheet. See SetSheetFormatPr(). -type SheetFormatPrOptions interface { - setSheetFormatPr(formatPr *xlsxSheetFormatPr) -} - -// SheetFormatPrOptionsPtr is a writable SheetFormatPrOptions. See -// GetSheetFormatPr(). -type SheetFormatPrOptionsPtr interface { - SheetFormatPrOptions - getSheetFormatPr(formatPr *xlsxSheetFormatPr) -} - -type ( - // BaseColWidth specifies the number of characters of the maximum digit width - // of the normal style's font. This value does not include margin padding or - // extra padding for gridlines. It is only the number of characters. - BaseColWidth uint8 - // DefaultColWidth specifies the default column width measured as the number - // of characters of the maximum digit width of the normal style's font. - DefaultColWidth float64 - // DefaultRowHeight specifies the default row height measured in point size. - // Optimization so we don't have to write the height on all rows. This can be - // written out if most rows have custom height, to achieve the optimization. - DefaultRowHeight float64 - // CustomHeight specifies the custom height. - CustomHeight bool - // ZeroHeight specifies if rows are hidden. - ZeroHeight bool - // ThickTop specifies if rows have a thick top border by default. - ThickTop bool - // ThickBottom specifies if rows have a thick bottom border by default. - ThickBottom bool -) - -// setSheetFormatPr provides a method to set the number of characters of the -// maximum digit width of the normal style's font. -func (p BaseColWidth) setSheetFormatPr(fp *xlsxSheetFormatPr) { - fp.BaseColWidth = uint8(p) -} - -// setSheetFormatPr provides a method to set the number of characters of the -// maximum digit width of the normal style's font. -func (p *BaseColWidth) getSheetFormatPr(fp *xlsxSheetFormatPr) { - if fp == nil { - *p = 0 - return - } - *p = BaseColWidth(fp.BaseColWidth) -} - -// setSheetFormatPr provides a method to set the default column width measured -// as the number of characters of the maximum digit width of the normal -// style's font. -func (p DefaultColWidth) setSheetFormatPr(fp *xlsxSheetFormatPr) { - fp.DefaultColWidth = float64(p) -} - -// getSheetFormatPr provides a method to get the default column width measured -// as the number of characters of the maximum digit width of the normal -// style's font. -func (p *DefaultColWidth) getSheetFormatPr(fp *xlsxSheetFormatPr) { - if fp == nil { - *p = 0 - return - } - *p = DefaultColWidth(fp.DefaultColWidth) -} - -// setSheetFormatPr provides a method to set the default row height measured -// in point size. -func (p DefaultRowHeight) setSheetFormatPr(fp *xlsxSheetFormatPr) { - fp.DefaultRowHeight = float64(p) -} - -// getSheetFormatPr provides a method to get the default row height measured -// in point size. -func (p *DefaultRowHeight) getSheetFormatPr(fp *xlsxSheetFormatPr) { - if fp == nil { - *p = 15 - return - } - *p = DefaultRowHeight(fp.DefaultRowHeight) -} - -// setSheetFormatPr provides a method to set the custom height. -func (p CustomHeight) setSheetFormatPr(fp *xlsxSheetFormatPr) { - fp.CustomHeight = bool(p) -} - -// getSheetFormatPr provides a method to get the custom height. -func (p *CustomHeight) getSheetFormatPr(fp *xlsxSheetFormatPr) { - if fp == nil { - *p = false - return + if opts.EnableFormatConditionsCalculation != nil { + prepareSheetPr(ws) + ws.SheetPr.EnableFormatConditionsCalculation = opts.EnableFormatConditionsCalculation } - *p = CustomHeight(fp.CustomHeight) -} - -// setSheetFormatPr provides a method to set if rows are hidden. -func (p ZeroHeight) setSheetFormatPr(fp *xlsxSheetFormatPr) { - fp.ZeroHeight = bool(p) -} - -// getSheetFormatPr provides a method to get if rows are hidden. -func (p *ZeroHeight) getSheetFormatPr(fp *xlsxSheetFormatPr) { - if fp == nil { - *p = false - return + if opts.Published != nil { + prepareSheetPr(ws) + ws.SheetPr.Published = opts.Published + } + if opts.AutoPageBreaks != nil { + preparePageSetUpPr(ws) + ws.SheetPr.PageSetUpPr.AutoPageBreaks = *opts.AutoPageBreaks + } + if opts.FitToPage != nil { + preparePageSetUpPr(ws) + ws.SheetPr.PageSetUpPr.FitToPage = *opts.FitToPage + } + if opts.OutlineSummaryBelow != nil { + prepareOutlinePr(ws) + ws.SheetPr.OutlinePr.SummaryBelow = *opts.OutlineSummaryBelow + } + if opts.TabColorIndexed != nil { + prepareTabColor(ws) + ws.SheetPr.TabColor.Indexed = *opts.TabColorIndexed + } + if opts.TabColorRGB != nil { + prepareTabColor(ws) + ws.SheetPr.TabColor.RGB = *opts.TabColorRGB + } + if opts.TabColorTheme != nil { + prepareTabColor(ws) + ws.SheetPr.TabColor.Theme = *opts.TabColorTheme + } + if opts.TabColorTint != nil { + prepareTabColor(ws) + ws.SheetPr.TabColor.Tint = *opts.TabColorTint } - *p = ZeroHeight(fp.ZeroHeight) -} - -// setSheetFormatPr provides a method to set if rows have a thick top border -// by default. -func (p ThickTop) setSheetFormatPr(fp *xlsxSheetFormatPr) { - fp.ThickTop = bool(p) -} - -// getSheetFormatPr provides a method to get if rows have a thick top border -// by default. -func (p *ThickTop) getSheetFormatPr(fp *xlsxSheetFormatPr) { - if fp == nil { - *p = false - return - } - *p = ThickTop(fp.ThickTop) -} - -// setSheetFormatPr provides a method to set if rows have a thick bottom -// border by default. -func (p ThickBottom) setSheetFormatPr(fp *xlsxSheetFormatPr) { - fp.ThickBottom = bool(p) -} - -// setSheetFormatPr provides a method to set if rows have a thick bottom -// border by default. -func (p *ThickBottom) getSheetFormatPr(fp *xlsxSheetFormatPr) { - if fp == nil { - *p = false - return - } - *p = ThickBottom(fp.ThickBottom) } -// SetSheetFormatPr provides a function to set worksheet formatting properties. -// -// Available options: -// -// BaseColWidth(uint8) -// DefaultColWidth(float64) -// DefaultRowHeight(float64) -// CustomHeight(bool) -// ZeroHeight(bool) -// ThickTop(bool) -// ThickBottom(bool) -func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOptions) error { - s, err := f.workSheetReader(sheet) +// SetSheetProps provides a function to set worksheet properties. +func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error { + ws, err := f.workSheetReader(sheet) if err != nil { return err } - fp := s.SheetFormatPr - if fp == nil { - fp = new(xlsxSheetFormatPr) - s.SheetFormatPr = fp + if opts == nil { + return err + } + ws.setSheetProps(opts) + if ws.SheetFormatPr == nil { + ws.SheetFormatPr = &xlsxSheetFormatPr{DefaultRowHeight: defaultRowHeight} + } + if opts.BaseColWidth != nil { + ws.SheetFormatPr.BaseColWidth = *opts.BaseColWidth } - for _, opt := range opts { - opt.setSheetFormatPr(fp) + if opts.DefaultColWidth != nil { + ws.SheetFormatPr.DefaultColWidth = *opts.DefaultColWidth + } + if opts.DefaultRowHeight != nil { + ws.SheetFormatPr.DefaultRowHeight = *opts.DefaultRowHeight + } + if opts.CustomHeight != nil { + ws.SheetFormatPr.CustomHeight = *opts.CustomHeight + } + if opts.ZeroHeight != nil { + ws.SheetFormatPr.ZeroHeight = *opts.ZeroHeight + } + if opts.ThickTop != nil { + ws.SheetFormatPr.ThickTop = *opts.ThickTop + } + if opts.ThickBottom != nil { + ws.SheetFormatPr.ThickBottom = *opts.ThickBottom } return err } -// GetSheetFormatPr provides a function to get worksheet formatting properties. -// -// Available options: -// -// BaseColWidth(uint8) -// DefaultColWidth(float64) -// DefaultRowHeight(float64) -// CustomHeight(bool) -// ZeroHeight(bool) -// ThickTop(bool) -// ThickBottom(bool) -func (f *File) GetSheetFormatPr(sheet string, opts ...SheetFormatPrOptionsPtr) error { - s, err := f.workSheetReader(sheet) +// GetSheetProps provides a function to get worksheet properties. +func (f *File) GetSheetProps(sheet string) (SheetPropsOptions, error) { + baseColWidth := uint8(8) + opts := SheetPropsOptions{ + EnableFormatConditionsCalculation: boolPtr(true), + Published: boolPtr(true), + AutoPageBreaks: boolPtr(true), + OutlineSummaryBelow: boolPtr(true), + BaseColWidth: &baseColWidth, + } + ws, err := f.workSheetReader(sheet) if err != nil { - return err + return opts, err } - fp := s.SheetFormatPr - for _, opt := range opts { - opt.getSheetFormatPr(fp) + if ws.SheetPr != nil { + opts.CodeName = stringPtr(ws.SheetPr.CodeName) + if ws.SheetPr.EnableFormatConditionsCalculation != nil { + opts.EnableFormatConditionsCalculation = ws.SheetPr.EnableFormatConditionsCalculation + } + if ws.SheetPr.Published != nil { + opts.Published = ws.SheetPr.Published + } + if ws.SheetPr.PageSetUpPr != nil { + opts.AutoPageBreaks = boolPtr(ws.SheetPr.PageSetUpPr.AutoPageBreaks) + opts.FitToPage = boolPtr(ws.SheetPr.PageSetUpPr.FitToPage) + } + if ws.SheetPr.OutlinePr != nil { + opts.OutlineSummaryBelow = boolPtr(ws.SheetPr.OutlinePr.SummaryBelow) + } + if ws.SheetPr.TabColor != nil { + opts.TabColorIndexed = intPtr(ws.SheetPr.TabColor.Indexed) + opts.TabColorRGB = stringPtr(ws.SheetPr.TabColor.RGB) + opts.TabColorTheme = intPtr(ws.SheetPr.TabColor.Theme) + opts.TabColorTint = float64Ptr(ws.SheetPr.TabColor.Tint) + } } - return err + if ws.SheetFormatPr != nil { + opts.BaseColWidth = &ws.SheetFormatPr.BaseColWidth + opts.DefaultColWidth = float64Ptr(ws.SheetFormatPr.DefaultColWidth) + opts.DefaultRowHeight = float64Ptr(ws.SheetFormatPr.DefaultRowHeight) + opts.CustomHeight = boolPtr(ws.SheetFormatPr.CustomHeight) + opts.ZeroHeight = boolPtr(ws.SheetFormatPr.ZeroHeight) + opts.ThickTop = boolPtr(ws.SheetFormatPr.ThickTop) + opts.ThickBottom = boolPtr(ws.SheetFormatPr.ThickBottom) + } + return opts, err } |