Go Excelize API源码阅读GetPageLayout及SetPageMargins
作者：丘山子
一、Go-Excelize简介
Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库，基于 ECMA-376，ISO/IEC 29500 国际标准。
- 可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。
- 支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式，高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档，并提供流式读写 API，用于处理包含大规模数据的工作簿。
- 可应用于各类报表平台、云计算、边缘计算等系统。
使用本类库要求使用的 Go 语言为 1.15 或更高版本。
二、 GetPageLayout
func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error
根据给定的工作表名称和页面布局参数获取工作表的页面布局属性。
- 通过 PageLayoutOrientation 方法获取页面布局方向
- 通过 PageLayoutPaperSize 方法获取页面纸张大小 例如，获取名为 Sheet1 的工作表页面布局设置：
f := excelize.NewFile()
const sheet = "Sheet1"
var (
orientation excelize.PageLayoutOrientation
paperSize excelize.PageLayoutPaperSize
)
if err := f.GetPageLayout("Sheet1", &orientation); err != nil {
fmt.Println(err)
}
if err := f.GetPageLayout("Sheet1", &paperSize); err != nil {
fmt.Println(err)
}
fmt.Println("Defaults:")
fmt.Printf("- orientation: %q\n", orientation)
fmt.Printf("- paper size: %d\n", paperSize)
输出结果如下：
Defaults:
- orientation: "portrait"
- paper size: 1
废话少说，我们来看一看源码：
// GetPageLayout provides a function to gets worksheet page layout.
//
// Available options:
// PageLayoutOrientation(string)
// PageLayoutPaperSize(int)
// FitToHeight(int)
// FitToWidth(int)
func (f *File) GetPageLayout(sheet string, opts ...PageLayoutOptionPtr) error {
s, err := f.workSheetReader(sheet)
if err != nil {
return err
}
ps := s.PageSetUp
for _, opt := range opts {
opt.getPageLayout(ps)
}
return err
}
选项参数有4个，分别是PageLayoutOrientation(string)、PageLayoutPaperSize(int)、FitToHeight(int)、FitToWidth(int)。 源码逻辑很简单，读取工作表，然后获取工作表的PageSetUp字段，它是*xlsxPageSetUp类型的。
下图是xlsxPageSetUp类型的具体情况。可以看到它具有这么多结构体成员变量。
然后是遍历不定长变量opts，对于每个参数执行对应的操作。
....
如此，对每个参数都执行相应的方法之后，我们就将获取到的值存在了参数之中，因为从头到尾都是对参数的指针进行操作。
三、SetPageMargins
func (f *File) SetPageMargins(sheet string, opts ...PageMarginsOptions) error
根据给定的工作表名称和页边距参数设置工作表的页边距。页边距可选参数：
| 参数 | 数据类型 |
|---|---|
| PageMarginBotom | float64 |
| PageMarginFooter | float64 |
| PageMarginHeader | float64 |
| PageMarginLeft | float64 |
| PageMarginRight | float64 |
| PageMarginTop | float64 |
例如，设置名为 Sheet1 的工作表页边距:
f := excelize.NewFile()
const sheet = "Sheet1"
if err := f.SetPageMargins(sheet,
excelize.PageMarginBottom(1.0),
excelize.PageMarginFooter(1.0),
excelize.PageMarginHeader(1.0),
excelize.PageMarginLeft(1.0),
excelize.PageMarginRight(1.0),
excelize.PageMarginTop(1.0),
); err != nil {
fmt.Println(err)
}
该API源码如下：
// 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
}
pm := s.PageMargins
if pm == nil {
pm = new(xlsxPageMargins)
s.PageMargins = pm
}
for _, opt := range opts {
opt.setPageMargins(pm)
}
return err
}
先读取工作表，然后获取PageMargins字段。
如果这个字段为空，就新建一个xlsxPageMargins对象，给s.PageMargins。
for _, opt := range opts {
opt.setPageMargins(pm)
}
然后对根据opt的类型，对pm指针进行操作。
等等...
一如既往的这些操作...
以上就是Go Excelize API源码阅读GetPageLayout及SetPageMargins的详细内容，更多关于Go Excelize API源码阅读的资料请关注脚本之家其它相关文章！