Go-Excelize API 源码阅读（十四）——GetSheetFormatPr

2022 年 8 月 19 日
湖南
本文字数：1838 字
阅读完需：约 6 分钟

Go-Excelize API 源码阅读（十四）——GetSheetFormatPr

一、Go-Excelize 简介

Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库，基于 ECMA-376，ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式，高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档，并提供流式读写 API，用于处理包含大规模数据的工作簿。可应用于各类报表平台、云计算、边缘计算等系统。使用本类库要求使用的 Go 语言为 1.15 或更高版本。

二、 GetSheetFormatPr

func (f *File) GetSheetFormatPr(sheet string, opts ...SheetFormatPrOptionsPtr) error

复制代码

根据给定的工作表名称获取格式属性。

使用示例：

f := excelize.NewFile()const sheet = "Sheet1"
var (    baseColWidth     excelize.BaseColWidth    defaultColWidth  excelize.DefaultColWidth    defaultRowHeight excelize.DefaultRowHeight    customHeight     excelize.CustomHeight    zeroHeight       excelize.ZeroHeight    thickTop         excelize.ThickTop    thickBottom      excelize.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)

复制代码

输出结果：

Defaults:- baseColWidth: 0- defaultColWidth: 0- defaultRowHeight: 15- customHeight: false- zeroHeight: false- thickTop: false- thickBottom: false

复制代码

废话少说，上代码：

func (f *File) GetSheetFormatPr(sheet string, opts ...SheetFormatPrOptionsPtr) error {  s, err := f.workSheetReader(sheet)  if err != nil {    return err  }  fp := s.SheetFormatPr  for _, opt := range opts {    opt.getSheetFormatPr(fp)  }  return err}

复制代码

代码很简单，先读取工作表，然后获取工作表的格式属性，然后遍历不定长参数 opts，对 fp 的每个 opt 进行读取。

SheetFormatPrOptionsPtr 是一个 interface。

type SheetFormatPrOptionsPtr interface {  SheetFormatPrOptions  getSheetFormatPr(formatPr *xlsxSheetFormatPr)}

复制代码

该 interface 内有两个函数。

我们可以发现，他们都大同小异，第一步的 if 语句是判断格式属性是否存在，如果不存在就赋一个默认值。然后取格式属性指针 fp 的格式属性，前面是类型转换：

type xlsxSheetFormatPr struct {  XMLName          xml.Name `xml:"sheetFormatPr"`  BaseColWidth     uint8    `xml:"baseColWidth,attr,omitempty"`  DefaultColWidth  float64  `xml:"defaultColWidth,attr,omitempty"`  DefaultRowHeight float64  `xml:"defaultRowHeight,attr"`  CustomHeight     bool     `xml:"customHeight,attr,omitempty"`  ZeroHeight       bool     `xml:"zeroHeight,attr,omitempty"`  ThickTop         bool     `xml:"thickTop,attr,omitempty"`  ThickBottom      bool     `xml:"thickBottom,attr,omitempty"`  OutlineLevelRow  uint8    `xml:"outlineLevelRow,attr,omitempty"`  OutlineLevelCol  uint8    `xml:"outlineLevelCol,attr,omitempty"`}

复制代码

下面介绍一下各个参数的作用：BaseColWidth：指定普通样式字体的最大数字宽度的字符数。此值不包括边距填充或网格线的额外填充。它只是字符数。DefaultColWidth 指定默认列宽，其度量值为普通样式字体的最大数字宽度的字符数。DefaultRowHeight 指定以磅值度量的默认行高，我们不必在所有行上写入高度。如果大多数行具有自定义高度，则可以将其写出，以实现优化。CustomHeight 指定自定义高度。ZeroHeight 指定是否隐藏行。ThickTop 指定默认情况下行是否具有粗上边框。ThickBottom 指定默认情况下行是否具有粗下边框。

三、结语

这里是老岳，这是 Go 语言相关源码的解读第十四篇，我会不断努力，给大家带来更多类似的文章，恳请大家不吝赐教。

发布于: 刚刚阅读数: 3

原文链接:【http://xie.infoq.cn/article/85c358e0357a9b13282f22660】。文章转载请联系作者。

Regan Yue

关注

还未添加个人签名 2020.08.12 加入

对Go、Python、网络安全、区块链感兴趣. · 华为云云享专家 · 掘金资讯创作者

发布

暂无评论

创作场景

Go-Excelize API 源码阅读（十四）——GetSheetFormatPr

Go-Excelize API 源码阅读（十四）——GetSheetFormatPr

一、Go-Excelize 简介

二、 GetSheetFormatPr

三、结语

Regan Yue

评论