Go-Excelize API 源码阅读（十三）—— GetSheetVisible、SetSheetFormatPr

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

Go-Excelize API 源码阅读（十三）—— GetSheetVisible(sheet string)

一、Go-Excelize 简介

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

二、 GetSheetVisible(sheet string)

func (f *File) GetSheetVisible(sheet string) bool

复制代码

根据给定的工作表名称获取工作表可见性设置。例如，获取名为 Sheet1 的工作表可见性设置:

f.GetSheetVisible("Sheet1")

复制代码

不说废话，直接上源码：

func (f *File) GetSheetVisible(name string) bool {  content := f.workbookReader()  visible := false  for k, v := range content.Sheets.Sheet {    if v.Name == trimSheetName(name) {      if content.Sheets.Sheet[k].State == "" || content.Sheets.Sheet[k].State == "visible" {        visible = true      }    }  }  return visible}

复制代码

思路很简单，先读取工作簿，然后遍历工作簿的所有工作表，找到我们要查看的那张工作表。

然后如果工作表的状态值 State 是空字符串或者"visible"，就返回 true，否则返回 false。

// trimSheetName provides a function to trim invalid characters by given worksheet// name.func trimSheetName(name string) string {  if strings.ContainsAny(name, ":\\/?*[]") || utf8.RuneCountInString(name) > 31 {    r := make([]rune, 0, 31)    for _, v := range name {      switch v {      case 58, 92, 47, 63, 42, 91, 93: // replace :\/?*[]        continue      default:        r = append(r, v)      }      if len(r) == 31 {        break      }    }    name = string(r)  }  return name}

复制代码

这个函数的功能是给字符串去除非法字符，比如\/?*[]。这些字符不能用于文件名。

三、SetSheetFormatPr(sheet string, opts ...SheetFormatPrOptions)

func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOptions) error

复制代码

根据给定的工作表名称设置格式属性。

例如，设置名为 Sheet1 的工作表中行默认为隐藏：

f := excelize.NewFile()const sheet = "Sheet1"if err := f.SetSheetFormatPr("Sheet1", excelize.ZeroHeight(true)); err != nil {    fmt.Println(err)}if err := f.SetRowVisible("Sheet1", 10, true); err != nil {    fmt.Println(err)}f.SaveAs("Book1.xlsx")

复制代码

废话少说，直接上源码：

func (f *File) SetSheetFormatPr(sheet string, opts ...SheetFormatPrOptions) error {  s, err := f.workSheetReader(sheet)  if err != nil {    return err  }  fp := s.SheetFormatPr  if fp == nil {    fp = new(xlsxSheetFormatPr)    s.SheetFormatPr = fp  }  for _, opt := range opts {    opt.setSheetFormatPr(fp)  }  return err}

复制代码

这个 API 是读取工作表，获取工作表格式属性，如果工作表格式属性为空，就新建一个 xlsxSheetFormatPr 结构体，然后赋值给 s.SheetFormatPr。

然后再遍历可变长变量 opts，将存在的每个参数都执行一遍。

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

三、结语

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

发布于: 刚刚阅读数: 3

原文链接:【http://xie.infoq.cn/article/aee6a1160a8a1ff556377edc5】。

Regan Yue

关注

还未添加个人签名 2020.08.12 加入

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

发布

暂无评论

创作场景

Go-Excelize API 源码阅读（十三）—— GetSheetVisible、SetSheetFormatPr

Go-Excelize API 源码阅读（十三）—— GetSheetVisible(sheet string)

一、Go-Excelize 简介

二、 GetSheetVisible(sheet string)

三、SetSheetFormatPr(sheet string, opts ...SheetFormatPrOptions)

三、结语

Regan Yue

评论